mailSession object – PB Docs 2022

ClassDefinition

PowerObject

An object of type PowerObject containing
information about the class definition of the object or
control

MessageID[ ]

String

Contains the IDs of the messages in a user’s mail
inbox

SessionID

Long

Contains the handle of the current messaging
session

Constructor

When the object is created

Destructor

When the object is destroyed

ClassName

String

Returns the class of the object

GetContextService

Integer

Creates a reference to a context-specific instance
of the specified service

GetParent

PowerObject

Returns a reference to the name of the parent
object

mailAddress

mailReturnCode

Updates the mailRecipient array for a mail
message

mailDeleteMessage

mailReturnCode

Deletes a mail message from the user’s electronic
mail inbox

mailGetMessages

mailReturnCode

Populates the MessageID array of a mailSession
object with the message IDs in the user’s inbox

mailHandle

UnsignedLong

Obtains the handle of a mailSession
object

mailLogoff

mailReturnCode

Ends the mail session, breaking the connection
between the PowerBuilder application and mail

mailLogon

mailReturnCode

Establishes a mail session for the PowerBuilder
application

mailReadMessage

mailReturnCode

Opens a mail message whose ID is stored in the mail
session’s message array

mailRecipientDetails

mailReturnCode

Displays a dialog box with the specified
recipient’s address information

mailResolveRecipient

mailReturnCode

Obtains a valid electronic mail address based on a
partial or full user name and optionally updates information in
the system’s address list if the user has privileges to do
so

mailSaveMessage

mailReturnCode

Creates a new message in the user’s inbox or
replaces an existing message

mailSend

mailReturnCode

Sends a mail message

PostEvent

Integer

Adds an event to the end of the message queue for
the object

TriggerEvent

Integer

Triggers a specified event in the object and
executes the script for the event

TypeOf

Object

Returns the type of the object