PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • The email structure and the Email variables
  • 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 first email received:
  • via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
  • WINDEV 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, a session must be started by EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.
Java The POP3 protocol can only be used to read emails.
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.
Example
// Read the first email
EmailReadFirstHeader(EmailID)
IF Email.Out = False THEN
// Displays the email in the "WIN_Email_RCV" window
Open(WIN_Email_RCV)
END
 
Syntax

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

<Result> = EmailReadFirstHeader(<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 the Email variable that must be initialized with the content of the message.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
New in version 15
Name of the Email variable that must be initialized with the content of the message.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
Name of the Email variable that must be initialized with the content of the message.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
WINDEVUser code (UMC)

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

<Result> = EmailReadFirstHeader(<Session> [, <Email> [, <Read mode>]])
<Result>: Boolean
  • True if the message header was read,
  • False otherwise. To know the error details, use ErrorInfo with the constant errMessage.
<Session>: Integer
Identifier of current email session. This identifier can be:
<Email>: Optional Email variable
Versions 15 and later
Name of the 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 the Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of the 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

The email structure and the Email variables

Two methods can be used to handle the emails:
WINDEV

Outlook messaging

The WLanguage EmailReadxxx functions operate with the Outlook data file (.pst) only. The other data files are not supported.
Component : wd240com.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment