EmailReadLastHeader (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

The email structure and the Email variables

See also

EmailReadLastHeader (Function)

In french: EmailLitEntêteDernier

Reads the header of last email received:

via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
via Pocket Outlook (user account other than the "ActiveSync" account): the email is placed in the in-box of Pocket Outlook.

The variables of email structure (or the properties of an 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.

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

Example that is using the Email structure

// Deletes the emails sent by "black-listed" senders

EmailStartPOP3Session("user", "secret", "pop.mycompany.fr")

// Browse the emails
// Read the header only
IF EmailReadLastHeader("user") THEN
LOOP
// Does the sender belong to
// a "black list"?
IF BlackListedSender(Email.SenderAddress) OR ...
BlackListedSender(Email.Sender) THEN
// If the email is "black-listed", delete it
// Then, the "authorized" emails can
// be entirely read later
EmailDeleteMessage("user")
END
DO WHILE EmailReadPreviousHeader("user")
END

Example that is using an Email variable

// Deletes the emails sent by "black-listed" senders

MySession is emailPOP3Session
MySession.ServerAddress = "pop.mycompany.us"
MySession.Name = "user"
MySession.Password = "secret"
EmailStartSession(MySession)

// Browse the emails
FOR EACH EmailMessage OF MySession
// Does the sender belong to
// a "black list"?
IF BlackListedSender(EmailMessage..SenderAddress) OR ...
BlackListedSender(EmailMessage..Sender) THEN
// If the email is "black-listed", delete it
// Then, the "authorized" emails can
// be entirely read later
EmailDeleteMessage(MySession, EmailMessage)
END
END

Syntax

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

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

<Result>: Boolean

True if the message header was read. In this case, the email structure is automatically updated.
False otherwise. To find out the error details, use ErrorInfo associated 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 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.
The emailPOP3Session and emailIMAPSession variables are not supported.

<Email>: Optional Email variable

Versions 15 and later
Name of the Email variable corresponding to the email that will be initialized with the message content.
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 corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
This parameter is not available
Name of the Email variable corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
This parameter is not available

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

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

<Result>: Boolean

True if the message header 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>: Integer

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