PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

  • The email structure and the Email variables
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 the header of last email received:
  • via the POP3 or IMAP protocol: the email is found in the in-box on the messaging server.
The variables of the Email structure (or the properties of a variable of type Email) corresponding to the message header are specified.
This function is useful when reading the email is linked to the message size for example.
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.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for 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 Android applications.
New in version 22
Android Widget This function is now available in Android widget mode.
Android This function is now available for Android applications.
Android Widget This function is now available in Android widget mode.
Android This function is now available for Android applications.
Example
Example with the Email structure
// Deletes the emails sent by "black-listed" senders
 
EmailStartPOP3Session("user", "secret", "pop.mycompany.fr")
 
// Browse the emails
// Read the header only
IF EmailReadLastHeader("user") THEN
LOOP
// Does the sender belong to
// a "black list"?
IF BlackListedSender(Email.SenderAddress) OR ...
BlackListedSender(Email.Sender) THEN
// If the email is "black-listed", delete it
// Then, the "authorized" emails can
// be entirely read later
EmailDeleteMessage("user")
END
DO WHILE EmailReadPreviousHeader("user")
END
Example with an Email variable
// Deletes the emails sent by "black-listed" senders
 
MySession is emailPOP3Session
MySession.ServerAddress = "pop.mycompany.us"
MySession.Name = "user"
MySession.Password = "secret"
EmailStartSession(MySession)
 
// Browse the emails
FOR EACH EmailMessage OF MySession
// Does the sender belong to
// a "black list"?
IF BlackListedSender(EmailMessage..SenderAddress) OR ...
BlackListedSender(EmailMessage..Sender) THEN
// If the email is "black-listed", delete it
// Then, the "authorized" emails can
// be entirely read later
EmailDeleteMessage(MySession, EmailMessage)
END
END
Syntax

Reading the header of last email managed by the POP3 or IMAP protocol Hide the details

<Result> = EmailReadLastHeader(<Session> [, <Email>])
<Result>: Boolean
  • True if the message header 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:
<Email>: Optional Email variable
Versions 15 and later
Name of the Email variable corresponding to the email 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 corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of the Email variable corresponding to the email that will be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Remarks

The email structure and the Email variables

Two methods can be used to handle emails:
Component: wd270com.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment