IMAPISession::MessageOptions

The IMAPISession::MessageOptions method displays a dialog box showing option properties for a particular address type and message.

Quick Info

See IMAPISession : IUnknown.

HRESULT MessageOptions(
  ULONG ulUIParam,     
  ULONG ulFlags,       
  LPTSTR lpszAdrType,  
  LPMESSAGE lpMessage  
);
 

Parameters

ulUIParam

[in] Handle of the parent window for the dialog box.

ulFlags

[in] Bitmask of flags that controls the format of the message option properties. The following flag can be set:

MAPI_UNICODE

The message option properties are in Unicode format. If the MAPI_UNICODE flag is not set, the message option properties are in ANSI format.

lpszAdrType

[in] Pointer to the address type for which option properties should be displayed, or NULL, indicating that all message option properties for all transport providers should be displayed.

lpMessage

[in] Pointer to the message for which option properties should be displayed.

Return Values

S_OK

The dialog box was successfully displayed.

MAPI_E_NOT_FOUND

No options were registered for the message and address type.

Remarks

The IMAPISession::MessageOptions method presents a dialog box displaying properties that relate to a particular message and addess type. These properties are under the control of the transport provider handling the address type. Users can make changes to the properties, but these changes do not take affect until the client calls the message's IMAPIProp::SaveChanges method.

Users can make changes to option properties that apply to:

• A particular message and address type.
• All messages for a particular address type.

Changes made to the option properties for a particular message and address type do not affect the option properties that apply to all messages.

For more information about working with message option properties, see Message and Recipient Options.