Chat now with support
Chat with Support

Active Roles 7.3.3 - Synchronization Service Administration Guide

Synchronization Service Overview Deploying Synchronization Service Getting started Connections to external data systems
External data systems supported out of the box
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Sample queries to modify SQL Server data Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft Office 365 Working with Microsoft Azure Active Directory
Using connectors installed remotely Creating a connection Renaming a connection Deleting a connection Modifying synchronization scope for a connection Using connection handlers Specifying password synchronization settings for a connection
Synchronizing identity data Mapping objects Automated password synchronization Synchronization history Scenarios of use Appendix A: Developing PowerShell scripts for attribute synchronization rules Appendix B: Using a PowerShell script to transform passwords

LicensePlanService object attributes

LicensePlanService object attributes

 

Table 84: LicensePlanService attributes

Attribute

Description

Supported operations

AssignedLicenses

Gets the number of used licenses in Office 365. This number includes both valid and expired licenses that are currently assigned.

Read

ExpiredLicenses

Gets the number of expired licenses in Office 365.

Read

ObjectID

Gets the unique object identifier (GUID).

Read

PlanDisplayName

Gets the name of the currently used license plan name in the form it is displayed on the Office 365 graphical user interface.

Read

PlanName

Gets the name of the currently used license plan in the form it is returned by the Windows PowerShell cmdlets for Office 365.

Read

ReducedFunctionalityLicenses

Gets the number of licenses that are currently in the reduced functionality mode (RFM).

Read

RelatedAttributeName

Gets the name of the attribute in the Office 365 Connector schema that allows you to work (for example, read and write) with the specified Office 365 service.

Read

ServiceDisplayName

Gets the license service name in the form it is displayed on the Office 365 graphical user interface. Service names are the names of the check boxes displayed under a license plan.

Read

ServiceName

Gets the license service name in the form it is returned by the Windows PowerShell cmdlets for Office 365.

Read

ValidLicenses

Gets the number of valid licenses in Office 365. This number includes both assigned and available licenses.

Read

Mailbox object attributes

Mailbox object attributes

 

Table 85: Mailbox attributes

Attribute

Description

Supported operations

AcceptMessagesOnlyFrom

Gets or sets the senders that can send email messages to the specified mailbox.

This reference attribute accepts any of the following values for the distribution groups:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • MailUser
  • Mailbox
  • Contact

Read, Write

AcceptMessagesOnlyFromDL
Members

Gets or sets the distribution groups whose members are allowed to send email messages to the specified mailbox.

This reference attribute accepts any of the following values for the distribution groups:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

AcceptMessagesOnlyFromSenders
OrMembers

Gets or sets the senders who can send email messages to the specified mailbox.

This reference attribute can take any of the following values for the senders:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

Alias

Gets or sets the alias of the mailbox user.

Read, Write

ApplyMandatoryProperties

Sets whether to modify the mandatory properties of a legacy mailbox.

For example, you can use this attribute to remove the legacyMailbox tag from a legacy mailbox residing on an Exchange Server 2010 or check whether this tag exists on the mailbox.

This attribute can take one of the following values:

  • TRUE. Specifies that the legacyMailbox tag does not exist on the mailbox.
  • FALSE. Specifies that the legacyMailbox tag exists on the mailbox.

Write

ArchiveName

Gets or sets the name of the archive mailbox. This is the name displayed on the user interface in Microsoft Office Outlook Web App and Microsoft Outlook.

Read, Write

AuditAdmin

Gets or sets the operations to log for administrators.

This attribute can take the following values:

  • None
  • Update
  • Copy
  • Move
  • MoveToDeletedItems
  • SoftDelete
  • HardDelete
  • FolderBind
  • SendAs
  • SendOnBehalf
  • MessageBind

To enable mailbox audit logging, set the value of the AuditEnabled attribute to TRUE.

Read, Write

AuditDelegate

Gets or sets the operations to log for delegate users.

This attribute can take the following values:

None

Update

Move

MoveToDeletedItems

SoftDelete

HardDelete

FolderBind

SendAs

SendOnBehalf

To enable mailbox audit logging, set the value of the AuditEnabled attribute to TRUE.

Read, Write

AuditEnabled

Gets or sets whether mailbox audit logging is enabled or disabled. If mailbox audit logging is enabled, the operations specified in the AuditAdmin, AuditDelegate, and AuditOwner attributes are logged.

This attribute can take one of the following values:

  • TRUE. Specifies that mailbox audit logging is enabled.
  • FALSE. Specifies that mailbox audit logging is disabled.

Read, Write

AuditLogAgeLimit

Gets or sets the retention period for the mailbox audit logs. Logs whose age exceeds the specified retention period are deleted.

This attribute accepts the following format for the retention period:

DD.HH:MM:SS

The maximum value this attribute can accept is 24855.03:14:07

Example 1

30.05:00:00

Specifies to retain the mailbox audit logs for 30 days and 5 hours.

Example 2

00.00:00:00

The mailbox audit logs are never deleted.

Read, Write

BypassModerationFromSendersOr
Members

Gets or sets the senders whose messages bypass moderation for the mailbox.

This reference attribute can take any of the following values for the senders:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP email address

The values in this attribute do not apply to the senders that are the moderators of the mailbox.

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

CalendarRepairDisabled

Gets or sets whether the calendar items in the mailbox can be repaired by the Calendar Repair Assistant.

This attribute can take one of the following values:

  • TRUE. Specifies that repair operations are enabled.
  • FALSE. Specifies that repair operations are disabled.

Read, Write

CalendarVersionStoreDisabled

Gets or sets whether to log calendar changes in the mailbox.

This attribute can take one of the following values:

TRUE. Specifies that calendar changes are logged.

FALSE. Specifies that calendar changes are not logged.

Read, Write

CreateDTMFMap

Sets whether to create a dual-tone multi-frequency map for the mailbox user.

Write

CustomAttribute1

Get or set the additional custom values you specify.

Read, Write

CustomAttribute2

CustomAttribute3

CustomAttribute4

CustomAttribute5

CustomAttribute6

CustomAttribute7

CustomAttribute8

CustomAttribute9

CustomAttribute10

CustomAttribute11

CustomAttribute12

CustomAttribute13

CustomAttribute14

CustomAttribute15

DeliverToMailboxAndForward

Gets or sets whether this mailbox receives forwarded messages in case message forwarding to another address is configured for the mailbox.

This attribute can take one of the following values:

  • TRUE. Specifies that messages are delivered to this mailbox and to the forwarding address.
  • FALSE. Specifies that messages are delivered to the forwarding address only and not to this mailbox.

Read, Write

DisplayName

Gets or sets the display name of the user account associated with the mailbox.

Read, Write

EmailAddresses

Gets or sets all the proxy addresses of the mailbox. The proxy addresses also include the primary SMTP address.

When writing proxy addresses using this attribute, make sure the specified addresses are valid, because the addresses are not validated by Exchange.

Read, Write

EndDateForRetentionHold

Gets or sets the retention hold end date for messaging records management (MRM).

To enable or disable retention hold, use the RetentionHoldEnabled attribute.

Read, Write

ExternalDirectoryObjectId

Gets the GUID of the user to whom the mailbox belongs.

Read

ExternalOofOptions

Gets or sets whether Out of Office message is sent to external senders.

This attribute can take one of the following values:

  • External
  • InternalOnly

Read, Write

ExtensionCustomAttribute1

Get or set the additional custom values you specify. These attributes are multivalued.

Read, Write

ExtensionCustomAttribute2

ExtensionCustomAttribute3

ExtensionCustomAttribute4

ExtensionCustomAttribute5

ForwardingAddress

Gets or sets a forwarding address for the mailbox.

Read, Write

ForwardingSmtpAddress

Gets or sets a forwarding SMTP address for the mailbox.

Read, Write

GrantSendOnBehalfTo

Gets or sets the distinguished name (DN) of other senders that can send messages on behalf of the mailbox.

This reference attribute only accepts the following object type:

Mailbox

Read, Write

HiddenFromAddressListsEnabled

Gets or sets whether this mailbox is hidden from address lists.

This attribute can take one of the following values:

  • TRUE. Specifies that the mailbox is hidden from address lists.
  • FALSE. Specifies that the mailbox is shown in address lists.

Read, Write

ImmutableId

Gets or sets a unique immutable ID in the form of an SMTP address.

Read, Write

IsEquipment

Gets or sets whether the mailbox belongs to a piece of equipment.

This attribute can take one of the following values:

  • TRUE. Indicates that the mailbox is an equipment mailbox.
  • FALSE. Indicates that the mailbox is not an equipment mailbox.

Read, Write

IsRegular

Gets or sets whether the mailbox belongs to a user.

This attribute can take one of the following values:

  • TRUE. Indicates that the mailbox belongs to a user.
  • FALSE. Indicates that the mailbox does not belong to a user.

Read, Write

IsRoom

Gets or sets whether the mailbox belongs to a room.

This attribute can take one of the following values:

  • TRUE. Indicates that the mailbox belongs to a room.
  • FALSE. Indicates that the mailbox does not belong to a room.

Read, Write

IsShared

Gets or sets whether the mailbox is shared.

This attribute can take one of the following values:

TRUE. Indicates that the mailbox is shared.

FALSE. Indicates that the mailbox is not shared.

Read, Write

IssueWarningQuota

Gets or sets the mailbox size at which a warning message is sent to the mailbox user.

To specify a mailbox size, use an integer value. To disable warning, set the value of this attribute to Unlimited.

The value set on a mailbox by using this attribute overrides the value specified for the entire mailbox database.

Read, Write

IsValid

Gets whether or not the mailbox object is configured correctly.

This attribute can take one of the following values:

  • TRUE. Indicates that the mailbox object is configured correctly.
  • FALSE. Indicates that the mailbox object is not configured correctly.

Read

Languages

Gets or sets preferred languages for the mailbox in the order of their priority.

Read, Write

LitigationHoldDate

Gets or sets the date when the mailbox is placed on litigation hold. This date is only used for informational or reporting purposes.

Read, Write

LitigationHoldDuration

Gets or sets the litigation hold duration for the mailbox in days.

Read, Write

LitigationHoldEnabled

Gets or sets whether litigation hold is enabled for the mailbox. When a mailbox is on litigation hold, messages cannot be deleted from the mailbox.

This attribute can take one of the following values:

  • TRUE. Specifies that litigation hold is enabled.
  • FALSE. Specifies that litigation hold is not enabled.

Read, Write

LitigationHoldOwner

Gets or sets the user who put the mailbox on litigation hold.

Read, Write

MailboxPlan

Gets or sets the mailbox plan name associated with the mailbox. When setting a mailbox plan name, make sure that plan name exists for the organization in which the mailbox resides.

Read, Write

MailTip

Gets or sets the message displayed to senders when they start writing an email message to this recipient.

Read, Write

MailTipTranslations

Gets or sets the MailTip message translations in additional languages.

This attribute accepts the following format:

<LanguageLocale>:<MailTip
MessageTranslation>

A MailTip message translation cannot exceed 250 characters.

Read, Write

MessageTrackingReadStatus
Enabled

Gets or sets whether the read status of sent messages is provided to the senders who sent messages to this mailbox.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

ModeratedBy

Gets or sets the users who are moderating the messages sent to the mailbox. To specify multiple users, use a comma as a separator.

This reference attribute is required if you set the value of the ModerationEnabled attribute to TRUE.

This reference attribute accepts the following object types:

Mailbox

MailUser

Read, Write

ModerationEnabled

Gets or sets whether moderation is enabled for the mailbox.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

Name

Gets or sets the name of the mailbox user. This is the name that displays in the Active Directory Users and Computers tool.

Read, Write

ObjectID

Gets the unique object identifier (GUID).

Read

Office

Gets or sets the Microsoft Office attribute for the mailbox.

Read, Write

Password

Sets the password for the user account associated with the mailbox.

Write

PrimarySmtpAddress

Gets or sets the originating email address displayed to the external recipients of a message sent from the mailbox.

Read, Write

ProhibitSendQuota

Gets or sets the mailbox size at which the mailbox user can no longer send messages.

To specify a mailbox size, use an integer value. To disable the send quota, set the value of this attribute to Unlimited.

The value set on a mailbox by using this attribute overrides the value specified for the entire mailbox database.

Read, Write

ProhibitSendReceiveQuota

Gets or sets the mailbox size at which the mailbox user can no longer send or receive messages.

To specify a mailbox size, use an integer value. To disable the send and receive quota, set the value of this attribute to Unlimited.

The value set on a mailbox by using this attribute overrides the value specified for the entire mailbox database.

Read, Write

RejectMessagesFrom

Gets or sets the senders whose messages are rejected by the mailbox.

This reference attribute accepts the following object types:

  • Contact
  • Mailbox

Read, Write

RejectMessagesFromDLMembers

Gets or sets the distribution groups whose members cannot send email messages to the mailbox (their messages are rejected).

This reference attribute accepts the following object types:

DistributionGroup

DynamicDistributionGroup

Read, Write

RejectMessagesFromSendersOr
Members

Gets or sets the senders that cannot send email messages to the mailbox (their messages are rejected).

This attribute can take any of the following values for the recipients:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox

Read, Write

RequireSenderAuthentication
Enabled

Gets or sets whether senders must be authenticated.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

ResourceCapacity

Gets or sets the maximum number of people that can be accommodated by the room to which the mailbox belongs.

Read, Write

ResourceCustom

Gets or sets additional information about the resource.

Read, Write

RetainDeletedItemsFor

Gets or sets for how long to keep deleted items.

This attribute accepts the following format:

DD.HH:MM:SS

Example

10.00:00:00

Specifies to retain deleted items for 10 days 00 hours 00 minutes and 00 seconds.

Read, Write

RetentionComment

Gets or sets a comment on user’s hold status. This comment is displayed in Outlook.

You can only write the value of this attribute if the value of the RetentionHoldEnabled attribute is set to TRUE.

Read, Write

RetentionHoldEnabled

Gets or sets whether retention hold is enabled for messaging retention policies.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

RetentionPolicy

Gets or sets the name of a retention policy to be applied to the folders and mail items in this mailbox.

Read, Write

RetentionUrl

Gets or sets the URL of a Web site providing additional details about the organization's messaging retention policies.

Read, Write

RoleAssignmentPolicy

Gets or sets the management role assignment policy to assign to the mailbox when it is created or enabled.

If the assignment policy name you want to specify contains spaces, use quotation marks around the name.

If you omit this attribute when creating or enabling a mailbox, the default assignment policy is used.

If you do not want to assign an assignment policy, set an empty value in this attribute.

Read, Write

RulesQuota

Gets or sets the limit for the size of rules for the mailbox.

Qualify the value you specify in this attribute by appending B (bytes) or KB (kilobytes). Unqualified values are treated as bytes. The maximum value this attribute accepts is 256 KB.

Example

64 KB

Read, Write

SecondaryAddress

Sets the secondary address used by the UM-enabled user.

Write

SecondaryDialPlan

Sets a secondary UM dial plan to use.

Write

SendModerationNotifications

Gets or sets whether to send status notifications to users when a message they sent to the moderated distribution group is rejected by a moderator.

This attribute can take one of the following values:

  • Always. Specifies that notifications are sent to all senders.
  • Internal. Specifies that notifications are only sent to the internal senders in your organization.
  • Never. Specifies that all status notifications are disabled.

Read, Write

SharingPolicy

Gets or sets the sharing policy associated with the mailbox.

Read, Write

SimpleDisplayName

Gets or sets an alternate description of the mailbox in a situation where a limited set of characters is allowed. The limited set of characters includes ASCII characters 26 through 126.

Read, Write

SingleItemRecoveryEnabled

Gets or sets whether to enable or disable the purging of recovery items.

This attribute can take one of the following values:

  • TRUE. Specifies to disable the purging of recovery items.
  • FALSE. Specifies to enable the purging of recovery items.

Read, Write

UMDtmfMap

Gets or sets whether to create a user-defined DTMF map for the user if it has Unified Messaging enabled.

Read, Write

UsageLocation

Gets a two-letter country code that defines the location of the user. Usage location determines the services available to the user.

Examples

  • FR
  • GB
  • NL

Read

UserCertificate

Gets or sets the digital certificate used to sign email messages of the user.

Read, Write

UserPrincipalName

Gets or sets the logon name of the mailbox user.

Read, Write

UserSMimeCertificate

Gets or sets the SMIME certificate used to sign email messages of the user.

Read, Write

MailUser object attributes

MailUser object attributes

 

Table 86: MailUser attributes

Attribute

Description

Supported operations

AcceptMessagesOnlyFrom

Gets or sets the senders that can send email messages to the specified mail user.

This reference attribute can take senders in any of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • Exchange DN
  • GUID
  • Name
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • MailUser
  • Mailbox
  • Contact

Read, Write

AcceptMessagesOnlyFromDL
Members

Gets or sets the distribution groups whose members are allowed to send email messages to the specified mail user.

This reference attribute can take distribution groups in any of the following formats:

  • Canonical name
  • Display name
  • DN
  • GUID
  • Legacy Exchange DN
  • Name
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

AcceptMessagesOnlyFromSenders
OrMembers

Gets or sets the senders who can send email messages to the mail user.

This reference attribute can take senders in any of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • Legacy Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

Alias

Gets or sets the alias of the mail user.

Read, Write

ArchiveName

Gets the name of the archive mailbox. This is the name displayed on the user interface in Microsoft Office Outlook Web App and Microsoft Outlook.

Read

BypassModerationFromSendersOr
Members

Gets or sets the senders whose messages bypass moderation for the mail user.

This reference attribute can take any of the following values for the senders:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • Legacy Exchange DN
  • Primary SMTP email address

Moderation does not apply to the senders designated as moderators for the mail user.

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

CalendarVersionStoreDisabled

Gets or sets whether to log calendar changes for the mail user.

This attribute can take one of the following values:

  • TRUE. Specifies that calendar changes are logged.
  • FALSE. Specifies that calendar changes are not logged.

Read, Write

CreateDTMFMap

Sets whether to create a dual-tone multi-frequency map for the mail user.

Write

CustomAttribute1

Get or set the additional custom values you specify.

Read, Write

CustomAttribute2

CustomAttribute3

CustomAttribute4

CustomAttribute5

CustomAttribute6

CustomAttribute7

CustomAttribute8

CustomAttribute9

CustomAttribute10

CustomAttribute11

CustomAttribute12

CustomAttribute13

CustomAttribute14

CustomAttribute15

DeliverToMailboxAndForward

Gets whether messages sent to the mail user are forwarded to another address in case message forwarding is configured.

This attribute can take one of the following values:

  • TRUE. Specifies that messages are delivered to the mail user and to the forwarding address.
  • FALSE. Specifies that messages are delivered to the forwarding address only.

Read

DisplayName

Gets or sets the display name of the mail user.

Read, Write

EmailAddresses

Gets or sets the email alias of the mail user.

Read, Write

EndDateForRetentionHold

Gets the retention hold end date for messaging records management (MRM).

To enable or disable retention hold, use the RetentionHoldEnabled attribute.

Read

ExtensionCustomAttribute1

Get or set the additional custom values you specify. These attributes are multivalued. To specify multiple values, use a comma as a separator.

Read, Write

ExtensionCustomAttribute2

ExtensionCustomAttribute3

ExtensionCustomAttribute4

ExtensionCustomAttribute5

ExternalDirectoryObjectId

Gets the GUID of the mail user.

Read

ExternalEmailAddress

Gets or sets an email address outside of the mail user’s organization. Messages sent to the mail user are delivered to this external address.

Read, Write

FederatedIdentity

Allows you to associate an on-premises Active Directory user with the Office 365 mail user.

Write

ForwardingAddress

Gets the forwarding address for the mail user.

Read

GrantSendOnBehalfTo

Gets or sets the distinguished name (DN) of other senders that can send messages on behalf of the mail user.

This reference attribute only accepts the following object type:

  • Mailbox

Read, Write

HiddenFromAddressListsEnabled

Gets or sets whether the mail user is hidden from address lists.

This attribute can take one of the following values:

  • TRUE. Specifies that the mail user is hidden from address lists.
  • FALSE. Specifies that the mail user is shown in address lists.

Read, Write

ImmutableId

Gets or sets a unique immutable ID in the form of an SMTP address.

Read, Write

LitigationHoldDate

Gets the date when the mail user’s mailbox is placed on litigation hold.

Read

LitigationHoldEnabled

Gets whether litigation hold is enabled for the mail user’s mailbox. When a mailbox is on litigation hold, messages cannot be deleted from the mailbox.

This attribute can take one of the following values:

  • TRUE. Specifies that litigation hold is enabled.
  • FALSE. Specifies that litigation hold is not enabled.

Read

LitigationHoldOwner

Gets the user who enabled litigation hold on the mailbox. This attribute can only be used for informational or reporting purposes.

Read

MacAttachmentFormat

Gets or sets the Apple Macintosh operating system attachment format for messages sent to the mail user.

This attribute can take the following values:

  • BinHex
  • UuEncode
  • AppleSingle
  • AppleDouble

Read, Write

MailTip

Gets or sets the message displayed to senders when they start writing an email message to the mail user.

Read, Write

MailTipTranslations

Gets or sets the MailTip message translations in additional languages.

This attribute accepts the following format:

<LanguageLocale>:<MailTip
MessageTranslation>

A MailTip message translation cannot exceed 250 characters.

Read, Write

MessageBodyFormat

Gets or sets the message body format for messages sent to the mail user.

The values this attribute can take depend on the value in the MessageFormat attribute.

When the value in the MessageFormat is Mime, the MessageBodyFormat attribute can take the following values:

  • Text
  • Html
  • TextAndHtml

When the value in the MessageFormat is Text, the MessageBodyFormat attribute can only take the Text value.

Read, Write

MessageFormat

Gets or sets the message format for messages sent to the mail user.

This attribute can take the following values:

  • Text
  • Mime

Read, Write

ModeratedBy

Gets or sets the moderators who are moderating the messages sent to the distribution group. To specify multiple moderators, use a comma as a separator.

This reference attribute is required if you set the value of the ModerationEnabled attribute to TRUE.

This reference attribute accepts the following object types:

  • Mailbox
  • MailUser

Read, Write

ModerationEnabled

Gets or sets whether moderation is enabled for the distribution group.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

Name

Gets or sets the name of the mail user.

Read, Write

ObjectID

Gets the unique object identifier (GUID).

Read

Password

Sets the password for the mail user.

Write

RejectMessagesFrom

Gets or sets the senders whose messages to the mail user are rejected.

This attribute can take senders in one of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • Legacy Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • Mailbox

Read, Write

RejectMessagesFromDLMembers

Gets or sets the distribution groups whose members cannot send email messages to the mail user (such messages are rejected).

This reference attribute can take distribution groups in one of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Legacy Exchange DN
  • Name
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

RequireSenderAuthentication
Enabled

Gets or sets whether the senders that send messages to this mail user must be authenticated.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

RetainDeletedItemsFor

Gets for how long to keep deleted items for the mail user.

This attribute accepts the following format:

DD.HH:MM:SS

Example

10.00:00:00

Specifies to retain deleted items for 10 days 00 hours 00 minutes and 00 seconds.

Read

RetentionComment

Gets the comment on the mail user’s hold status. This comment is displayed in Outlook.

You can only write the value of this attribute if the value of the RetentionHoldEnabled attribute is set to TRUE.

Read

RetentionHoldEnabled

Gets whether retention hold is enabled for messaging retention policies.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read

RetentionUrl

Gets the URL of a Web page providing additional details about the organization's messaging retention policies.

Read

SecondaryAddress

Sets the secondary address used by the Unified Messaging-enabled user.

Write

SecondaryDialPlan

Sets a secondary Unified Messaging dial plan for the mail user.

Write

SendModerationNotifications

Gets or sets whether to send status notifications to users when a message they sent to the moderated distribution group is rejected by a moderator.

This attribute can take one of the following values:

  • Always. Specifies that notifications are sent to all senders.
  • Internal. Specifies that notifications are only sent to the senders internal to your organization.
  • Never. Specifies that all status notifications are disabled.

Read, Write

SimpleDisplayName

Gets or sets an alternate description of the mailbox in a situation where a limited set of characters is allowed.

The limited set of characters includes ASCII characters from 26 to 126.

Read, Write

SingleItemRecoveryEnabled

Gets whether the purging of recovery items is enabled.

This attribute can take one of the following values:

  • TRUE. Specifies to disable the purging of recovery items.
  • FALSE. Specifies to enable the purging of recovery items.

Read

StartDateForRetentionHold

Gets the start date for retention hold. To use this attribute, you must set the RetentionHoldEnabled attribute to TRUE.

Read

UMDtmfMap

Gets or sets whether to create a user-defined DTMF map for the mail user if it has Unified Messaging enabled.

Read, Write

UsageLocation

Gets a two-letter country code that defines the location of the mail user. Usage location determines the services available to the mail user.

Examples

  • FR
  • GB
  • NL

Read

UseMapiRichTextFormat

Gets or sets a format for the MAPI Rich Text Format messages sent to the mail user.

  • Never. Specifies to convert all messages sent to the mail user to the plain text format.
  • Always. Specifies to always use the MAPI Rich Text Format (RTF) for the messages sent to the mail user.
  • UseDefaultSettings. Specifies to use the message format set in the MAPI client that sent the message to the mail user.

Read, Write

NOTE: You can only write data by using this attribute when updating an existing object in Office 365.

UsePreferMessageFormat

Gets or sets whether the message format specified for the mail user overrides any global settings (such as those configured for the remote domain).

This attribute can take one of the following values:

  • TRUE. Specifies that the message format set for the mail user overrides any global settings.
  • FALSE. Specifies that global settings have precedence over the mail format set for the mail user.

Read, Write

UserPrincipalName

Gets or sets the user principal name (UPN) of the mail user.

Read, Write

WindowsEmailAddress

Gets or sets the email address for the mail user stored in Active Directory.

Read, Write

PresencePolicy object attributes

PresencePolicy object attributes

 

Table 87: PresencePolicy attributes

Attribute

Description

Supported operations

Anchor

Gets the Anchor property value of the policy.

Read

Description

Gets the policy description.

Read

Identity

Gets the unique identifier assigned to the policy.

Read

Members

Gets the users who have been assigned the policy.

Read

ObjectID

Gets the unique object identifier (GUID).

Read

Related Documents