• 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_OPEN Function

Syntax

Arguments

pSocketPointer

A pointer variable that is populated by this function with the following child variables:

bufferCharacter

The text of the last communication with the mail server. It is mostly used if an error occurs. If there is an error, buffer will contain the text of the error.

nMessagesNumeric

The number of messages stored on the server

nTotalBytesNumeric

The total number of bytes stored in messages on the server.

sPointer

An open socket to the server.

pop_serverCharacter

The hostname of the POP3 server.

usernameCharacter

The user's logon.

passwordCharacter

The user's password.

portNumeric

Default = 110. The TCP port used for the connection.

modeCharacter

Default = "". The mode used for the connection, e.g. "SSL".

Returns

Result_FlagLogical

.T. = Login was successful, .F. = Login was not successful. If the login fails, pSocket.buffer will contain an error message with more information.

Description

The EMAIL_POP_OPEN() function opens a connection to a POP3 server and logs in.

Example 1

The following example shows a successful logon to mail.mycompany.com. pSocket is a dot variable with four child variables: buffer, nMessages, nTotalBytes, and s. Buffer contains the text of the last communication with the mail server (in this case, "+OK 5 7091429") and is mostly used if an error occurs. If there is an error, buffer will contain the text of the error (as in the next example). nMessages is the number of messages stored on the server. nTotalBytes is the total number of bytes stored in messages on the server. S is an open socket to the server. It is created with SOCKETS.OPEN().

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

? pSocket
= buffer = +OK 5 7091429
nMessages = 5.000000
nTotalBytes = 7091429.000000
+s.

Example 2

Example 2 shows an error condition. EMAIL_POP_OPEN() returns .F. and pSocket.buffer contains an error message.

? email_pop_open(pSocket, "mail.mycompany.com",  "john_doe", "sneaky")
= .F.

? pSocket
= buffer = -ERR User testmailer already logged on.
nMessages = 0.000000
nTotalBytes = 0.000000
+s.

See Also

• Email Functions and Methods