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, it is necessary to open a session with EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.

The POP3 protocol can only be used to read emails.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

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.

Versions 22 and later

This function is now available in Android widget mode.

This function is now available for Android applications.

New in version 22

This function is now available in Android widget mode.

This function is now available for Android applications.

This function is now available in Android widget mode.

This function is now available for Android applications.

Example

See additional examples

// Utilisation avec le protocole POP3
I is int
nbMSG is int = EmailNbMessage(NomUser)
FOR I = 1 TO nbMSG
IF EmailReadMessage(NomUser, I) = True THEN
IF Email.Out <> True THEN
CL.NOM = Email.Sender
CL.MESSAGE_TXT = Email.Message
...
ELSE
Info("Ce message a été supprimé")
END
END
END

// Utilisation avec le logiciel de messagerie Outlook
// TABLE_TableEmail contient l'ensemble des emails reçus
// COL_Exp contient le nom de l'expéditeur (variable Email.Expéditeur)
// COL_Sujet contient le sujet de l'email (variable Email.Sujet)
// COL_ID contient l'identifiant de l'email (variable Email.ID)
// Lecture de l'email sélectionné dans le champ Table
EmailReadMessage(IDSession, COL_ID)
// Récupération du contenu de l'email
Info("Message de l'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 get the details of the error, use ErrorInfo with the errMessage constant.
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 username that was used to start the email session (EmailStartSession).
Versions 15 and later
to an variable of type emailPOP3Session.
New in version 15
to an variable of type emailPOP3Session.
to an variable of type emailPOP3Session.
Versions 15 and later
to an variable of type emailIMAPSession.
New in version 15
to an variable of type emailIMAPSession.
to an variable of type emailIMAPSession.
Versions 15 and later
Variables of type emailPOP3Session and emailIMAPSession are not supported.
New in version 15
Variables of type emailPOP3Session and emailIMAPSession are not supported.
Variables of type emailPOP3Session and emailIMAPSession are not supported.

<Email>: Optional Email variable

Versions 15 and later
Name of the Email variable to be initialized with the message content.
This parameter is not available
New in version 15
Name of the Email variable to be initialized with the message content.
This parameter is not available
Name of the Email variable to 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 Lotus Notes or 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 get the details of the error, use ErrorInfo with the errMessage constant.
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 variable of type emailOutlookSession.
New in version 15
a variable of type emailOutlookSession.
a variable of type emailOutlookSession.
Versions 15 and later
a variable of type emailNotesSession.
New in version 15
a variable of type emailNotesSession.
a variable of type emailNotesSession.
Versions 15 and later
a variable of type emailIMAPSession.
New in version 15
a variable of type emailIMAPSession.
a variable of type emailIMAPSession.

<Email>: Optional Email variable

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

<Message identifier>: Character string

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 received messages is returned by EmailNbMessage.

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

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 message #1 is deleted:

EmailNbMessage returns 4.
get of message 1 with function EmailReadMessage is impossible: the message no longer exists. 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 received messages is returned by EmailNbMessage.

If a message was deleted by EmailDeleteMessage in the same email session, EmailNbMessage returns the actual number of messages in the inbox folder.

The attached files

When reading a message, the attached files can be copied to the local disk (or to the server disk) using 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 track the progress of 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: wd270com.dll