PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • 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 last 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 (or the properties of an 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
Example that is using the Email structure
// Deletes the emails sent by "black-listed" senders

EmailStartPOP3Session("user", "secret", "pop.mycompany.fr")

// Browse the emails
// Read the header only
IF EmailReadLastHeader("user") THEN
LOOP
// Does the sender belong to
// a "black list"?
IF BlackListedSender(Email.SenderAddress) OR ...
BlackListedSender(Email.Sender) THEN
// If the email is "black-listed", delete it
// Then, the "authorized" emails can
// be entirely read later
EmailDeleteMessage("user")
END
DO WHILE EmailReadPreviousHeader("user")
END
Example that is using an Email variable
// Deletes the emails sent by "black-listed" senders

MySession is EmailPOP3Session
MySession..ServerAddress = "pop.mycompany.us"
MySession..Name = "user"
MySession..Password = "secret"
EmailStartSession(MySession)

// Browse the emails
FOR EACH EmailMessage OF MySession
// Does the sender belong to
// a "black list"?
IF BlackListedSender(EmailMessage..SenderAddress) OR ...
BlackListedSender(EmailMessage..Sender) THEN
// If the email is "black-listed", delete it
// Then, the "authorized" emails can
// be entirely read later
EmailDeleteMessage(MySession, EmailMessage)
END
END
Syntax

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

<Result> = EmailReadLastHeader(<Session> [, <Email>])
<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:
Java The emailPOP3Session and emailIMAPSession variables are not supported.
<Email>: Optional Email variable
Versions 15 and later
Name of Email variable corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
New in version 15
Name of Email variable corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
Name of Email variable corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
WINDEVWEBDEV - Server codeReports and QueriesWindows MobileAjaxUser code (UMC)

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

<Result> = EmailReadLastHeader(<Session> [, <Email>] [, <Read Mode>])
<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:
Versions 15 and later
New in version 15
<Email>: Optional Email variable
Versions 15 and later
Name of Email variable corresponding to the email 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 corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of Email variable corresponding to the email 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:
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