PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • No next email
  • Initializing the reading of emails
  • 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 the email found after the current email:
  • 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 different variables of email structure (or Email variable) 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 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
// Read the first email
EmailReadFirstHeader(EmailID)
IF Email.Out = False THEN
// Displays the sender and the subject in a table
TableAdd(TABLE_IncomingEmails, Email.Sender + TAB + Email.Subject)
// Read the next email
EmailReadNextHeader(EmailID)
END
Syntax

Reading the header of next email managed by the POP3 or IMAP protocol Hide the details

<Result> = EmailReadNextHeader(<Session> [, <Email>])
<Result>: Boolean
  • True if the message header was read,
  • False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.
<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.
WINDEVWEBDEV - Server codeReports and QueriesWindows MobileAjaxUser code (UMC)

Reading the header of the next email managed via Pocket Outlook, Lotus Notes, Outlook Hide the details

<Result> = EmailReadNextHeader(<Session> [, <Email>] [, <Read Mode>])
<Result>: Boolean
  • True if the message header was read,
  • False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.
<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.
<Read Mode>: Optional constant or character string
Indicates the messages that will be read:
emailAll or "ALL"
(Default value)
All the messages will be read.
emailUnread or "UNREAD"Only the unread messages will be read.
Remarks

No next email

If no email was found (no next message), the Email.Out variable is set to True. The next call to EmailReadNextHeader will read the header of first incoming message (equivalent to EmailReadFirstHeader).

Initializing the reading of emails

If the reading was not initialized by EmailReadFirstHeader, EmailReadNextHeader is used to read the header of first message.
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