Class MapiAddressBook

Represents an Address Book object.

Inheritance

object

AbstractReadOnlyMapiItem

AbstractMapiItem

MapiAddressBook

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DRIT.Mail.Mapi

Assembly: DRIT.Mail.dll

Syntax

public class MapiAddressBook : AbstractMapiItem

Remarks

MS-OXOABK

Properties

Account

Gets or sets an Address Book object's alias, which is an alternative name by which the object can be identified.

Declaration

public string Account { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.20 PidTagAccount

AddressBookDeliveryContentLength

Gets or sets the maximum size of a message that a recipient can receive.

Declaration

public int? AddressBookDeliveryContentLength { get; set; }

Property Value

Type	Description
int?

Remarks

2.2.3.27 PidTagAddressBookDeliveryContentLength

AddressBookDisplayNamePrintable

Gets or sets a a displayable form of an Address Book object that can be rendered in the client user's own code page.

Declaration

public string AddressBookDisplayNamePrintable { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.7 PidTagAddressBookDisplayNamePrintable

AddressBookDisplayTypeExtended

Gets or sets a value that is limited to Recipient objects.

Declaration

public int? AddressBookDisplayTypeExtended { get; set; }

Property Value

Type	Description
int?

Remarks

The AddressBookDisplayTypeExtended property should be present on objects on an NSPI server or an offline address book (OAB).

2.2.3.35 PidTagAddressBookDisplayTypeExtended

AddressBookDistributionListExternalMemberCount

Gets or sets the number of external recipients (2) in a specified distribution list.

Declaration

public int? AddressBookDistributionListExternalMemberCount { get; set; }

Property Value

Type	Description
int?

Remarks

This property is calculated during OAB generation and is not available on the NSPI server.

2.2.3.30 PidTagAddressBookDistributionListExternalMemberCount

AddressBookDistributionListMemberCount

Gets or sets the total number of recipients in a specified distribution list.

Declaration

public int? AddressBookDistributionListMemberCount { get; set; }

Property Value

Type	Description
int?

Remarks

This value includes the members of all the distribution lists that are members of the specified distribution list. This property is calculated during OAB generation and is not available on the NSPI server.

2.2.3.29 PidTagAddressBookDistributionListMemberCount

AddressBookHomeMessageDatabase

Gets or sets the DN (1) of a mail user.

Declaration

public string AddressBookHomeMessageDatabase { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.37 PidTagAddressBookHomeMessageDatabase

AddressBookManagerDistinguishedName

Gets or sets the the DN of a mail user's manager.

Declaration

public string AddressBookManagerDistinguishedName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.9 PidTagAddressBookManagerDistinguishedName

AddressBookModerationEnabled

Gets or sets whether moderation is enabled for the mail user or distribution list.

Declaration

public bool? AddressBookModerationEnabled { get; set; }

Property Value

Type	Description
bool?

Remarks

2.2.3.28 PidTagAddressBookModerationEnabled

AddressBookNetworkAddress

Gets or sets the Address Book object of a mailbox server that contains a list of names by which a server is known to the various transports in use by the network.

Declaration

public string[] AddressBookNetworkAddress { get; set; }

Property Value

Type	Description
string[]

Remarks

2.2.4.38 PidTagAddressBookNetworkAddress

AddressBookObjectDistinguishedName

Gets or sets the DN of an Address Book object in DN format.

Declaration

public string AddressBookObjectDistinguishedName { get; set; }

Property Value

Type	Description
string

Remarks

Its value, if present, MUST match the value for the PidTagEmailAddress property.

2.2.3.13 PidTagAddressBookObjectDistinguishedName

AddressBookObjectGuid

Gets or sets a GUID that uniquely identifies an Address Book object.

Declaration

public byte[] AddressBookObjectGuid { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.3.25 PidTagAddressBookObjectGuid

AddressBookOrganizationalUnitRootDistinguishedName

Gets or sets the DN (1) of the Organization object of the mail user's organization.

Declaration

public string AddressBookOrganizationalUnitRootDistinguishedName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.39 PidTagAddressBookOrganizationalUnitRootDistinguishedName

AddressBookPhoneticCompanyName

Gets or sets the phonetic representation of the CompanyName property.

Declaration

public string AddressBookPhoneticCompanyName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.12 PidTagAddressBookPhoneticCompanyName

AddressBookPhoneticDepartmentName

Gets or sets the phonetic representation of the DepartmentName property.

Declaration

public string AddressBookPhoneticDepartmentName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.13 PidTagAddressBookPhoneticDepartmentName

AddressBookPhoneticDisplayName

Gets or sets the phonetic representation of the PidTagDisplayName property.

Declaration

public string AddressBookPhoneticDisplayName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.9 PidTagAddressBookPhoneticDisplayName

AddressBookPhoneticGivenName

Gets or sets the phonetic representation of the PidTagGivenName property.

Declaration

public string AddressBookPhoneticGivenName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.10 PidTagAddressBookPhoneticGivenName

AddressBookPhoneticSurname

Gets or sets the phonetic representation of the Surname property.

Declaration

public string AddressBookPhoneticSurname { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.11 PidTagAddressBookPhoneticSurname

AddressBookProxyAddresses

Gets or sets alternate e-mail addresses for an Address Book object.

Declaration

public string[] AddressBookProxyAddresses { get; set; }

Property Value

Type	Description
string[]

Remarks

2.2.3.23 PidTagAddressBookProxyAddresses

AddressBookSenderHintTranslations

Gets or sets the locale ID and translations of the default mail tip.

Declaration

public string[] AddressBookSenderHintTranslations { get; set; }

Property Value

Type	Description
string[]

Remarks

An example of this value is "enUS:Hello" or "es:Hola".

2.2.3.26 PidTagAddressBookSenderHintTranslations

AddressBookSeniorityIndex

Gets or sets a signed integer that specifies the seniority order of Address Book objects that represent members of a department and are referenced by a Department object or departmental group, with larger values specifying members that are more senior.

Declaration

public int? AddressBookSeniorityIndex { get; set; }

Property Value

Type	Description
int?

Remarks

2.2.3.24 PidTagAddressBookSeniorityIndex

AddressBookTargetAddress

Gets or sets the foreign system e-mail address of an Address Book object.

Declaration

public string AddressBookTargetAddress { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.22 PidTagAddressBookTargetAddress

AddressBookX509Certificate

Gets or sets ASN.1 DER encoded X.509 certificates for a mail user.

Declaration

public byte[][] AddressBookX509Certificate { get; set; }

Property Value

Type	Description
byte[][]

Remarks

Each binary value MUST be an ASN.1 DER encoded X.509 certificate, as specified in [RFC3280].

2.2.4.35 PidTagAddressBookX509Certificate

AddressType

Gets or sets an Address Book object's e-mail address type.

Declaration

public string AddressType { get; set; }

Property Value

Type	Description
string

Remarks

It MUST have the value "EX" for all objects on an NSPI server. The AddressType property is not present on objects in an offline address book (OAB).

2.2.3.13 PidTagAddressType

Assistant

Gets or sets the name of a mail user's administrative assistant.

Declaration

public string Assistant { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.8 PidTagAssistant

AssistantTelephoneNumber

Gets or sets the telephone number of a mail user's administrative assistant.

Declaration

public string AssistantTelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.31 PidTagAssistantTelephoneNumber

Business2TelephoneNumber

Gets or sets a secondary telephone number at a mail user's place of business.

Declaration

public string Business2TelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.23 PidTagBusiness2TelephoneNumber

Business2TelephoneNumbers

Gets or sets secondary telephone numbers at a mail user's place of business.

Declaration

public string[] Business2TelephoneNumbers { get; set; }

Property Value

Type	Description
string[]

Remarks

2.2.4.24 PidTagBusiness2TelephoneNumbers

BusinessTelephoneNumber

Gets or sets the primary telephone number of a mail user's place of business.

Declaration

public string BusinessTelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.21 PidTagBusinessTelephoneNumber

Comment

Gets or sets a comment about the purpose or content of an Address Book object.

Declaration

public string Comment { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.31 PidTagComment

CompanyName

Gets or sets a mail user's company name.

Declaration

public string CompanyName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.7 PidTagCompanyName

Country

Gets or sets the name of a mail user's country/region.

Declaration

public string Country { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.19 PidTagCountry

DepartmentName

Gets or sets a name for the department in which a mail user works.

Declaration

public string DepartmentName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.6 PidTagDepartmentName

DisplayName

Gets or sets a displayable form of an Address Book object.

Declaration

public override string DisplayName { get; set; }

Property Value

Type	Description
string

Overrides

AbstractMapiItem.DisplayName

Remarks

When the Address Book object is a mail user, the DisplayName property is the full name of the mail user. When the object is a distribution list, the value of the DisplayName property is the name of the distribution list that would be displayed when addressing messages to that distribution list. When the object is a Department object, the PidTagDisplayName property value contains the name of that department. When the object is any other Address Book object, the value of the PidTagDisplayName property is the displayable name of that object.

MS-OXOABK 2.2.3.1 PidTagDisplayName

DisplayType

Gets or sets a value that indicates how to display an Address Book object in a table or as an addressee on a message.

Declaration

public int? DisplayType { get; set; }

Property Value

Type	Description
int?

Remarks

2.2.3.11 PidTagDisplayType

DisplayTypeEx

Gets or sets a value that indicates how to display an Address Book object in a table or as a recipient on a message.

Declaration

public int? DisplayTypeEx { get; set; }

Property Value

Type	Description
int?

Remarks

2.2.3.12 PidTagDisplayTypeEx

EmailAddress

Gets or sets an Address Book object's e-mail address type.

Declaration

public string EmailAddress { get; set; }

Property Value

Type	Description
string

Remarks

It MUST have the value "EX" for all objects on an NSPI server. The AddressType property is not present on objects in an offline address book (OAB).

2.2.3.13 PidTagAddressType

EntryId

Gets or sets an entry ID that identifies an Address Book object on an NSPI server.

Declaration

public byte[] EntryId { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.3.2 PidTagEntryId

GivenName

Gets or sets a mail user's given name.

Declaration

public string GivenName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.2 PidTagGivenName

Home2TelephoneNumber

Gets or sets a secondary telephone number at a mail user's home.

Declaration

public string Home2TelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.25 PidTagHome2TelephoneNumber

Home2TelephoneNumbers

Gets or sets secondary telephone numbers at a mail user's home.

Declaration

public string[] Home2TelephoneNumbers { get; set; }

Property Value

Type	Description
string[]

Remarks

2.2.4.26 PidTagHome2TelephoneNumbers

HomeAddressStreet

Gets or sets a mail user's home street address.

Declaration

public string HomeAddressStreet { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.20 PidTagHomeAddressStreet

HomeTelephoneNumber

Gets or sets the primary telephone number of a mail user's home.

Declaration

public string HomeTelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.22 PidTagHomeTelephoneNumber

InitialDetailsPane

Gets or sets a value that indicates which page of a display template to display first.

Declaration

public int? InitialDetailsPane { get; set; }

Property Value

Type	Description
int?

Remarks

This value MUST be present on all Address Book objects on an NSPI server, and it MUST have the value 0 (zero).

2.2.3.33 PidTagInitialDetailsPane

Initials

Gets or sets the initials for parts of a mail user's full name.

Declaration

public string Initials { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.3 PidTagInitials

InstanceKey

Gets or sets a value that identifies an object on an NSPI server.

Declaration

public byte[] InstanceKey { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.3.6 PidTagInstanceKey

Keyword

Gets or sets a keyword that identifies the mail user to the mail user's system administrator.

Declaration

public string Keyword { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.32 PidTagKeyword

Locality

Gets or sets the name of a mail user's locality, such as the town or city.

Declaration

public string Locality { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.16 PidTagLocality

MappingSignature

Gets or sets a value that must be present on all Address Book objects on an NSPI server and MUST contain the following 16 bytes: 0xDC, 0xA7, 0x40, 0xC8, 0xC0, 0x42, 0x10, 0x1A, 0xB4, 0xB9, 0x08, 0x00, 0x2B, 0x2F, 0xE1, 0x82.

Declaration

public byte[] MappingSignature { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.3.32 PidTagMappingSignature

MessageHandlingSystemCommonName

Gets or sets the common name of a messaging user for use in a message header.

Declaration

public string MessageHandlingSystemCommonName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.33 PidTagMessageHandlingSystemCommonName

MobileTelephoneNumber

Gets or sets a mail user's mobile telephone number.

Declaration

public string MobileTelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.27 PidTagMobileTelephoneNumber

ObjectType

Gets or sets a value that specifies the type of an object.

Declaration

public override int? ObjectType { get; set; }

Property Value

Type	Description
int?

Overrides

AbstractMapiItem.ObjectType

Remarks

2.2.3.10 PidTagObjectType

OfficeLocation

Gets or sets a mail user's office location.

Declaration

public string OfficeLocation { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.5 PidTagOfficeLocation

OriginalDisplayName

Gets or sets the original display name for an entry copied from an address book to a personal address book or other writable address book.

Declaration

public string OriginalDisplayName { get; set; }

Property Value

Type	Description
string

Remarks

Reference: Outlook 2013 MAPI Reference > Reference > Properties > PidTagOriginalDisplayName Canonical Property

PagerTelephoneNumber

Gets or sets a mail user's pager telephone number.

Declaration

public string PagerTelephoneNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.28 PidTagPagerTelephoneNumber

PostOfficeBox

Gets or sets the number or identifier of a mail user's post office box.

Declaration

public string[] PostOfficeBox { get; set; }

Property Value

Type	Description
string[]

Remarks

2.2.4.15 PidTagPostOfficeBox

PostalCode

Gets or sets the postal code for a mail user's postal address.

Declaration

public string PostalCode { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.18 PidTagPostalCode

PrimaryFaxNumber

Gets or sets the telephone number of a mail user's primary fax machine.

Declaration

public string PrimaryFaxNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.29 PidTagPrimaryFaxNumber

RecordKey

Gets or sets a unique binary-comparable identifier for an Address Book object.

Declaration

public override byte[] RecordKey { get; set; }

Property Value

Type	Description
byte[]

Overrides

AbstractMapiItem.RecordKey

Remarks

2.2.3.4 PidTagRecordKey

SearchKey

Gets or sets a value that is formed by concatenating the ASCII string "EX: " followed by the DN for the object converted to all uppercase, followed by a zero-byte value. This value MUST be present for all Address Book objects on an NSPI server and MUST be in the aforementioned format.

Declaration

public override byte[] SearchKey { get; set; }

Property Value

Type	Description
byte[]

Overrides

AbstractMapiItem.SearchKey

Remarks

2.2.3.4 PidTagRecordKey

SendInternetEncoding

Gets or sets a bitmask of message-encoding preferences for mail sent to an e-mail-enabled entity that is represented by an Address Book object.

Declaration

public int? SendInternetEncoding { get; set; }

Property Value

Type	Description
int?

Remarks

2.2.3.19 PidTagSendInternetEncoding

SendRichInfo

Gets or sets whether the the email-enabled entity represented by an Address Book object can receive all message content,including Rich Text Format (RTF) and other embedded objects.

Declaration

public bool? SendRichInfo { get; set; }

Property Value

Type	Description
bool?

Remarks

2.2.3.18 PidTagSendRichInfo

SmtpAddress

Gets or sets an Address Book object's Simple Mail Transfer Protocol (SMTP) address.

Declaration

public string SmtpAddress { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.21 PidTagSmtpAddress

SpokenName

Gets or sets an Advanced Systems Format binary media object, as specified in [ASF] section 9.5, that contains a recording of the mail user's name pronunciation.

Declaration

public byte[] SpokenName { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.4.41 PidTagSpokenName

StateOrProvince

Gets or sets the name of a mail user's state or province.

Declaration

public string StateOrProvince { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.17 PidTagStateOrProvince

StreetAddress

Gets or sets a mail user's street address.

Declaration

public string StreetAddress { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.14 PidTagStreetAddress

Surname

Gets or sets a mail user's family name.

Declaration

public string Surname { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.1 PidTagSurname

TelexNumber

Gets or sets a mail user's telex number.

Declaration

public string TelexNumber { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.30 PidTagTelexNumber

Templateid

Gets or sets the EntryId property, expressed in Permanent Entry ID format.

Declaration

public byte[] Templateid { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.3.3 PidTagTemplateid

ThumbnailPhoto

Gets or sets an image of a mail user's photo in Joint Photographic Experts Group (JPEG) format.

Declaration

public byte[] ThumbnailPhoto { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.4.40 PidTagThumbnailPhoto

Title

Gets or sets a mail user's job title.

Declaration

public string Title { get; set; }

Property Value

Type	Description
string

Remarks

2.2.4.4 PidTagTitle

TransmittableDisplayName

Gets or sets a displayable form of an Address Book object that can be rendered in the client user's own code page.

Declaration

public string TransmittableDisplayName { get; set; }

Property Value

Type	Description
string

Remarks

2.2.3.8 PidTagTransmittableDisplayName

UserCertificate

Gets or sets the user certificate value.

Declaration

public byte[] UserCertificate { get; set; }

Property Value

Type	Description
byte[]

Remarks

2.2.4.34 PidTagUserCertificate

UserX509Certificate

Gets or sets a list certificate for a mail user.

Declaration

public byte[][] UserX509Certificate { get; set; }

Property Value

Type	Description
byte[][]

Remarks

Each binary value MUST be either an ASN.1 DER encoded SignedData Type binary large object (BLOB) that contains the user's certificates and is signed with the user's certificate, as specified in [RFC3852], or a binary property as specified in the following paragraph.

2.2.4.36 PidTagUserX509Certificate TODO