EmailReadMessage (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Number of messages found in the mailbox (POP3 protocol)

Number of messages found in the mailbox (Outlook messaging)

The attached files

Progress Bar

Outlook messaging

See also

EmailReadMessage (Function)

In french: EmailLitMessage

Reads an email received:

via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
via the Lotus Notes or Outlook messaging software: the incoming email is found on the local computer in the in-box of Lotus Notes or Outlook.

This function does not modify the current position.

The variables of the email structure (or Email variable) are filled.

The Email.Out variable is set to True if no email is found.

Reminder: Before reading an email, a session must be started by EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.

The POP3 protocol can only be used to read emails.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

// Use with the POP3 protocol
I is int
nbMSG is int = EmailNbMessage(UserName)
FOR I = 1 TO nbMSG
IF EmailReadMessage(UserName, I) = True THEN
IF Email.Out <> True THEN
CU.NAME = Email.Sender
CU.MESSAGE_TXT = Email.Message
...
ELSE
Info("This message was deleted")
END
END
END

// Use with the Outlook messaging software
// TABLE_EmailTable table contains all the incoming emails
// COL_Sender contains the sender name (Email.Sender variable)
// COL_Subject contains the email subject (Email.Sujet variable)
// COL_ID contains the email identifier (Email.ID variable)
// Read the selected email in the Table control
EmailReadMessage(SessionID, COL_ID)
// Retrieve the email content
Info("Message of the email: " + Email.Message)

Syntax

Reading an email managed by the POP3 or IMAP protocol Hide the details

<Result> = EmailReadMessage(<Session> [, <Email>] , <Message number>)

<Result>: Boolean

True if the message was read. In this case, the email structure is automatically updated.
False otherwise. To find out the name of the error, use the function ErrorInfo with the constant errMessage.
The Email.Out variable is positioned to True if no message was found (no email).

<Session>: Character string, or emailPOP3Session or emailIMAPSession variable

Identifies the user session. Corresponds to:
the user name that was used to start the email session (EmailStartSession).
Versions 15 and later
an emailPOP3Session variable.
New in version 15
an emailPOP3Session variable.
an emailPOP3Session variable.
Versions 15 and later
an emailIMAPSession variable.
New in version 15
an emailIMAPSession variable.
an emailIMAPSession variable.
Versions 15 and later
The emailPOP3Session and emailIMAPSession variables are not supported.
New in version 15
The emailPOP3Session and emailIMAPSession variables are not supported.
The emailPOP3Session and emailIMAPSession variables are not supported.

<Email>: Optional Email variable

Versions 15 and later
Name of the Email variable that will be initialized with the message content.
This parameter is not available
New in version 15
Name of the Email variable that will be initialized with the message content.
This parameter is not available
Name of the Email variable that will be initialized with the message content.
This parameter is not available
If this parameter is not specified, the Email structure is used.

<Message number>: Integer

Subscript of message to read in POP3
Identifier (UID) of the message in IMAP.

Reading an email managed via Pocket Outlook, Lotus Notes, Outlook Hide the details

<Result> = EmailReadMessage(<Session> [, <Email>] , <Message identifier>)

<Result>: Boolean

True if the message was read. In this case, the email structure is automatically updated.
False otherwise. To find out the wording of the error, use the function ErrorInfo with the constant errMessage.
The Email.Out variable is positioned to True if no message was found (no email).

<Session>: Integer, or emailOutlookSession or emailNotesSession variable

Identifier of current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession. In this case, the <Email> parameter must not be specified.
Versions 15 and later
a emailOutlookSession variable.
New in version 15
a emailOutlookSession variable.
a emailOutlookSession variable.
Versions 15 and later
an emailNotesSession variable.
New in version 15
an emailNotesSession variable.
an emailNotesSession variable.
Versions 15 and later
a emailIMAPSession variable.
New in version 15
a emailIMAPSession variable.
a emailIMAPSession variable.

<Email>: Optional Email variable

Versions 15 and later
Name of Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
New in version 15
Name of Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.

<Message identifier>: Character string (with quotes)

Identifier of the message to read. This identifier is found in the Email.ID variable when reading emails.

Remarks

Number of messages found in the mailbox (POP3 protocol)

The total number of incoming messages is returned by EmailNbMessage.

If, in the same email session, a message was deleted by EmailDeleteMessage:

EmailNbMessage returns the number of messages found on the email server before the deletion.
the numbers of the deleted messages are not re-assigned.

For example: During the connection, four messages are on found the server. These messages are numbered from 1 to 4. If the message #1 is deleted:

EmailNbMessage returns 4.
The message #1 cannot be read by EmailReadMessage: the message does not exist anymore. The Email.Out variable returns True. Only the messages 2, 3, and 4 exist.

The message numbers are re-assigned during the next connection.

Number of messages found in the mailbox (Outlook messaging)

The total number of incoming messages is returned by EmailNbMessage.

In the same email session, if a message was deleted by EmailDeleteMessage, EmailNbMessage returns the correct number of messages found in the incoming email folder.

The attached files

When reading a message, the files attached to this message can be copied onto the local disk (or onto the server disk) by EmailSaveAttachment.

Tip: We recommend that you save the messages and their attached files on the local disk (or on a server disk), then delete them from the email server. This operation is used to:

reduce the size of the mailbox on the server,
improve and speed up the communications on the POP3 servers: only the new messages will be read on the server.

Progress Bar

To follow the progress when receiving the email, use EmailProgressBar.

Outlook messaging

The WLanguage EmailReadxxx functions operate with the Outlook data file (.pst) only. The other data files are not supported.

Business / UI classification: Business Logic

Component: wd260com.dll