PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • The attached files
  • Using MS Exchange
  • Using Pocket Outlook
  • Progress bar
  • 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 first 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 incoming 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 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 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.
// 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 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>: 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 Email variable that will be initialized with the message content.
Java This parameter is not available
New in version 15
Name of Email variable that will be initialized with the message content.
Java This parameter is not available
Name of Email variable 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 QueriesWindowsWindows MobileAjaxUser code (UMC)

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 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>: 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 message content.
New in version 15
Name of the Email variable that must be initialized with the message content.
Name of the Email variable that must 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.
<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.
WINDEVWEBDEV - Server codeReports and QueriesWindowsAjaxUser code (UMC)

Using MS Exchange

EmailUpdate allows you to receive the messages from the Internet email server when using MS Exchange.
When reading a message, the files attached to this message are copied into the temporary directory of Windows. The full name of these files are stored in Email.Attach. These attached files can be copied by fCopyFile.
Windows Mobile

Using Pocket Outlook

When reading a message, the files attached to this message can be copied to the local disk with EmailSaveAttachment.
WINDEVReports and QueriesWindowsAndroidAndroid Widget iPhone/iPadWindows MobileUniversal Windows 10 AppUser code (UMC)

Progress bar

To follow the progress when receiving 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.
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 create an applet.
This applet can then be used in an Internet page.
This applet enables you read and send emails.
In this project, a second configuration enables you to manage a "Standard" Java application (.jar).
To generate the Java applet and the "Standard" Java application, select "Workshop - Java - Generate the Java archive",
for each one of the two configurations of project.
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