mailRecipientDetails
PowerScript function
Description
Displays a dialog box with the specified recipient’s address
information.
Applies to
mailSession object
Syntax
|
1 |
mailsession.mailRecipientDetails ( mailrecipient {, allowupdates } ) |
|
Argument |
Description |
|---|---|
|
mailsession |
A mailSession identifying the session in which you want to |
|
mailrecipient |
A mailRecipient structure containing valid address |
|
allowupdates (optional) |
A boolean indicating whether updates to the recipient’s allowupdates is always true for Extended MAPI. |
Return value
mailReturnCode. Returns one of the following values:
mailReturnSuccess!
mailReturnFailure!
mailReturnInsufficientMemory!
mailReturnUnknownRecipient!
mailReturnUserAbort!
If any argument’s value is null, mailRecipientDetails returns
null.
Usage
The effect of setting allowupdates to true depends on the mail
system and the user’s privileges.
Before calling mail functions, you must declare and create a
mailSession object and call mailLogon to establish a mail session.
Examples
This example gets the message IDs from the user’s inbox and reads
the first message. It then calls mailRecipientDetails to display address
information for the first recipient. Recipient is an array of structures
and a property of mailMessage. Each array element is one of the message’s
recipients. The example does not check how many values there are in the
message ID or recipient arrays and it assumes that the application has
already created a mailSession object and logged on:
|
1 2 3 4 5 6 7 8 |
mailMessage msg integer n long c_row mSes.mailGetMessages() mSes.mailReadMessage(mSes.MessageID[1], & msg, mailEnvelopeOnly!, FALSE ) mSes.mailRecipientDetails(msg.Recipient[1]) |
See also