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)
Number of messages found in the mailbox (Outlook messaging)
Outlook messaging

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.
via Lotus Notes or Outlook e-mail software: the email received is stored on the local workstation in the Lotus Notes or Outlook inbox.

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.

The POP3 protocol can only be used to read emails.

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

// Utilisation avec le logiciel de messagerie Outlook 
// TABLE_TableEmail contient l'ensemble des emails reçus
// COL_Exp contient le nom de l'expéditeur (variable Email.Expéditeur)
// COL_Sujet contient le sujet de l'email (variable Email.Sujet)
// COL_ID contient l'identifiant de l'email (variable Email.ID)
// Lecture de l'entête de l'email sélectionné dans la table
EmailReadMessageHeader(IDSession, COL_ID)

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

<Message number>: Integer

Number of the message whose header will be read.

Reading the header of an email managed via Lotus Notes or 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 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>: 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.

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

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.

Number of messages found in the mailbox (Outlook messaging)

The total number of received messages is returned by EmailNbMessage.

If a message was deleted by EmailDeleteMessage in the same email session, EmailNbMessage returns the actual number of messages in the inbox folder.

Outlook messaging

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

Component: wd300com.dll