PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Number of messages found in the mailbox (POP3 protocol)
  • Number of messages found in the mailbox (Outlook messaging)
  • Outlook messaging
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
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.
  • WINDEVWEBDEV - Server code via the Lotus Notes or Outlook messaging software: the incoming email is found on the local computer in the in-box of Lotus Notes or Outlook.
  • Windows Mobile via Pocket Outlook (user account other than the "ActiveSync" account): the email is placed in the in-box of Pocket Outlook.
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.
Java The POP3 protocol can only be used to read emails.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the 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 the Android applications.
New in version 22
Android Widget This function is now available in Android Widget mode.
Android This function is now available for the Android applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for the 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
WINDEVWEBDEV - Server code
// Use with the Outlook messaging software
// TABLE_EmailTable table contains all the incoming emails
// COL_Sender contains the sender name (Email.Sender variable)
// COL_Subject contains the email subject (Email.Sujet variable)
// COL_ID contains the email identifier (Email.ID variable)
// Read the header of email selected in the table
EmailReadMessageHeader(SessionID, 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 find out the error details, use ErrorInfo associated 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:
Versions 15 and later
Java The emailPOP3Session and emailIMAPSession variables are not supported.
New in version 15
Java The emailPOP3Session and emailIMAPSession variables are not supported.
Java The emailPOP3Session and emailIMAPSession variables are not supported.
<Email>: Optional Email variable
Versions 15 and later
Name of Email variable that will be initialized with the message content.
Java This parameter is not available
New in version 15
Name of Email variable that will be initialized with the message content.
Java This parameter is not available
Name of Email variable that will be initialized with the message content.
Java 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.
WINDEVWEBDEV - Server codeReports and QueriesWindows MobileAjaxUser code (UMC)

Reading the header of an email managed via Pocket Outlook, Lotus Notes, 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 find out the error details, use ErrorInfo associated 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 Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
New in version 15
Name of Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of Email variable that will 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 incoming messages is returned by EmailNbMessage.
In the same email session, if a message was deleted by EmailDeleteMessage:
  • EmailNbMessage returns the number of messages found on the email server before 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 the message #1 is deleted:
  • EmailNbMessage returns 4.
  • The message #1 cannot be read by EmailReadMessage or EmailReadMessageHeader: the message does not exist anymore. The Email.Out variable returns True. Only the messages 2, 3, and 4 exist.
The message numbers are re-assigned during the next connection.
WINDEVWEBDEV - Server code

Number of messages found in the mailbox (Outlook messaging)

The total number of incoming messages is returned by EmailNbMessage.
In the same email session, if a message was deleted by EmailDeleteMessage, EmailNbMessage returns the correct number of messages found in the incoming email folder.
WINDEVWEBDEV - Server code

Outlook messaging

The WLanguage EmailReadxxx functions operate with the Outlook data file (.pst) only. The other data files are not supported.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230com.dll
Windows Mobile wp230com.dll
Java wd230java.jar
Linux wd230com.so
Android wd230android.jar
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment