ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Communication / Managing emails
  • Email structure and variables
  • The attached files
  • Progress Bar
  • 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 last incoming email:
  • via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
  • WINDEVWEBDEV - Server code via the MS Exchange client: the email is found on the local computer in the in-box of MS Exchange.
  • WINDEVWEBDEV - Server code via the Lotus Notes or Outlook messaging software: the email is found on the local computer in the in-box of Lotus Notes or Outlook.
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.
// Read the last email
IF EmailReadLast(UserName) = True THEN
// If the email exists, opens WIN_Email_RCV to read the email
IF Email.Out = False THEN
Open(WIN_Email_RCV)
ELSE
Info("No email")
END
ELSE
Error()
END
Syntax

Reading the last email managed by the POP3/IMAP protocol Hide the details

<Result> = EmailReadLast(<Session> [, <Email>])
<Result>: Boolean
  • True if the message was read.
  • False otherwise. If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.
The Email.Out variable is set to True if no message was found (no email) and the ErrorOccurred variable remains set to False.
<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 corresponding to the email 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 QueriesUser code (UMC)Ajax

Reading the last email managed via MS Exchange, Lotus Notes, Outlook Hide the details

<Result> = EmailReadLast(<Session> [, <Email> [, <Read mode>]])
<Result>: Boolean
  • True if the message was read. In this case, the email structure is automatically updated.
  • False otherwise. If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo with the errMessage constant.
The Email.Out variable is set to True if no message was found (no email) and ErrorOccurred remains set to False.
<Session>: Integer
Identifier of current email session. This identifier can be:
<Email>: Optional Email variable
Name of the 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

Email structure and variables

Two methods can be used to handle emails:
  • The Email structure is a global structure used to easily handle messages.
  • Email variables offer more advanced features (databinding, serialization, multiple instances).
When reading the email, the Email structure is automatically updated according to the content of the message.
The Email.Cci and Email.NbCci variables (or the Cci property, if a variable of type Email is used) are cleared.

The attached files

When reading a message, the attached files can be copied to the local disk (or to the server disk) using EmailSaveAttachment.
Tip: We recommend that you save the messages and their attached files on the local disk (or on a server disk), then delete them from the email server. This operation is used to:
  • reduce the size of the mailbox on the server,
  • improve and speed up the communications for the POP3 servers: only the new messages will be read on the server.
WINDEVReports and QueriesWindowsUniversal Windows 10 AppAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystUser code (UMC)

Progress Bar

To track the progress of the email, use EmailProgressBar.
WINDEVWEBDEV - Server code

Outlook messaging

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

Last update: 06/21/2023

Send a report | Local help