PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE
  • 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/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
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.
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, it is necessary to open a session with EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.
Java The POP3 protocol can only be used to read emails.
Example
// Read the first email
EmailReadFirstHeader(EmailID)
IF Email.Out = False THEN
// Displays the sender and subject in a Table control
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 get more details on the error, use ErrorInfo with the errMessage constant.
<Session>: Character string, or emailPOP3Session or emailIMAPSession variable
Identifies the user session. Corresponds to:
Java 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.
Java This parameter is not available
If this parameter is not specified, the Email structure is used.
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)Ajax

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

<Result> = EmailReadNextHeader(<Session> [, <Email> [, <Read mode>]])
<Result>: Boolean
  • True if the message header was read,
  • False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.
<Session>: Integer
Identifier of current email session. This identifier can be:
<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.
<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.
Component: wd280com.dll
See also
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment