ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Communication / Managing emails
  • The attached files
  • Progress Bar
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 first incoming email:
  • via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
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.
// Read the first email
EmailReadFirst(EmailID)
IF Email.Out = False THEN
// Displays the email in the WIN_Email_RCV window
Open(WIN_Email_RCV)
END
Syntax

Reading the first incoming email via the POP3 or IMAP protocol Hide the details

<Result> = EmailReadFirst(<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.
If no email is found, ErrorOccurred remains set to False and the Email.Out variable is positioned to True.
<Session>: Character string, or emailPOP3Session or emailIMAPSession variable
Identifies the user session. Corresponds to:
<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.
Remarks

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: only the new messages will be read on the server.
Universal Windows 10 AppAndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst

Progress Bar

To track the progress of the email, use EmailProgressBar.
Related Examples:
The POP3 Email functions Unit examples (WINDEV): The POP3 Email functions
[ + ] Using the Email functions to manage the POP3 protocol.
This protocol is used to retrieve emails from a server.
WD JavaMail Training (WINDEV): WD JavaMail
[ + ] This example is a Java example used to read and send emails.
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/22/2023

Send a report | Local help