EmailReadPreviousHeader (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / Managing emails

The email structure and the Email variables
Outlook messaging

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailReadPreviousHeader (Function)

In french: EmailLitEntêtePrécédent

Reads the header of the email found before the current email:

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.

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

The POP3 protocol can only be used to read emails.

Example

// Deletes the emails sent by "black-listed" senders
// Browse the emails
// Read the header only
// (to save bandwidth)
// If the email is "black-listed", delete it
// Then, the "authorized" emails can be read
// later on
IF EmailReadLastHeader(MyPOPSession) THEN
LOOP
// Is the sender "black listed"?
IF BlackListedSender(Email.SenderAddress) OR ...
BlackListedSender(Email.Sender) THEN
EmailDeleteMessage(MyPOPSession)
END
DO WHILE EmailReadPreviousHeader(MyPOPSession)
END

Syntax

Reading the header of the previous email managed via POP3 or IMAP Hide the details

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

<Result>: Boolean

True if the message header was read. In this case, the email structure is automatically updated.
False otherwise. To get more details on 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).
a variable of type emailPOP3Session.
a variable of type emailIMAPSession.
Variables of type emailPOP3Session and emailIMAPSession are not supported.

<Email>: Optional Email variable

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.

Reading the header of the previous email managed via Lotus Notes or Outlook Hide the details

<Result> = EmailReadPreviousHeader(<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 get more details on 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

Identifier of current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
a variable of type emailOutlookSession.
a variable of type emailNotesSession.
a variable of type emailIMAPSession.

<Email>: Optional Email variable

Name of the Email variable to 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 emails:

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

Outlook messaging

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

Component: wd280com.dll