PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE
  • Number of messages found in the mailbox (POP3 protocol)
  • Number of messages found in the mailbox (Outlook messaging)
  • The attached files
  • Progress Bar
  • Outlook messaging
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.
  • 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.
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.
Java The POP3 protocol can only be used to read emails.
Example
// Use with the POP3 protocol
I is int
nbMSG is int = EmailNbMessage(UserName)
FOR I = 1 TO nbMSG
IF EmailReadMessage(UserName, I) = True THEN
IF Email.Out <> True THEN
CU.NAME = Email.Sender
CU.MESSAGE_TXT = Email.Message
...
ELSE
Info("This message was deleted")
END
END
END
WINDEVWEBDEV - Server code
// Use with the Outlook messaging software
// TABLE_EmailTable table contains all the incoming emails
// COL_Sender contains the sender name (Email.Sender variable)
// COL_Subject contains the email subject (Email.Sujet variable)
// COL_ID contains the email identifier (Email.ID variable)
// Read the selected email in the Table control
EmailReadMessage(SessionID, COL_ID)
// Retrieve the email content
Info("Message of the email: " + Email.Message)
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 more details on 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:
Java 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.
Java This parameter is not available
If this parameter is not specified, the Email structure is used.
<Message number>: Integer
  • Index of message to read in POP3
  • Identifier (UID) of the message in IMAP.
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)Ajax

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 more details on 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
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.
  • EmailReadMessage cannot read message # 1: 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.
WINDEVWEBDEV - Server code

Number of messages found in the mailbox (Outlook messaging)

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 actual number of messages in the inbox folder.

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.
WINDEVReports and QueriesUniversal Windows 10 AppAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystUser code (UMC)

Progress Bar

To track the progress of 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.
Business / UI classification: Business Logic
Component: wd280com.dll
See also
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment