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:
This reference attribute accepts the following object types:
|
Read, Write |
AcceptMessagesOnlyFromDL |
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:
This reference attribute accepts the following object types:
|
Read, Write |
AcceptMessagesOnlyFromSenders |
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:
This reference attribute accepts the following object types:
|
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:
|
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:
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:
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:
|
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 |
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:
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:
|
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:
|
Read, Write |
CalendarVersionStoreDisabled |
Gets or sets whether to log calendar changes in the mailbox. This attribute can take one of the following values:
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:
|
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:
|
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:
|
Read, Write |
HiddenFromAddressListsEnabled |
Gets or sets whether this mailbox is hidden from address lists. This attribute can take one of the following values:
|
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:
|
Read, Write |
IsRegular |
Gets or sets whether the mailbox belongs to a user. This attribute can take one of the following values:
|
Read, Write |
IsRoom |
Gets or sets whether the mailbox belongs to a room. This attribute can take one of the following values:
|
Read, Write |
IsShared |
Gets or sets whether the mailbox is shared. This attribute can take one of the following values:
|
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:
|
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:
|
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 A MailTip message translation cannot exceed 250 characters. |
Read, Write |
MessageTrackingReadStatus |
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:
|
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:
|
Read, Write |
ModerationEnabled |
Gets or sets whether moderation is enabled for the mailbox. This attribute can take one of the following values:
|
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:
|
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:
|
Read, Write |
RejectMessagesFromSendersOr |
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:
This reference attribute accepts the following object types:
|
Read, Write |
RequireSenderAuthentication |
Gets or sets whether senders must be authenticated. This attribute can take one of the following values:
|
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:
|
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:
|
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:
|
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 |
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:
This reference attribute accepts the following object types:
|
Read, Write |
AcceptMessagesOnlyFromDL |
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:
This reference attribute accepts the following object types:
|
Read, Write |
AcceptMessagesOnlyFromSenders |
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:
This reference attribute accepts the following object types:
|
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 |
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:
Moderation does not apply to the senders designated as moderators for the mail user. This reference attribute accepts the following object types:
|
Read, Write |
CalendarVersionStoreDisabled |
Gets or sets whether to log calendar changes for the mail user. This attribute can take one of the following values:
|
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:
|
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:
|
Read, Write |
HiddenFromAddressListsEnabled |
Gets or sets whether the mail user is hidden from address lists. This attribute can take one of the following values:
|
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:
|
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:
|
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 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:
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:
|
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:
|
Read, Write |
ModerationEnabled |
Gets or sets whether moderation is enabled for the distribution group. This attribute can take one of the following values:
|
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:
This reference attribute accepts the following object types:
|
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:
This reference attribute accepts the following object types:
|
Read, Write |
RequireSenderAuthentication |
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:
|
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:
|
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:
|
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:
|
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.
|
Read, Write 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:
|
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 |
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 |
Attribute |
Description |
Supported operations |
Description |
Gets or sets the description of the security group. |
Read, Write |
DisplayName |
Gets or sets the display name of the security group. |
Read, Write |
Members |
Gets or sets the members of the security group. |
Read, Write |
ObjectID |
Gets the unique object identifier (GUID). |
Read |
© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center