PidTagMessageRecipients Canonical Property

Applies to: Outlook 2013 | Outlook 2016

Contains a table of restrictions that can be applied to a contents table to find all messages that contain recipient subobjects that meet the restrictions.

Property Value
Associated properties:
PR_MESSAGE_RECIPIENTS
Identifier:
0x0E12
Data type:
PT_OBJECT
Area:
General messaging

Remarks

This property can be excluded in IMAPIProp::CopyTo operations or included in IMAPIProp::CopyProps operations. As a property of type PT_OBJECT, it cannot be successfully retrieved by the IMAPIProp::GetProps method. Its contents should be accessed by the IMAPIProp::OpenProperty method, requesting the IID_IMAPITable interface identifier. Service providers must report it to the IMAPIProp::GetPropList method if it is set, but may optionally report it or not if it is not set.

To retrieve table contents, a client application should call the IMessage::GetRecipientTable method.

This property can be used for subobject restriction by specifying it in the SSubRestriction structure. This enables a client to limit the view of a container to messages with recipients meeting given criteria. A message qualifies for viewing if at least one row in its recipient table, that is, one recipient satisfies the subobject restriction.

Note Using subobject restriction results is the equivalent of an IMAPISession::OpenEntry call on every message in the table. Depending on the client application and the number of messages to be searched, it can affect performance.

The PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments) property and this property are similar in usage. Several MAPI properties provide access to tables:

Property Table
PR_CONTAINER_CONTENTS (PidTagContainerContents)
Contents table
PR_CONTAINER_HIERARCHY (PidTagContainerHierarchy)
Hierarchy table
PR_FOLDER_ASSOCIATED_CONTENTS (PidTagFolderAssociatedContents)
Associated contents table
PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments)
Attachment table
PR_MESSAGE_RECIPIENTS
Recipient table

Protocol specifications

[MS-OXPROPS]

Provides references to related Exchange Server protocol specifications.

[MS-OXCFXICS]

Handles the order and flow for data transfers between a client and server.

[MS-OXCICAL]

Converts between IETF RFC2445, RFC2446, and RFC2447, and appointment and meeting objects.

[MS-OXCSPAM]

Enables the handling of allow/block lists and the determination of junk email messages.

[MS-OXTNEF]

Encodes and decodes message and attachment objects to an efficient stream representation.

Header files

Mapidefs.h

Provides data type definitions.

Mapitags.h

Contains definitions of properties listed as alternate names.

See also

MAPI Properties

MAPI Canonical Properties

Mapping Canonical Property Names to MAPI Names

Mapping MAPI Names to Canonical Property Names