• a5_email_addr_extract Function
• A5_EMAIL_FILTER_BUILDER Function
• a5_email_name_extract Function
• a5_email_ob_to_ib Function
• A5_EMAIL_PROFILES_ENUM Function
• A5_EMAIL_VALID Function
• a5_get_saved_email Function
• A5_IS_EMAIL_VALID Function
• A5_RUN_NETMAILER_JOB Function
• A5_RUN_SAVED_ZIP_JOB Function
• a5_savetowebappemailoutbox Function
• a5_showemailsettings Function
• EMAIL_CLIENT Function
• email_client_auto Function
• EMAIL_CLIENT_EXTERNAL Function
• EMAIL_GET_ACTIVE Function
• EMAIL_GET_FIELD Function
• EMAIL_POP_CLOSE Function
• EMAIL_POP_HEADERS Function
• EMAIL_POP_LIST Function
• EMAIL_POP_OPEN Function
• EMAIL_POP_RETR Function
• EMAIL_POP_RETR_UI Function
• email_profile_add Function
• email_profile_delete Function
• EMAIL_PROFILE_LOAD Function
• EMAIL_PROFILE_SAVE Function
• EMAIL_PROFILE_VALID Function
• EMAIL_READER_OPEN Function
• EMAIL_RECEIVE Function
• EMAIL_SAVE_ATTACH Function
• EMAIL_SELECT_PROFILE Function
• EMAIL_SEND Function
• EMAIL_SEND2 Function
• email_send_gmail Function
• Email_send_low Function
• email_send_mandrill Function
• email_send_noprofile Function
• email_send_sendgrid Function
• email_send_sparkpost Function
• email_send_web Function
• EMAIL_SET_ACTIVE Function
• EMAIL_SMTP_CLOSE Function
• EMAIL_SMTP_OPEN Function
• EMAIL_SMTP_SEND Function
• emailsendcdo Function
• SYS_RESOLVE_URL Function

EMAIL_POP_RETR Function

Syntax

Arguments

pResultPointer

A pointer variable that is populated by this function. Will contain the following:

pMessage Component

Description

.headers

Contains the headers for the entire message.

.message

contains the entire text of the message

.nBytes

contains the number of bytes that the server reported is in the message

.content_type

has the value of the "content-type:" field from the headers.

.parts

If the message has many parts (Content-Type: Multipart/Alternative or similar), there will be an array named parts in the pMessage structure. Each element of this array contains: headers, message, content_type, and perhaps another parts array. The parts array will usually be there if the message contains html or attachments, as is seen below.

pSocketPointer

A pointer variable that is populated by EMAIL_POP_OPEN().

nMessageNumeric

The message number that you want to retrieve from the server.

lDeleteLogical

Default = .F. .T. = The message will be deleted from the server after it is downloaded .F. = The message is not deleted.

nBlockSizeNumeric

Default = 64KB. The number of bytes that should be retrieved from the server at one time.

lStatusLogical

 

Returns

Result_FlagLogical

.T. = The message was successfully downloaded. .F. = The message was not downloaded.

Description

The EMAIL_POP_RETR() function retrieves a single message from a POP3 server. The connection must have been previously opened with EMAIL_POP_OPEN(). , i.e. the pSocket.s must be an open connection

Example

DIM pSocket as P
DIM pMessage as P
? email_pop_open(pSocket, "mail.mycompany.com",  "john_doe", "sneaky")
= .T.

? pSocket.nMessages
= 5

? email_pop_retr(pMessage, pSocket, 2)
= .T.

? properties_enum(pMessage)
= headers
message
nBytes
content_type
parts

Example 2

? pMessage.content_type
= "Multipart/Mixed"

? pMessage.parts1.content_type
= "Multipart/Alternative"

? pMessage.parts1.parts1.content_type
= "Text/Plain"

? pMessage.parts1.parts1.message
= "This is a plain text email"

? pMessage.parts1.parts2.content_type
= "Text/Html"

See Also

• Email Functions and Methods