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

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:

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

The various variables in the Email structure (or 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, you need to log in using EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.

Example

// Supprime les emails envoyés par des expéditeurs "black-listé" 
// Parcours des emails
// Lecture de l'entête uniquement 
// (pour économiser la bande passante)
// Si l'email est "interdit", on le supprime
// Les emails "autorisés" pourront alors être lus complètement 
// dans un deuxième temps
IF EmailReadLastHeader(MaSessionPOP) THEN
	LOOP
	// Est-ce-que l'expéditeur fait partie d'une liste de gens "interdit" ?
	IF ExpediteurInterdit(Email.SenderAddress) OR ...
			ExpediteurInterdit(Email.Sender) THEN
		EmailDeleteMessage(MaSessionPOP)
	END
	TO DO WHILE EmailReadPreviousHeader(MaSessionPOP)
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 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.

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

Component: wd300com.dll