IMAPISession::QueryDefaultMessageOpt

The IMAPISession::QueryDefaultMessageOpt method retrieves the message option properties for a particular address type.

Quick Info

See IMAPISession : IUnknown.

HRESULT QueryDefaultMessageOpt(
  LPTSTR lpszAdrType,            
  ULONG ulFlags,                 
  ULONG FAR * lpcValues,         
  LPSPropValue FAR * lppOptions  
);
 

Parameters

lpszAdrType

[in] Pointer to an address type.

ulFlags

[in] Bitmask of flags that controls the format of the string property values pointed to by lppOptions. The following flag can be set:

MAPI_UNICODE

The property values should be in Unicode format. If the MAPI_UNICODE flag is not set, the property values should be in ANSI format.

lpcValues

[out] Pointer to a count of property values pointed to by the lppOptions parameter.

lppOptions

[out] Pointer to a pointer to an array of SPropValue structures describing message option properties.

Return Values

S_OK

The message option properties were successfully returned.

Remarks

The IMAPISession::QueryDefaultMessageOpt method retrieves the one or more message option properties that a transport provider supports for the address type pointed to by the lpszAdrType parameter. Message option properties control a message's behavior after it is submitted to the transport provider; they are part of the message envelope, not its content.

The property value array pointed to by lppOptions includes the property tags and values for each of the message option properties.