mailHandle

Description

Obtains the handle of a mailSession object.

Applies to

mailSession object

Syntax

mailsession.mailHandle ( )

Argument

Description

mailsession

A mailSession object identifying the session for which you want the handle


Return value

UnsignedLong.

Returns the internal handle of the mail session object. If mailsession is null, mailHandle displays an error message.

Usage

After you have logged on, your mailSession has a valid handle. You can use that handle to call external mail functions. MAPI has additional functions that PowerBuilder does not implement directly.

Before calling mail functions, you must declare and create a mailSession object and call mailLogon to establish a mail session.

Examples

This statement returns the handle of the current mail session:

current_session. mailHandle()