PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
This content has been translated automatically. Click here to view the French version.
  • Number of messages found in the mailbox (POP3 protocol)
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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.
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.
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 the details of the error, use ErrorInfo 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:
<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.
Reports and Queries

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 the details of the error, use ErrorInfo 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:
<Email>: Optional Email variable
Versions 15 and later
Name of the Email variable to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
New in version 15
Name of the Email variable to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
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)

The total number of messages received is obtained using the EmailNbMessage function.
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: During the connection, four messages are found on the server and these messages are numbered 1 to 4. If message #1 is deleted:
  • EmailNbMessage returns 4.
  • EmailReadMessage or EmailReadMessageHeader cannot read message # 1: 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: wd270com.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment