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.
  • The email structure and the Email variables
  • 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 the header of last 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.
The different Variable s of the Email structure (or the properties of an Variable of type Email) corresponding to the message header are filled in.
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.
Java The POP3 protocol can only be used to read emails.
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
// Supprime les emails envoyés par des expéditeurs "black-listés"
 
EmailStartPOP3Session("utilisateur", "secret", "pop.masociete.fr")
 
// Parcours des emails
// Lecture de l'entête uniquement
IF EmailReadLastHeader("utilisateur") THEN
LOOP
// Est-ce-que l'expéditeur fait partie d'une
// liste de gens "interdit"?
IF ExpediteurInterdit(Email.SenderAddress) OR ...
ExpediteurInterdit(Email.Sender) THEN
// Si l'email est "interdit", on le supprime
// Les emails "autorisés" pourront alors être
// lus complètement dans un deuxième temps
EmailDeleteMessage("utilisateur")
END
TO DO WHILE EmailReadPreviousHeader("utilisateur")
END
Example with an Email variable
// Supprime les emails envoyés par des expéditeurs "black-listés"
 
MaSession is emailPOP3Session
MaSession.ServerAddress = "pop.masociete.fr"
MaSession.Name = "utilisateur"
MaSession.Password = "secret"
EmailStartSession(MaSession)
 
// Parcours des emails
FOR EACH MessageEmail OF MaSession
// Est-ce-que l'expéditeur fait partie d'une
// liste de gens "interdit"?
IF ExpéditeurInterdit(MessageEmail..SenderAddress) OR ...
ExpediteurInterdit(MessageEmail..Sender) THEN
// Si l'email est "interdit", on le supprime
// Les emails "autorisés" pourront alors être
// lus complètement dans un deuxième temps
EmailDeleteMessage(MaSession, MessageEmail)
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:
Java Variables of type emailPOP3Session and emailIMAPSession are not supported.
<Email>: Optional Email variable
Versions 15 and later
Name of the Variable of type Email corresponding to the Email to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
New in version 15
Name of the Variable of type Email corresponding to the Email to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
Name of the Variable of type Email corresponding to the Email to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Java This parameter is not available
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)Ajax

Reading the header of the last email managed via Lotus Notes or Outlook Hide the details

<Result> = EmailReadLastHeader(<Session> [, <Email> [, <Read mode>]])
<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>: Integer
Identifier of current email session. This identifier can be:
<Email>: Optional Email variable
Versions 15 and later
Name of the Variable of type Email corresponding to the Email 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 Variable of type Email corresponding to the Email to be initialized with the message content.
If this parameter is not specified, the Email structure is used.
Name of the Variable of type Email corresponding to the Email 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.
Remarks

The email structure and the Email variables

Two methods can be used to handle the emails:
WINDEVWEBDEV - Server code

Outlook messaging

The WLanguage EmailReadxxx functions operate with the Outlook data file (.pst) only. The other data files are not supported.
Component: wd270com.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment