PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • The attached files
  • Using Pocket Outlook
  • Progress Bar
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 first incoming email:
  • via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
  • Windows Mobile via Pocket Outlook (user account other than the "ActiveSync" account): the email is placed in the in-box of Pocket Outlook.
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.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for 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 Android applications.
New in version 22
Android Widget This function is now available in Android Widget mode.
Android This function is now available for Android applications.
Android Widget This function is now available in Android Widget mode.
Android This function is now available for Android applications.
// 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. The ErrorOccurred variable is set to True if an error occurred.
    To find out the error details, use ErrorInfo associated 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
Versions 15 and later
Name of the Email variable that will be initialized with the message content.
New in version 15
Name of the Email variable that will be initialized with the message content.
Name of the Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Windows Mobile

Reading the first incoming email via MS Exchange, Pocket Outlook, Lotus Notes or Outlook Hide the details

<Result> = EmailReadFirst(<Session> [, <Email> [, <Read mode> [, <Type>]]])
<Result>: Boolean
  • True if the message was read,
  • False otherwise. The ErrorOccurred variable is set to True if an error occurs.
    To find out the error details, use ErrorInfo associated with the errMessage constant. If no email is found, ErrorOccurred remains set to False and the Email.Out variable is positioned to True.
<Session>: Integer, or emailOutlookSession or emailNotesSession variable
Identifier of current email session. This identifier can be:
<Email>: Optional Email variable
Versions 15 and later
Name of the Email variable that must be initialized with the content of the message.
New in version 15
Name of the Email variable that must be initialized with the content of the message.
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.
<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.
<Type>: Optional character string
Describes the type of message to read. By default, <Type> = "IPM" (Inter Personal Message).
Windows Mobile This parameter is not available. You cannot specify the type of message to read.
Remarks

The attached files

When reading a message, the files attached to this message can be copied onto the local disk (or onto the server disk) by 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.
Windows Mobile

Using Pocket Outlook

When reading a message, the files attached to this message can be copied to the local disk with EmailSaveAttachment.
AndroidAndroid Widget iPhone/iPadWindows MobileUniversal Windows 10 App

Progress Bar

To follow the progress when receiving 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.
Component : wd250com.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment