EmailReadMessageHeader (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

EmailReadMessageHeader

Presentation

Example

Number of messages found in the mailbox (POP3 protocol)

See also

EmailReadMessageHeader (Function)

In french: EmailLitEntêteMessage

Reads the header of an 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 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 one of the following functions: EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.

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

// Use the POP3 protocol
// Read the emails whose size does not exceed MaxEmailSize
I is int
FOR I = 1 TO EmailNbMessage(UserName)
IF EmailMessageLength(UserName, I) < MaxEmailSize THEN
// Procedure for reading and processing the message
ReadMessage()
ELSE
EmailReadMessageHeader(UserName, I)
// Response procedure indicating that the email was not read
ReturnMessage(Email.SenderAddress)
END
END

Syntax

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

<Result> = EmailReadMessageHeader(<Session> [, <Email>] , <Message number>)

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

<Email>: Optional Email variable

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

<Message number>: Integer

Number of the message whose header will be read.

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

<Result> = EmailReadMessageHeader(<Session> [, <Email>] , <Message identifier>)

<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>: 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
an emailNotesSession variable.
New in version 15
an emailNotesSession variable.
an emailNotesSession variable.
Versions 15 and later
an emailIMAPSession variable.
New in version 15
an emailIMAPSession variable.
an emailIMAPSession variable.

<Email>: Optional Email variable

Versions 15 and later
Name of 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 Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of Email variable that will 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 whose header must be 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 incoming messages is returned by EmailNbMessage.

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

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 found on the server and these messages are numbered 1 to 4. If the message #1 is deleted:

EmailNbMessage returns 4.
The message #1 cannot be read by EmailReadMessage or EmailReadMessageHeader: the message does not exist anymore. The Email.Out variable returns True. Only the messages 2, 3, and 4 exist.

The message numbers are re-assigned during the next connection.

Component : wd250com.dll