IMAPISupport::ExpandRecips

The IMAPISupport::ExpandRecips method completes a message's recipient list, expanding particular distribution lists.

Quick Info

See IMAPISupport : IUnknown.

HRESULT ExpandRecips(
  LPMESSAGE lpMessage,   
  ULONG FAR * lpulFlags  
);

Parameters

lpMessage

[in] Pointer to the message with the recipient list to be processed.

lpulFlags

[out] Pointer to a bitmask of flags that controls the type of processing that occurs. The following flags can be set:

NEEDS_PREPROCESSING: The message needs to be preprocessed before it is sent.
NEEDS_SPOOLER: The MAPI spooler must send the message rather than the transport provider to which the caller is tightly coupled.

Return Values

S_OK: The message's recipient list was successfully processed.

Remarks

The IMAPISupport::ExpandRecips method is implemented for message store provider support objects. Message store providers call ExpandRecips to prompt MAPI to perform the following tasks:

Expand certain personal distribution lists to their component recipients.
Replace all display names that have been altered with the original names.
Mark any duplicate entries.
Resolve all one-off addresses.
Check if the message needs preprocessing and, if it does, set the flag pointed to by lpulFlags to NEEDS_PREPROCESSING.

ExpandRecips expands any distribution lists that have the messaging address type of MAPIPDL.

Notes to Callers

Always call ExpandRecips as part of your message processing. Make a call to ExpandRecips one of the first calls in your IMessage::SubmitMessage implementation.