PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE
  • Properties specific to the description of emailPOP3Session variables
  • Functions that use emailPOP3Session 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
The emailPOP3Session type is used to access a messaging server by using the POP3 protocol (Post Office Protocol) in order to retrieve the messages found on this server. The characteristics of the connection can be defined and changed using different WLanguage properties.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Example
// Start a POP3 session
MySession is emailPOP3Session
 
MySession.ServerAddress = "pop.mydomain.fr"
MySession.Name = "user"
MySession.Password = "secret"
 
EmailStartSession(MySession)
 
// Retrieve all the messages
arrMessage is array of Emails
arrMessage = EmailGetAll(MySession)
 
// Browse the array of messages by index
FOR I = 1 _TO_ MySession.EmailBySubscript.Count
Trace(MySession.EmailBySubscript[I].Subject)
END
 
// Browse the array of messages with a FOR EACH loop
FOR EACH AMessage OF MySession
Trace(AMessage.Subject)
END
Remarks

Properties specific to the description of emailPOP3Session variables

The following properties can be used to handle an emailPOP3Session variable:
Property name Type used Effect
ServerAddressCharacter stringAddress of email server. This address is supplied by the service provider or by the network administrator. This address can be given in the following format:
  • IP address (in XXX.XXX.XXX.XXX format, 125.5.110.100 for example).
  • Name of server (pop3.free.fr for example). This syntax is recommended.
PasswordCharacter stringUser password. This password is given by the service provider or by the network administrator.
NameCharacter stringIdentifies the user. This name is supplied by the service provider or by the network administrator.
OptionInteger constantThe possible values are:
  • emailOptionDefault (default value): Connection by using the POP3 protocol.
  • optionSSL: Connection using the POP3 protocol inside an SSL tunnel. This option guarantees the confidentiality of exchange but it must be supported by the server.
Universal Windows 10 App This property is not supported.
PortIntegerIdentifies the port used for the POP3 protocol.
This property is set to 110 by default, corresponding to the number of standard port for this protocol.
Remark: To use the SSL protocol, the port number must be specified. In most cases, the email servers expect the SSL connections on port 995.

Functions that use emailPOP3Session variables

EmailCloseSessionCloses an email management session depending on the selected mode (SMTP/POP3, IMAP, MS Exchange or Lotus Notes).
EmailReadLastReads the last incoming email according to the protocol used (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
EmailReadLastHeaderReads the header of last incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
EmailReadMessageHeaderReads the header of an incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
EmailReadPreviousHeaderReads the header of the email found before the current email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
EmailReadFirstHeaderReads the header of the first incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
EmailReadNextHeaderReads the header of the email found after the current email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
EmailReadMessageReads an incoming according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
EmailReadPreviousReads the email found before the current email according to the protocol used (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
EmailReadFirstReads the first incoming email according to the protocol used (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
EmailReadNextReads the incoming email found after the current email according to the protocol (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
EmailNbMessageReturns the number of incoming messages currently found:
  • on the email server (POP3 protocol only).
  • in the Outlook messaging software.
EmailStartSessionStarts an email management session based on the selected management mode (POP3, SMTP, IMAP or MS Exchange).
EmailGetAllRetrieves all the emails found on a server.
EmailDeleteMessageDeletes the current email using the current protocol (POP3, IMAP, MS Exchange, Lotus Notes or Outlook).
EmailMessageLengthCalculates the size of specified message (without loading the message).
Related Examples:
WD Mail Complete examples (WINDEV): WD Mail
[ + ] This application is an email client developed in WINDEV. It is based on the Email objects.
This email client is used to retrieve and send emails by using the POP, IMAP and SMTP protocols.
You have the ability to apply filters to the incoming emails.

The application can also be used to manage several email accounts. The writing of an email is based on the HTML edit control.
See also
Minimum version required
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment