PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of emailIMAPSession variables
  • Functions that use the emailIMAPSession variables
  • Limits
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The emailIMAPSession type is used to access a messaging server by using the IMAP protocol (Internet Access Message Protocol) in order to retrieve the messages found on this server. The connection characteristics can be defined and modified by several WLanguage properties.
Note: See Declaring a variable for more details.
Versions 17 and later
iPhone/iPad This type of variable is now available for the iPhone and iPad applications.
New in version 17
iPhone/iPad This type of variable is now available for the iPhone and iPad applications.
iPhone/iPad This type of variable is now available for the iPhone and iPad applications.
Versions 21 and later
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
Versions 22 and later
Android Widget This type of variable is now available in Android Widget mode.
Android This type of variable is now available for the Android applications.
New in version 22
Android Widget This type of variable is now available in Android Widget mode.
Android This type of variable is now available for the Android applications.
Android Widget This type of variable is now available in Android Widget mode.
Android This type of variable is now available for the Android applications.
Example
// Start the session
MySession is EmailIMAPSession

MySession..ServerAddress = "imap.mycompany.us"
MySession..Name = "user"
MySession..Password = EDT_Password

EmailStartSession(MySession)

FOR EACH EmailMessage NOT READ OF MySession
Trace(EmailMessage..Subject)
END
Remarks

Properties specific to the description of emailIMAPSession variables

The following properties can be used to handle an emailIMAPSession variable:
NameType usedEffect
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 (for example, imap.free.fr). 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 IMAP protocol.
  • optionSSL: Connection by using the IMAP protocol inside an SSL channel. This option guarantees the confidentiality of exchange but it must be supported by the server.
LinuxAndroidAndroid Widget iPhone/iPadWindows MobileUniversal Windows 10 App This property is not supported.
Windows MobileUniversal Windows 10 App This property is not supported.
PortIntegerIdentifies the port used for the IMAP protocol.
This property is set to 143 by default (standard port number of the IMAP protocol).

Note: These properties can be used via one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Functions that use the emailIMAPSession variables

Versions 11 and later
EmailAddFolder
New in version 11
EmailAddFolder
EmailAddFolder
Adds a folder into the messaging software (Outlook, messaging software using the IMAP protocol (Internet Message Access Protocol), ...).
Versions 11 and later
EmailChangeFolder
New in version 11
EmailChangeFolder
EmailChangeFolder
Modifies the current folder in the messaging software (Outlook, messaging software using the IMAP protocol, ...).
Versions 15 and later
EmailChangeStatus
New in version 15
EmailChangeStatus
EmailChangeStatus
Changes the status of an email on a messaging server.
Versions 09 and later
EmailCloseSession
New in version 09
EmailCloseSession
EmailCloseSession
Closes a session for email management according to the selected mode (SMTP/POP3, IMAP, MS Exchange, Pocket Outlook or Lotus Notes).
Versions 17 and later
EmailCopy
New in version 17
EmailCopy
EmailCopy
Copies an email found in a directory to another directory of an IMAP server.
Versions 11 and later
EmailCurrentFolder
New in version 11
EmailCurrentFolder
EmailCurrentFolder
Returns the name of current folder in the messaging software (Outlook, messaging software using the IMAP protocol (Internet Message Access Protocol), ...).
Versions 09 and later
EmailDeleteMessage
New in version 09
EmailDeleteMessage
EmailDeleteMessage
Used to delete the current email according to the current protocol (POP3, IMAP, MS Exchange, Pocket Outlook, Lotus Notes or Outlook messaging).
Versions 20 and later
EmailExpunge
New in version 20
EmailExpunge
EmailExpunge
Destroys all the deleted emails marked as deleted ("Deleted" status) from the current folder of IMAP session.
Versions 15 and later
EmailGetAll
New in version 15
EmailGetAll
EmailGetAll
Retrieves all the emails found on a server.
Versions 20 and later
EmailGetIndicator
New in version 20
EmailGetIndicator
EmailGetIndicator
Retrieves the indicators defined on an email of IMAP session.
Versions 11 and later
EmailListFolder
New in version 11
EmailListFolder
EmailListFolder
Returns the list of folders:
  • found in the Outlook messaging software.
  • for an IMAP session.
Versions 09 and later
EmailMessageLength
New in version 09
EmailMessageLength
EmailMessageLength
Calculates the size of specified message (without loading the message).
Versions 09 and later
EmailNbMessage
New in version 09
EmailNbMessage
EmailNbMessage
Returns the number of incoming messages currently found:
  • on the email server (POP3 protocol only).
  • in the Outlook messaging software.
Versions 09 and later
EmailReadFirst
New in version 09
EmailReadFirst
EmailReadFirst
Reads the first incoming email according to the protocol used (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
Versions 09 and later
EmailReadFirstHeader
New in version 09
EmailReadFirstHeader
EmailReadFirstHeader
Reads the header of the first incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
Versions 09 and later
EmailReadLast
New in version 09
EmailReadLast
EmailReadLast
Reads the last incoming email according to the protocol used (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
Versions 09 and later
EmailReadLastHeader
New in version 09
EmailReadLastHeader
EmailReadLastHeader
Reads the header of last incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
Versions 09 and later
EmailReadMessage
New in version 09
EmailReadMessage
EmailReadMessage
Reads an incoming according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
Versions 09 and later
EmailReadMessageHeader
New in version 09
EmailReadMessageHeader
EmailReadMessageHeader
Reads the header of an incoming email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
Versions 09 and later
EmailReadNext
New in version 09
EmailReadNext
EmailReadNext
Reads the incoming email found after the current email according to the protocol (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
Versions 09 and later
EmailReadNextHeader
New in version 09
EmailReadNextHeader
EmailReadNextHeader
Reads the header of the email found after the current email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
Versions 09 and later
EmailReadPrevious
New in version 09
EmailReadPrevious
EmailReadPrevious
Reads the email found before the current email according to the protocol used (POP3 or IMAP, MS Exchange, Lotus Notes or Outlook).
Versions 09 and later
EmailReadPreviousHeader
New in version 09
EmailReadPreviousHeader
EmailReadPreviousHeader
Reads the header of the email found before the current email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
Versions 11 and later
EmailRemoveFolder
New in version 11
EmailRemoveFolder
EmailRemoveFolder
Deletes a folder from the Outlook messaging software or from an IMAP server.
Versions 11 and later
EmailSeekFirst
New in version 11
EmailSeekFirst
EmailSeekFirst
Finds one or more emails according to the criteria specified in the messaging software (Outlook, messaging software using the IMAP protocol, ...).
Versions 09 and later
EmailStartSession
New in version 09
EmailStartSession
EmailStartSession
Starts a session for email management according to the selected management mode (POP3, SMTP, IMAP, MS Exchange or Pocket Outlook).
AndroidAndroid Widget

Limits

This type of variable is available for the devices equipped with ARM processors. A fatal error occurs if this type of variable is used with devices not equipped with ARM processors (x86, mips, ...). This type of variable is available for the devices equipped with ARM processors or using an ARM emulation. Otherwise (and on the Samsung Galaxy Tab 3 tablet), a fatal error will occur.
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.
Minimum required version
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment