EmailReadFirst (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Managing emails

The attached files
Using MS Exchange
Progress Bar
Outlook messaging

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailReadFirst (Function)

In french: EmailLitPremier

Reads the first incoming email:

POP3 or IMAP protocol: the Email is stored in the mailbox on the mail server.
or via the MS Exchange client: the email received is stored on the local workstation in the MS Exchange inbox.
via Lotus Notes or Outlook e-mail software: the email received is stored on the local workstation in the Lotus Notes or Outlook inbox.

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 the EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession function.

The POP3 protocol can only be used to read emails.

Example

See additional examples

// Lecture du premier email 
EmailReadFirst(IDEmail)
IF Email.Out = False THEN
	// Affiche l'email dans la fenêtre FEN_Email_RCV
	Open(FEN_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:
the username that was used to start the email session (EmailStartSession).
a variable of type emailPOP3Session.
a variable of type emailIMAPSession.
Variables of type emailPOP3Session and emailIMAPSession are not supported.

<Email>: Optional Email variable

Name of the Email variable to be initialized with the message content.
This parameter is not available
If this parameter is not specified, the Email structure is used.

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

<Result> = EmailReadFirst(<Session> [, <Email> [, <Read mode> [, <Type>]]])

<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>: Integer, or emailOutlookSession or emailNotesSession variable

Identifier of the current email session. This identifier can be:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
a variable of type emailOutlookSession.
a variable of type emailNotesSession.
a variable of type emailIMAPSession.

<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.

<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).

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 streamline communications: only new messages will be read on the server.

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.

Progress Bar

To track the progress of the email, use EmailProgressBar.

Outlook messaging

The WLanguage EmailReadxxx functions operate with the Outlook data file (.pst) only. The other data files are not supported.

Related Examples:

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.

Training (WINDEV): WD JavaMail

[ + ] This example is a Java example used to read and send emails.

Business / UI classification: Business Logic

Component: wd300com.dll