PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

  • 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.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Versions 22 and later
Android Widget This function is now available in Android widget mode.
Android This function is now available for Android applications.
New in version 22
Android Widget This function is now available in Android widget mode.
Android This function is now available for Android applications.
Android Widget This function is now available in Android widget mode.
Android 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 get more details on 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 to be initialized with the message content.
New in version 15
Name of the Email variable to be initialized with the message content.
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: 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