IMAP protocol

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | Français

Overview of IMAP protocol
Using the IMAP protocol
Receiving messages by using the IMAP protocol
Specific features in WINDEV
Notes
Connection to the service provider

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

IMAP protocol

Overview of IMAP protocol

The IMAP protocol is a standard protocol for managing emails. Unlike the POP3 protocol, the principle for using the IMAP protocol consists in leaving the messages on the messaging server in order to read them from several clients. It includes a specified indicator used to find out whether a message was read. Several messaging servers support both the IMAP protocol and the POP3 protocol.

Notes:

The SSL connections are supported. The SSL connections are supported.
See Overview of POP3/SMTP protocols for more details.

Versions 21 and later

This feature is now available in Universal Windows 10 App mode.

New in version 21

This feature is now available in Universal Windows 10 App mode.

Using the IMAP protocol

Receiving messages by using the IMAP protocol

To receive emails by using the IMAP protocol

Start an IMAP session by using an emailIMAPSession variable and EmailStartSession.
Example for starting a session by using an emailIMAPSession variable:

// Start the messaging session
MySession is EmailIMAPSession
MySession..ServerAddress = "pop.mycompany.us"
MySession..Name = "user"
MySession..Password = "secret"
EmailStartSession(MySession)
Read the messages on the messaging server:
- with EmailGetAll,
- with a loop such as:
  Example that is using an Email variable:
  
  MyMessage is Email
  EmailReadFirst(MySession,MyMessage)
  WHILE NOT MyMessage..Out
  // Place the process of the message read...
  ...
  
  EmailReadNext(MySession, MyMessage)
  END
  
  Example that is using the Email structure:
  
  EmailReadFirst(MySession)
  WHILE NOT Email.Out
          // Place the process of the message read...
          ...
  
          EmailReadNext(MySession)
  END
- or with a loop such as (the "NOT READ" keywords are optional and they allow you to browse only the unread messages or all the messages):
  
  MyMessage is Email
  FOR EACH MyMessage NOT READ OF MySession
  // Place the process of the message read...
  ...
  END
Close the IMAP session with EmailCloseSession.

Specific features in WINDEV

You may have to establish a connection by modem before starting the IMAP session.

Notes

Connection to the service provider

An Internet connection is required to manage the emails. Several cases may occur:

The user is using a modem to connect to Internet: NetOpenRemoteAccess is used to establish the connection to Internet.
The user is using a direct connection to Internet (cable or ADSL): no specific operation is required.

Related Examples:

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.