PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
This content has been translated automatically. Click here to view the French version.
  • Number of messages found in the mailbox (POP3 protocol)
  • 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 an email received:
  • via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
This function does not modify the current position.
The variables of the email structure (or Email variable) are filled.
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.
// Utilisation avec le protocole POP3
I is int
nbMSG is int = EmailNbMessage(NomUser)
FOR I = 1 TO nbMSG
IF EmailReadMessage(NomUser, I) = True THEN
IF Email.Out <> True THEN
CL.NOM = Email.Sender
CL.MESSAGE_TXT = Email.Message
...
ELSE
Info("Ce message a été supprimé")
END
END
END
Syntax

Reading an email managed by the POP3 or IMAP protocol Hide the details

<Result> = EmailReadMessage(<Session> [, <Email>] , <Message number>)
<Result>: Boolean
  • True if the message was read. In this case, the email structure is automatically updated.
  • False otherwise. To get the details of the error, use ErrorInfo with the errMessage constant.
The Email.Out variable is positioned to True if no message was found (no email).
<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 to be initialized with the message content.
New in version 15
Name of the Email variable to be initialized with the message content.
Name of the Email variable to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
<Message number>: Integer
  • Subscript of message to read in POP3
  • Identifier (UID) of the message in IMAP.
Reports and Queries

Reading an email managed via Lotus Notes or Outlook Hide the details

<Result> = EmailReadMessage(<Session> [, <Email>] , <Message identifier>)
<Result>: Boolean
  • True if the message was read. In this case, the email structure is automatically updated.
  • False otherwise. To get the details of the error, use ErrorInfo with the errMessage constant.
The Email.Out variable is positioned to True if no message was found (no email).
<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 to 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 to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of the Email variable to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
<Message identifier>: Character string
Identifier of the message to read. This identifier is found in the Email.ID variable when reading emails.
Remarks

Number of messages found in the mailbox (POP3 protocol)

The total number of received messages is returned by EmailNbMessage.
If a message was deleted by EmailDeleteMessage in the same email session:
  • EmailNbMessage returns the number of messages found on the email server before the deletion.
  • the numbers of the deleted messages are not re-assigned.
For example: During the connection, four messages are on found the server. These messages are numbered from 1 to 4. If message #1 is deleted:
  • EmailNbMessage returns 4.
  • get of message 1 with function EmailReadMessage is impossible: the message no longer exists. The Email.Out variable returns True. Only the messages 2, 3, and 4 exist.
The message numbers are re-assigned during the next connection.

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 on the POP3 servers: only the new messages will be read on the server.
Reports and Queries

Progress Bar

To track the progress of the email, use EmailProgressBar.
Business / UI classification: Business Logic
Component: wd270com.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment