:GetExportOptions()
Class
Syntax
:GetExportOptions( [hMessage] ) -> nOptions
Parameters
|
|
hMessage |
Optional. Handle of the message to act on. Provided during :CreateMessage() operation |
Return
A numeric value indicating a value listed below.
|
|
Value |
Description |
|
|
-1 |
An Error occurred during the last operation. See :nErr and :cErr for more information. |
|
|
0 |
Received and Return-Path headers are not exported. The order of the headers in an exported message is undefined. This is the default state. |
|
|
1 |
Export all headers, including the Trace Information headers such as Received and Return-Path. |
|
|
2 |
Export headers in the order in which they were imported. If this option is used, set this property before importing the message. |
|
|
3 |
Both 1 and 2 (above) are set. |
Description
The :GetExportOptions() method returns a bitmask that describes current message export options.
By default, the Received and Return-Path headers are not exported. In addition, the order of the headers in an exported message is undefined. This is reasonable behavior for most mail clients, but may not be appropriate for applications the implement or extend a mail server, and in which the MailMessage library is used.
See Also
:ExportMessage(), :ImportMessage(), :SetExportOptions()