The Office 365 Connector supports the following Mailbox attributes for synchronization.
|
Attribute |
Description |
Supported operations |
|
AcceptMessagesOnlyFrom |
Gets or sets the senders that can send email messages to the object. This reference attribute accepts any of the following values for the distribution groups:
This reference attribute accepts the following object types:
|
Read, Write |
|
AcceptMessagesOnlyFromDLMembers |
Gets or sets the distribution groups whose members are allowed to send email messages to the object. This reference attribute accepts any of the following values for the distribution groups:
This reference attribute accepts the following object types:
|
Read, Write |
|
AcceptMessagesOnlyFromSendersOrMembers |
Gets or sets the senders who can send email messages to the object. 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 object. |
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, 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 object. This is the name displayed on the user interface in 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 for the AuditAdmin, AuditDelegate, and AuditOwner attributes will be 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 will be deleted. This attribute accepts the retention period in the following format: DD.HH:MM:SS The maximum value the attribute can accept is 24855.03:14:07 Examples of use
|
Read, Write |
|
BypassModerationFromSendersOrMembers |
Gets or sets the senders whose messages bypass moderation for the object. 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 for the object. This attribute can take one of the following values:
|
Read, Write |
|
CreateDTMFMap |
Sets whether to create a dual-tone multi-frequency (DTMF) map for the object. This attribute can take one of the following values:
|
Write |
|
CustomAttribute1 |
Gets or sets the additional custom values you specified. |
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 if 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 used in Microsoft 365 for the object. |
Read, Write |
|
EmailAddresses |
Gets or sets all the proxy addresses of the object. The proxy addresses also include the primary SMTP address. NOTE: When writing proxy addresses using this attribute, make sure the specified addresses are valid, as they are not validated by Exchange. |
Read, Write |
|
EndDateForRetentionHold |
Gets or sets the retention hold end date for messaging records management (MRM). TIP: To enable or disable retention hold, use the RetentionHoldEnabled attribute. |
Read, Write |
|
ExternalDirectoryObjectId |
Gets the globally unique identifier (GUID) of the object. |
Read |
|
ExternalOofOptions |
Gets or sets whether out-of-office (OoO) messages are sent to external senders. This attribute can take one of the following values:
|
Read, Write |
|
ExtensionCustomAttribute1 |
Gets or sets the additional custom values you specify. These attributes are multivalued. TIP: To specify multiple values, use comma as a separator. |
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 object. |
Read, Write |
|
HiddenFromAddressListsEnabled |
Gets or sets whether Microsoft 365 hides the object 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. NOTE: The Office 365 Connector can read the value of this attribute only if it is stored in Microsoft 365 in a base64 encoding format. If the attribute value is stored in any other format, the connector will return an error when reading that value. |
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 the quota, set the value of this attribute to Unlimited. NOTE: 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 object 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 used only 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. TIP: When setting a mailbox plan, make sure that the plan is available in the organization of the mailbox. |
Read, Write |
|
MailTip |
Gets or sets the message displayed to senders when they start writing an email message to the object. |
Read, Write |
|
MailTipTranslations |
Gets or sets the MailTip message translations in additional languages. This attribute accepts the following format: <LanguageLocale>:<MailTip NOTE: MailTip message translations cannot be longer than 250 characters. |
Read, Write |
|
MessageTrackingReadStatusEnabled |
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 object. TIP: To specify multiple users as moderators, use comma as separator. NOTE: 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 object. This attribute can take one of the following values:
|
Read, Write |
|
Name |
Gets or sets the name of the object. This is the name that appears in the Active Directory Users and Computers tool. |
Read, Write |
|
ObjectID |
Gets the globally unique object identifier (GUID) of the object. |
Read |
|
Office |
Gets or sets the company office location associated with the object. |
Read, Write |
|
Password |
Sets the password for the user account associated with the mailbox. |
Write |
|
PrimarySmtpAddress |
Gets or sets the primary SMTP email address of the object. NOTE: You can use this attribute if the object has two or more SMTP email addresses configured. For external recipients, the email address specified with this attribute will appear. |
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 quota, set the value of this attribute to Unlimited. NOTE: 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 quota, set the value of this attribute to Unlimited. NOTE: 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 to the object will be rejected. 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 object (their messages will be rejected). This reference attribute accepts the following object types:
|
Read, Write |
|
RejectMessagesFromSendersOrMembers |
Gets or sets the senders that cannot send email messages to the object (their messages will be rejected). This attribute can take any of the following values for the recipients:
This reference attribute accepts the following object types:
|
Read, Write |
|
RequireSenderAuthenticationEnabled |
Gets or sets whether the senders that send messages to this object 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 the duration of keeping deleted items. This attribute accepts a value in the following format: DD.HH:MM:SS For example, a value of 10.00:00:00 means that deleted items are retained for 10 days. |
Read, Write |
|
RetentionComment |
Gets or sets a comment onhold status of the user. This comment is also displayed in Outlook. NOTE: 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 the retention policy to apply to the folders and mail items of this mailbox. |
Read, Write |
|
RetentionUrl |
Gets or sets the URL of the web page providing additional details about the messaging retention policies in effect within the organization. |
Read, Write |
|
RoleAssignmentPolicy |
Gets or sets the management role assignment policy to assign to the mailbox when it is created or enabled. TIP: Consider the following when using this attribute:
|
Read, Write |
|
RulesQuota |
Gets or sets the size limit for the rules specified for the mailbox. Qualify the value you specify in this attribute by appending either B (bytes) or KB (kilobytes): for example, 64 B or 256 KB. Unqualified values are considered bytes. The maximum value this attribute can accept is 256 KB. |
Read, Write |
|
SecondaryAddress |
Gets or sets the secondary address for the object if it has Unified Messaging enabled. |
Write |
|
SecondaryDialPlan |
Sets the secondary Unified Messaging dial plan for the object. |
Write |
|
SendModerationNotifications |
Gets or sets whether to send status notifications to users when a message they sent to the moderated object 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 object if only a limited set of characters is allowed. The limited set of characters includes ASCII characters 26–126. |
Read, Write |
|
SingleItemRecoveryEnabled |
Gets or sets whether the purging of recovery items is enabled or disabled. 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 object if it has Unified Messaging enabled. |
Read, Write |
|
UsageLocation |
Gets a two-letter country code (for example, FR, GB or NL) that defines the location of the user. The usage location determines the services available to the user. |
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 by the user. |
Read, Write |
