EmailReadNext (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Initializing the reading of emails

Using the POP3 protocol

See also

EmailReadNext (Function)

In french: EmailLitSuivant

Reads the incoming email found after the current email:

via the POP3 or IMAP protocol: the incoming emails are found in the mailbox.
via the MS Exchange client: the incoming emails are found in the in-box of MS Exchange. The next email is sought in the in-box and on the server.
via the Lotus Notes or Outlook messaging software: the incoming emails are found in the in-box of Lotus Notes or Outlook. The next email is sought in the in-box.
via Pocket Outlook (user account other than the "ActiveSync" account): the incoming emails are found in the in-box of Pocket Outlook. The next email is sought in the in-box and on the server.

If no email is found (no next message), the Email.Out variable is set to True.

Reminder: Before reading an email, a session must be started by EmailStartSession, EmailStartNotesSession or EmailStartOutlookSession.

The emails can only be read via the POP3 protocol.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 22 and later

This function is now available in Android Widget mode.

This function is now available for Android applications.

New in version 22

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Android applications.

Example

See additional examples

// Read the first email
EmailReadFirst(EmailID)
IF Email.Out = False THEN
// Displays the sender and the subject in a table
TableAdd(TABLE_IncomingEmails, Email.Sender + TAB + Email.Subject)
// Read the next email
EmailReadNext(EmailID)
END

Syntax

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

<Result> = EmailReadNext(<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 name of the error, use the function ErrorInfo with the constant errMessage. 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 user name that was used to start the email session (EmailStartSession).
Versions 15 and later
an emailPOP3Session variable.
New in version 15
an emailPOP3Session variable.
an emailPOP3Session variable.
Versions 15 and later
an emailIMAPSession variable.
New in version 15
an emailIMAPSession variable.
an emailIMAPSession variable.
Versions 15 and later
The emailPOP3Session and emailIMAPSession variables are not supported.
New in version 15
The emailPOP3Session and emailIMAPSession variables are not supported.
The emailPOP3Session and emailIMAPSession variables are not supported.

<Email>: Optional Email variable

Versions 15 and later
Name of the Email variable that will be initialized with the message content.
This parameter is not available.
If this parameter is not specified, the Email structure is used.
New in version 15
Name of the Email variable that will be initialized with the message content.
This parameter is not available.
If this parameter is not specified, the Email structure is used.
Name of the Email variable that will be initialized with the message content.
This parameter is not available.
If this parameter is not specified, the Email structure is used.

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

<Result> = EmailReadNext(<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 name of the error, use the function ErrorInfo with the constant errMessage. 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:
an integer returned by EmailStartOutlookSession or OutlookStartSession.
Versions 15 and later
an emailOutlookSession variable.
New in version 15
an emailOutlookSession variable.
an emailOutlookSession variable.
Versions 15 and later
a emailNotesSession variable.
New in version 15
a emailNotesSession variable.
a emailNotesSession variable.
Versions 15 and later
a emailIMAPSession variable.
New in version 15
a emailIMAPSession variable.
a emailIMAPSession variable.

<Email>: Optional Email variable

Versions 15 and later
Name of the Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
New in version 15
Name of the Email variable that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of the Email variable 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.

<Type>: Optional character string

Describes the type of message to read. By default, <Type> = "IPM" (Inter Personal Message).
This parameter is not available. You cannot specify the type of message to send.

Remarks

No next email

If no email was found (no next message), the Email.Out variable is set to True. The next call to EmailReadNext will read the first incoming email (equivalent to EmailReadFirst).

Initializing the reading of emails

If the read operation was not initialized by EmailReadFirst, EmailReadNext is used to read the first message.

Using the POP3 protocol

When reading a message, the files attached to this message can be copied to the local disk with EmailSaveAttachment.

Tip: We recommend that you keep the messages and their attachments on the local disk, then delete them from the server. This operation is used to:

reduce the size of the mailbox on the server,
improve and speed up the communications in POP3 sessions: only the 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.

Using Pocket Outlook

When reading a message, the files attached to this message can be copied to the local disk with EmailSaveAttachment.

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: wd260com.dll