EmailCloseSession (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Managing emails

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

EmailCloseSession (Function)

In french: EmailFermeSession

Closes a session for email management according to the selected mode:

emails managed by the SMTP/POP3/IMAP protocol: the EmailCloseSession function closes the SMTP/POP3/IMAP session.. If a POP3 session, an SMTP session and an IMAP session were started, all the sessions are closed.
emails managed via MS Exchange client (Outlook): the EmailCloseSession function closes the MS Exchange session.
Emails managed with Lotus Notes: the EmailCloseSession function is used to close a session with the Lotus Notes messaging software..

An email session that is not ended will be automatically closed at the end of the WINDEV or WINDEV Mobile program or at the end of the WEBDEV session.

Only the POP3/SMTP sessions are supported.

Example

// Start an email session via the SMTP/POP3 protocol
IF EmailStartSession(USER, PASSWORD, "pop3.providername.com", ...
"smtp.providername.com") = True THEN
UserName = USER
ELSE
UserName = ""
Error("Unable to establish the connection")
END
// If a session is started, close this session
IF UserName <> "" THEN
EmailCloseSession(UserName)
UserName = ""
END

Syntax

Close an e-mail session using the POP3, SMTP or IMAP protocol Hide the details

EmailCloseSession(<Session>)

<Session>: Character string, or emailPOP3Session, emailSMTPSession or emailIMAPSession variable

Identifies the user session. Corresponds to:
the username that was used to start the email session (EmailStartSession, EmailStartSMTPSession or EmailStartPOP3Session).
a variable of type emailPOP3Session.
a variable of type emailSMTPSession.
a variable of type emailIMAPSession.

Closing an MS Exchange (Outlook) or Lotus Notes email session Hide the details

EmailCloseSession(<Session>)

<Session>: Integer, or emailOutlookSession or emailNotesSession variable

Identifier of the current email session. This value can be:
an integer returned by EmailStartSession or EmailStartNotesSession.
a variable of type emailOutlookSession.
a variable of type emailNotesSession.

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.

Unit examples (WINDEV): The POP3 Email functions

[ + ] Using the Email functions to manage the POP3 protocol.
This protocol is used to retrieve emails from a server.

Complete examples (WEBDEV): WW_CMS

[ + ] This example is an example of CMS (Content Management System).
This is a site for content management, typically a site for displaying some articles.

This example is divided into 2 parts:
- An AWP part for the part that must be referenced
- A WEBDEV part for the management part

Note:
In order for some features of the example to operate (sending emails for example), the parameters must be modified in order to adapt them to your configuration.
These parameters are stored as constants defined in the code of the project.

Component: wd300com.dll