IMAPISession::MessageOptions

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Displays a dialog box that contains option properties for a particular address type and message.

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

Parameters

  • ulUIParam
    [in] A handle to the parent window of the dialog box.

  • ulFlags
    [in] Reserved; must be NULL.

  • lpszAdrType
    [in] A pointer to the address type that specifies which option properties should be displayed; otherwise, NULL, indicating that all message option properties for all transport providers should be displayed.

  • lpMessage
    [in] A pointer to the message that specifies which option properties should be displayed.

Return Value

  • 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 displays a dialog box that specifies properties for a particular message and address type. These properties are under the control of the transport provider that handles the address type. Users can change the properties, but these changes do not take effect until the client calls the message's IMAPIProp::SaveChanges method.

Users can change option properties that apply to the following:

  • A particular message and address type.

  • All messages for a particular address type.

Changes that were 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 how to work with message option properties, see Message and Recipient Options.

MFCMAPI Reference

For MFCMAPI sample code, see the following table.

File

Function

Comment

FolderDlg.cpp

CFolderDlg::OnGetMessageOptions

MFCMAPI uses the IMAPISession::MessageOptions method to display the message options dialog box for the specified address type for each of the selected messages.

See Also

Reference

IMAPIProp::SaveChanges

IMAPISession : IUnknown

Concepts

MFCMAPI as a Code Sample

Message and Recipient Options