PidTagDisplayTo Canonical Property

Applies to: Outlook 2013 | Outlook 2016

Contains a list of the display names of the primary (To) message recipients, separated by semicolons (;).

Associated properties:
PR_DISPLAY_TO, PR_DISPLAY_TO_A, PR_DISPLAY_TO_W
Identifier:
0x0E04
Data type:
PT_STRING8, PT_UNICODE
Area:
Message

Remarks

The message store computes these properties on message objects by using the IMessage::ModifyRecipients method. The message store also maintains these properties so that it always reflects the last saved state of a message. The value is synchronized at the time of every call to the IMAPIProp::SaveChanges method.

If a message has no primary recipients, the message store should respond to an IMAPIProp::GetProps call with a return value of S_OK and an empty string for PR_DISPLAY_TO.

Because of the possible need for localization, MAPI provides these guidelines for all recipient names:

  • All names should be able to be localized.

  • The semicolon should be the character that is used to separate names in the PR_DISPLAY_BCC (PidTagDisplayBcc), PR_DISPLAY_CC (PidTagDisplayCc), and PR_DISPLAY_TO properties. Semicolons are not permitted within recipient names in MAPI.

  • Clients should translate each semicolon encountered in the PR_DISPLAY_TO and related properties to a localized separator character before making the information visible in the user interface.

  • When forwarding messages, clients do not need to translate the separator characters on the primary recipient line.

Protocol specifications

[MS-OXOMSG]

Specifies the properties and operations that are permissible for email message objects.

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