EmailReadFirstHeader (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

The email structure and the Email variables

See also

EmailReadFirstHeader (Function)

In french: EmailLitEntêtePremier

Reads the header of the first email received:

via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.

The different variables of email structure (or Email variable) corresponding to the message header are filled.

This function is useful when reading the email is linked to the message size for example.

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.

Example

// Read the first email
EmailReadFirstHeader(EmailID)
IF Email.Out = False THEN
// Displays the email in the "WIN_Email_RCV" window
Open(WIN_Email_RCV)
END

Syntax

Reading the header of the first email managed by the POP3 or IMAP protocol Hide the details

<Result> = EmailReadFirstHeader(<Session> [, <Email>])

<Result>: Boolean

True if the message header was read,
False otherwise. To get the details of the error, use ErrorInfo with the errMessage constant.

<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 must be initialized with the content of the message.
If this parameter is not specified, the Email structure is used.
This parameter is not available
New in version 15
Name of the Email variable that must be initialized with the content of the message.
If this parameter is not specified, the Email structure is used.
This parameter is not available
Name of the Email variable that must be initialized with the content of the message.
If this parameter is not specified, the Email structure is used.
This parameter is not available

Reading the header of first email managed via Pocket Outlook, Lotus Notes, Outlook Hide the details

<Result> = EmailReadFirstHeader(<Session> [, <Email> [, <Read mode>]])

<Result>: Boolean

True if the message header was read,
False otherwise. To find out the wording of the error, use the function ErrorInfo with the constant errMessage.

<Session>: Integer

Identifier of current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
Versions 15 and later
a emailOutlookSession variable.
New in version 15
a emailOutlookSession variable.
a emailOutlookSession variable.
Versions 15 and later
a emailNotesSession variable.
New in version 15
a emailNotesSession variable.
a 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 the 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 the Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of the Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.

<Read mode>: Optional constant or character string

Indicates the messages that will be read:
emailAll or "ALL"
(Default value) All the messages will be read.
emailUnread or "UNREAD" Only the unread messages will be read.

Remarks

The email structure and the Email variables

Two methods can be used to handle the emails:

The Email structure is a global structure used to easily handle a message.
The Email variablesoffer more advanced functionalities (data binding, serialization, multiple instances).

Component: wd260com.dll