Xbasic

EMAIL_POP_RETR_UI Function

Syntax

Message_Count as N = email_pop_retr_ui([C profile [,C inbox [,L lDisplay [,L lUI [,C filter [,L lStatusWindow [,L lStatusBar [,C parent_dlg_title [,L lSilent ]]]]]]]]])

Arguments

profileCharacter

Default = active email profile (can be retrieved using EMAIL_GET_ACTIVE()). The name of the email profile to use.

inboxCharacter

Can be used to override the inbox specified in the Profile above.

lDisplayLogical

Default = .T. .T. = displays the Email Reader after downloading mail, .F. = does not display Email Reader.

lUILogical

Default = .T. .T. = displays a dialog allowing the user to download selected mail, delete messages, filter, etc. .F. = does not display dialog.

filterCharacter

Default = "" (all messages). An email filter that can be built with A5_EMAIL_FILTER_BUILDER(). Allows you to download only messages matching certain criteria.

lStatusWindowLogical

Default = .T. .T. = displays a window with the current download progress, .F. = does not display progress

lStatusBarLogical

Default = .F. .T. = displays current progress on the Status Bar. .F. = does not display progress

parent_dlg_titleCharacter

Internal use only

lSilentLogical

Default = .F. .T. = suppresses all errors, .F. = displays all errors.

Returns

Message_CountNumeric

The number of messages on the email server that match you filter.

Description

The EMAIL_POP_RETR_UI() function displays the Download Email dialog box and returns a count of messages on your email server that match your filter specifications.

Example

? email_pop_retr_ui()
= 1

Limitations

Desktop applications only.

See Also