EmailReadFirstHeader (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Managing emails

The email structure and email variables
Outlook messaging

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailReadFirstHeader (Function)

In french: EmailLitEntêtePremier

Reads the header of the first email received:

POP3 or IMAP protocol: the e-mail is stored in the mailbox on the mail server.
or via Lotus Notes or Outlook e-mail software: the e-mail received is present on the local workstation in the Lotus Notes or Outlook inbox.

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

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 the EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession function..

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 more details on the error, use ErrorInfo with the errMessage constant.

<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.

<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.

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

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

<Result>: Boolean

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

<Session>: Integer

Identifier of the 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 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 variables offer 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: wd300com.dll