EmailReadMessageHeader (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

Number of messages found in the mailbox (POP3 protocol)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailReadMessageHeader (Function)

In french: EmailLitEntêteMessage

Reads the header of an email received:

POP3 or IMAP protocol: the Email is stored in the mailbox on the mail server.

The various variables in the Email structure 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 start a session with one of the following functions: EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.

Example

// Utilisation du protocole POP3 
// Lecture des emails dont la taille ne dépasse pas TailleMaxEmail
I is int
FOR I = 1 TO EmailNbMessage(NomUser)
	IF EmailMessageLength(NomUser, I) < TailleMaxEmail THEN
		// Procédure de lecture et traitement du message
		LireMessage()
	ELSE
		EmailReadMessageHeader(NomUser, I)
		// Procédure de réponse signalant que l'email n'a pas été lu
		RenvoiMessage(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 get more details on the error, use ErrorInfo with the errMessage constant.
The Email.Out variable is set 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.

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

<Message number>: Integer

Number of the message whose header will be read.

Remarks

Number of messages found in the mailbox (POP3 protocol)

You can get the total number of messages received with EmailNbMessage.

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

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: At the time of connection, four messages are on the server and these messages are numbered from 1 to 4. If message #1 is deleted:

EmailNbMessage returns 4.
Reading message 1 with the EmailReadMessage function or the EmailReadMessageHeader FUNCTION is impossible: the message no longer exists. 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: wd300com.dll