Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
You can use the Update Mailbox activity to modify the settings of an existing mailbox in an on-premises or online environment.
The following tables list the required properties, optional properties, and published data for this activity.
Required properties for Update Mailbox activity
| Element | Description | Valid values |
|---|---|---|
| Identity | Specifies the mailbox that is to be updated. This property accepts the following value types: Alias, for example: JPhilips Canonical DN, for example: Atlanta.Corp.Contoso.Com/ Users/JPhilips Display Name, example: Jeff Philips Distinguished Name (DN), example: CN=JPhilips,CN=Users, DC=Atlanta,DC=Corp, DC=contoso,DC=com Domain\Account, example: Atlanta\JPhilips GUID, example: fb456636-fe7d-4d58 -9d15-5af57d0354c2 Immutable ID, example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com Legacy Exchange DN, example: /o=Contoso /ou=AdministrativeGroup /cn=Recipients/cn=JPhilips SMTP Address, example: Jeff.Philips@contoso.com User Principal Name, example: JPhilips@contoso.com |
String |
Optional properties for Update Mailbox activity
| Element | Description | Valid values |
|---|---|---|
| Accept Messages Only From | Specifies a list of mailbox users, mail users, and mail contacts that can send email messages to this mailbox. You can also specify Exchange as a valid recipient for this property. If you configure a mailbox to accept messages only from the Exchange recipient, the mailbox receives only system-generated messages. You can use any of the following values for the valid senders: DN Canonical name GUID Name Display name Alias Exchange DN Primary SMTP email address By default, this property is blank, which enables the mailbox to accept messages from all senders. |
String |
| Accept Messages Only From DL Members | Specifies a list of distribution groups whose members are allowed to send email messages to this mailbox. You can use any of the following values for the allowed distribution groups: DN Canonical name GUID Name Display name LegacyExchangeDN Primary SMTP email address. By default, this property is blank, which enables the mailbox to accept messages from all senders. |
String |
| Accept Messages Only From Senders Or Members | Specifies a list of recipients who can send email messages to this mailbox. You can specify users, contacts, or distribution groups. If you specify a distribution group, messages are accepted from all recipients that are members of that distribution group. You can also specify Exchange as a valid recipient for this property. If you configure a distribution group to accept messages only from the Exchange recipient, the distribution group only receives system-generated messages. You can use any of the following values for the valid senders: DN Canonical name GUID Name Display name Alias Exchange DN Primary SMTP email address By default, the value of this property is blank, which enables the distribution group to accept messages from all senders. |
String |
| Address Book Policy | Specifies the address book policy that applies to this mailbox. | String |
| Alias | Specifies the alias (mail nickname) of the user. The alias can be a combination of characters that are separated by a period, without intervening spaces. Don't use special characters in the alias. Note This property is available only in an on-premises environment. |
String |
| Antispam Bypass Enabled | Specifies whether to skip anti-spam processing on this mailbox. Default value is True, when selected. |
True, False |
| Apply Mandatory Properties | Specifies whether to modify the mandatory properties of a mailbox. You can't create a mailbox through the Microsoft Exchange Server 2003 extensions to the Active Directory Users and Computers console. If a mailbox is created with this tool, it's identified as a legacy mailbox, even though it resides on a server that runs Microsoft Exchange Server 2010. This property modifies the mandatory properties of a mailbox in this state to correct the problem and remove the legacy mailbox tag from the mailbox. Default is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Arbitration | Specifies that the mailbox is an arbitration mailbox. Arbitration mailboxes are used to manage approval workflows. For example, you can use an arbitration mailbox to handle the approval of moderated recipients and distribution group membership. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Arbitration Mailbox | Specifies the mailbox that is used to manage the moderation process. Note This property is available only in an on-premises environment. |
String |
| Archive Database | Specifies the Exchange database that contains the archive associated with this mailbox. You can use the following values: GUID of the database Database name Note This property is available only in an on-premises environment. |
String |
| Archive Domain | Specifies the cloud-based service domain on which the archive that is associated with this mailbox exists. For example, if the SMTP email address of the user is tony@mail.contoso.com, the SMTP domain could be hosted.contoso.com. Note This property is available only in an on-premises environment. |
String |
| Archive Name | Specifies the name of the archive mailbox. This is the name displayed to users in Microsoft Office Outlook Web App and Microsoft Outlook. The default name is Online Archive - <Mailbox User's Display Name>. Note This property isn't available in the Live@edu environment. |
String |
| Archive Quota | Specifies the maximum size of the archive mailbox. If the maximum size is exceeded, new messages will no longer be accepted.. Qualify the value with one of the following units: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The value must be greater than the value of the Archive Warning Quota property. The valid input range for either property is from 1 through 9223372036854775807 bytes. Note This property is available only in an on-premises environment. |
String |
| Archive Warning Quota | Specifies the archive mailbox size at which a warning message is sent to the user, if the maximum size is exceeded Qualify the value with one of the following units: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The value must be less than the value of the Archive Quota property. The valid input range for either property is from 1 through 9223372036854775807 bytes. Note This property is available only in an on-premises environment. |
String |
| Audit Admin | Specifies the operations that administrators can log. Valid values include: None Update Copy Move MoveToDeletedItems SoftDelete HardDelete FolderBind SendAs SendOnBehalf MessageBind By default, the Update, Move, MoveToDeletedItems, SoftDelete, HardDelete, FolderBind, SendAs, and SendOnBehalf actions that are performed by administrators are logged. The Audit Enabled property must be set to True to enable logging. |
None Update Copy Move MoveToDeleteItems SoftDelete HardDelete FolderBind SendAs SendOnBehalf MessageBind |
| Audit Delegate | Specifies the operations that delegate users can. Valid values include: None Update Copy Move MoveToDeletedItems SoftDelete HardDelete FolderBind SendAs SendOnBehalf By default, the Update, SoftDelete, HardDelete, and SendAs actions that are performed by delegates are logged. The Audit Enabled property must be set to True to enable logging. |
None Update Copy Move MoveToDeleteItems SoftDelete HardDelete FolderBind SendAs SendOnBehalf |
| Audit Enabled | Specifies whether to enable or disable the mailbox audit logging. If auditing is enabled, the actions specified in the Audit Admin, Audit Delegate, and Audit Owner properties are logged. Default value is True, when selected. |
True, False |
| Audit Log Age Limit | Specifies the period for which the audit logs for a mailbox are retained. Logs that are older than the specified period are removed. The default value is 90 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify 10 days for this property, use 10.00:00:00. The valid input range for this property is from 00:00:00 through 24855.03:14:07. Setting the value of this property to 00:00:00 prevents the automatic removal of server statistics log files. |
String |
| Audit Owner | Specifies the operations that mailbox owners can log. Valid values include: None Update Move MoveToDeletedItems SoftDelete HardDelete By default, the mailbox access by the owner isn't logged. The Audit Enabled property must be set to True to enable logging. Note This property is available only in an on-premises environment. |
None Update Move MoveToDeleteItems SoftDelete HardDelete |
| Bypass Moderation From Senders Or Members | Specifies the recipients whose messages bypass moderation when they send messages to this mailbox. You can use any of the following values: DN Canonical name GUID Name Display name LegacyExchangeDN Primary SMTP email address. By default, this property is blank, which ensures that all messages are moderated when this mailbox is configured for moderation. Senders that are designated as moderators for this mailbox are never moderated. |
String |
| Calendar Repair Disabled | Specifies that this mailbox won't have its calendar items repaired by the Calendar Repair Assistant. Default value is True, when selected. |
True, False |
| Calendar Version Store Disabled | Specifies that the changes in a user's mailbox calendar aren't logged. By default, all changes to a calendar item are recorded in the mailbox of a user, to keep older versions of meeting items. Default value is True, when selected. |
True, False |
| Create DTMF Map | Specifies that a dual tone multi-frequency (DTMF) map can be created for the user. Default value is True, when selected. Note This property isn't available in the Live@edu environment. |
True, False |
| Custom Attribute 1 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 10 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 11 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 12 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 13 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 14 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 15 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 2 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 3 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 4 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 5 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 6 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 7 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 8 | Specifies the custom attribute for storing additional information. | String |
| Custom Attribute 9 | Specifies the custom attribute for storing additional information. | String |
| Database | Specifies the database that contains the mailbox object. The database can have one of the following value types: GUID Database name |
String |
| Deliver To Mailbox And Forward | Specifies whether the messages that are sent to this mailbox are forwarded to another address. If value is set to True, messages are delivered to the mailbox and to the forwarding address. If the value is set to False, messages are delivered only to the forwarding address. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Display Name | Specifies the display name for the user account that is associated with this mailbox. The display name is used by Microsoft Outlook. | String |
| Domain Controller | Specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. Note This property is available only in an on-premises environment. |
String |
| Downgrade High Priority Messages Enabled | Specifies whether to prevent the mailbox from sending high priority messages to an X.400 mail system. When value is set to True and the mailbox sends a high priority message to an X.400 mail system, the message priority is changed from high priority to normal priority. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Email Address Policy Enabled | Specifies whether the email address policy for this mailbox is enabled. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Email Addresses | Specifies all the proxy addresses of the mailbox. It includes the primary SMTP address as one of the proxy addresses. Can't be used with the Primary SMTP Address property. Important Exchange doesn't validate custom addresses for proper formatting. You must ensure that the custom address that you specify complies with the format requirements for that address type. Because X.400 addresses are considered custom addresses in Exchange, they also aren't validated, and you must provide the correct syntax when you specify an X.400 address. |
String |
| End Date For Retention Hold | Specifies the end date for retention hold for messaging records management (MRM). To use this property, the Retention Hold Enabled property must be set to True. | DateTime |
| Extension Custom Attribute 1 | The Extension Custom Attribute 1 through 5 specify the custom attributes that store additional information. You can specify multiple values for these properties as a comma delimited list. Each Extension Custom Attribute property can hold up to 1,300 values. | String |
| Extension Custom Attribute 2 | The Extension Custom Attribute 1 through 5 specify the custom attributes that store additional information. You can specify multiple values for these properties as a comma delimited list. Each Extension Custom Attribute property can hold up to 1,300 values. | String |
| Extension Custom Attribute 3 | The Extension Custom Attribute 1 through 5 specify the custom attributes that store additional information. You can specify multiple values for these properties as a comma delimited list. Each Extension Custom Attribute property can hold up to 1,300 values. | String |
| Extension Custom Attribute 4 | The Extension Custom Attribute 1 through 5 specify the custom attributes that store additional information. You can specify multiple values for these properties as a comma delimited list. Each Extension Custom Attribute property can hold up to 1,300 values. | String |
| Extension Custom Attribute 5 | The Extension Custom Attribute 1 through 5 specify the custom attributes that store additional information. You can specify multiple values for these properties as a comma delimited list. Each Extension Custom Attribute property can hold up to 1,300 values. | String |
| External OOF Options | The ExternalOofOptions property specifies the option to send an Out of Office message to external senders. | External InternalOnly |
| Federated Identity | Associates an on-premises Active Directory user with a Microsoft Office user. This property applies to objects in the cloud-based service, and it isn't available for on-premises deployments. Note This property isn't available in a Microsoft 365 environment. |
String |
| Force | Specifies whether to suppress the warning messages or confirmation messages that appear during specific configuration changes. | True, False |
| Forwarding Address | Specifies a forwarding address. | String |
| Forwarding SMTP Address | Specifies a forwarding SMTP address. | String |
| Grant Send On Behalf To | Specifies the DN list of other mailboxes that can send messages on behalf of this mailbox. | String |
| Hidden From Address Lists Enabled | Specifies whether this mailbox is hidden from other address lists. Default value is True, when selected. Note This property isn't available in the Live@edu environment. |
True, False |
| Ignore Default Scope | Instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using this property introduces the following restrictions: You can't use the DomainController property. The command uses an appropriate global catalog server automatically. You can only use the DN for the Identity property. Other forms of identification, such as alias or GUID, aren't accepted. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Immutable ID | This property is used by Outlook Live Directory Sync (OLSync) and it specifies a unique and immutable identifier. This identifies is in the form of an SMTP address for an Exchange mailbox that's used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If the federation is configured for this mailbox and you don't set this property when you create the mailbox, Exchange will create the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace. For example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You must set the Immutable ID property if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into off-premises mailboxes and if AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premise Exchange deployment scenario. | String |
| Issue Warning Quota | Specifies the mailbox size at which a warning message is sent to the user if that size is exceeded. The mailbox size must be either an integer or unlimited. If you set this attribute on a mailbox, that mailbox setting overrides the value set for this attribute on the mailbox database. Note This property isn't available in the Live@edu environment. |
String |
| Languages | Specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook Web App user interface, and Unified Messaging (UM) voice prompts. | String |
| Linked Domain Controller | Specifies the domain controller in the forest where the user account resides, if this mailbox is a linked mailbox. The domain controller in the forest where the user account resides is used to get security information for the account specified by the Linked Master Account property. Note This property is available only in an on-premises environment. |
String |
| Linked Domain Password | Specifies the password to use to access the domain controller that is specified by the Linked Domain Controller property. Note This property is available only in an on-premises environment. |
String |
| Linked Domain User Name | Specifies the user name to use to access the domain controller that is specified by the Linked Domain Controller property. Note This property is available only in an on-premises environment. |
String |
| Linked Master Account | Specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account to which the mailbox links. The master account grants access to the mailbox. You can use one of the following value types: GUID DN Domain\Account User principal name LegacyExchangeDN SmtpAddress Alias Note This property is available only in an on-premises environment. |
String |
| Litigation Hold Date | Specifies the date when the mailbox is placed on litigation hold. The property is populated automatically when placing a mailbox on litigation hold. This can be used for informational or reporting purposes. When using the activity place the mailbox on litigation hold, you can optionally specify any date as the Litigation Hold Date, but the mailbox is placed on litigation hold when the activity is run. Note This property isn't available in the Live@edu environment. |
DateTime |
| Litigation Hold Enabled | Specifies that the mailbox is under litigation hold and that messages can't be deleted from the user's account. After a mailbox is placed on litigation hold, deleted items and all versions of changed items are retained in the Recoverable Items folder. Items that are purged from the dumpster are also retained, and the items are held indefinitely. If you enable litigation hold, single-item recovery quotas aren't applied. Default value is True, when selected. Note This property isn't available in the Live@edu environment. |
True, False |
| Litigation Hold Owner | Specifies the user who placed the mailbox on litigation hold. The property is populated automatically when placing a mailbox on litigation hold. This can be used for informational and reporting purposes. Note This property isn't available in the Live@edu environment. |
String |
| Mail Tip | Specifies the message that is displayed to senders when they start drafting an e-mail message to this recipient. The message must be less than or equal to 250 characters. | String |
| Mail Tip Translations | Specifies additional languages when you want to provide the Mail Tip property information for this recipient in multiple languages. For each language, you must provide the locale, followed by a colon (:) and the specific Mail Tip property message in that language. Each Mail Tip property message must be less than or equal to 250 characters. Multiple languages can be separated by commas. | String |
| Mailbox Plan | Specifies the mailbox plan to associate with this mailbox. A mailbox plan specifies the permissions and features that are available to a mailbox user. The mailbox plan name that you provide must be included in the service plan of the organization in which this mailbox resides. This property is available for multi-tenant deployments. Note This property is available only in the Live@edu environment. |
String |
| Managed Folder Mailbox Policy | Specifies a Managed Folder mailbox policy that controls the messaging records management (MRM) for the mailbox. If configured with an empty value, Exchange removes the managed folder mailbox policy from the mailbox, but any managed folders in the mailbox remain. Note This property is available only in an on-premises environment. |
String |
| Managed Folder Mailbox Policy Allowed | This property bypasses the warning that the MRM features aren't supported for email clients that run versions of Outlook earlier than Outlook 2007. When a Managed Folder mailbox policy is assigned to a mailbox that uses the Managed Folder Mailbox Policy property, a warning appears by default, unless the Managed Folder Mailbox Policy Allowed property is enabled. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Max Blocked Senders | Specifies the maximum number of senders that can be included in the blocked senders list. Blocked senders are senders that are considered junk senders by the mailbox user and are used in junk email rules. This property is validated only when the junk email rules are updated using Outlook Web App or Web services. Note This property is available only in an on-premises environment. |
String |
| Max Receive Size | Maximum size of messages that this mailbox can receive. You must specify a value of either an integer or unlimited. Note This property is available only in an on-premises environment. |
String |
| Max Safe Senders | Specifies the maximum number of senders that can be included in the safe senders list. Safe senders are senders that are trusted by the mailbox user and are used in junk email rules. This property is only validated when the junk email rules are updated using cloud-based organizations or services. Note This property is available only in an on-premises environment. |
String |
| Max Send Size | Specifies the maximum size of messages that this mailbox can send. You must specify a value of either an integer or unlimited. Note This property is available only in an on-premises environment. |
String |
| Message Tracking Read Status Enabled | Specifies that this mailbox can view the read status of sent messages. When the value is set to False, the read status won't be displayed to senders who view the delivery reports for messages that they send to this user. Only the time that the message was delivered to the mailbox is available. Default value is True. | True, False |
| Moderated By | Specifies the users who are responsible for moderating the messages that are sent to this mailbox. To designate more than one user, separate the users with commas. This property is required if you set the Moderation Enabled property to True. | String |
| Moderation Enabled | Specifies whether to enable moderation for the mailbox. Default value is True, when selected. |
True, False |
| Name | Specifies the Name attribute for this mailbox. The Name attribute is used for the common name in Active Directory. | String |
| Office | Specifies the Microsoft Office attribute for this mailbox. | String |
| Offline Address Book | Specifies the associated offline address book (OAB). Note This property is available only in an on-premises environment. |
String |
| Password | The Password property resets the password of the user account that is associated with the cloud-based mailbox. This property applies to objects in the cloud-based service. It isn't available for on-premises deployments. This property is available for multi-tenant deployments. |
String |
| Password Confirm | Confirm the password. | String |
| Primary SMTP Address | Specifies the address that external users see when they receive a message from this mailbox. Can't be used with the Email Addresses property because the Email Addresses property includes the primary SMTP address. | String |
| Prohibit Send Quota | Specifies the mailbox size at which the user that is associated with this mailbox can no longer send messages. This size must have a value of either an integer or unlimited. When this attribute is configured on the mailbox, that mailbox setting overrides the value set for this attribute on the mailbox database. Note This property isn't available in the Live@edu environment. |
String |
| Prohibit Send Receive Quota | Specifies the mailbox size at which the user that is associated with this mailbox can no longer send or receive messages. This size must have a value of either an integer or unlimited. When this attribute is configured on the mailbox, that mailbox setting overrides the value set for this attribute on the mailbox database. Note This property isn't available in the Live@edu environment. |
String |
| Query Base DN Restriction Enabled | Specifies whether to restrict a user's ability to view or search for other mailboxes in their organization. If this property is set to True, the global address list (GAL) of the specified mailbox user isn't populated. Specifically, if the user views the GAL, it will appear empty. If this property is set to False, users can use the GAL to view all the mailboxes in their organization, including the mailboxes for which this property is set to True. Default value is False. This property is available for multi-tenant deployments. Default is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Recipient Limits | Specifies the maximum number of recipients per message that this mailbox can send. The number of recipients must have a value of either an integer or unlimited. When this attribute is configured on the mailbox, that mailbox setting overrides the value set for this attribute on the Hub Transport server. Note This property is available only in an on-premises environment. |
String |
| Recoverable Items Quota | Specifies the limit for the Recovery Items folder. When the limit is reached, items can't be added to the Recovery Items folder. Note This property is available only in an on-premises environment. |
String |
| Recoverable Items Warning Quota | Specifies the quota for when a warning event is entered in Event Viewer. Note This property is available only in an on-premises environment. |
String |
| Reject Messages From | Specifies a list of recipients from whom messages are rejected. | String |
| Reject Messages From DL Members | Specifies distribution lists (DL). Messages from any member of these distribution lists are rejected. | String |
| Reject Messages From Senders Or Members | Specifies a list of identity of recipients from whom messages are rejected. Can be one of the following value types: DN Canonical name GUID Name Display name Alias Exchange DN Primary SMTP email address |
String |
| Remove Managed Folder And Policy | Specifies whether to remove all MRM 1.0 policies and attributes from a mailbox. If you use this property, MRM 1.0 policies and MRM 1.0 properties from any managed folders that were created as part of any MRM 1.0 policies are removed. Managed folders that are empty are also removed from the mailbox, and managed folders that contain items are converted to standard folders. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Remove Picture | Specifies whether to remove the picture that a user has added to a mailbox. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Remove Spoken Name | Specifies whether to remove the spoken name that a user has added to a mailbox. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Require Sender Authentication Enabled | Specifies whether senders must be authenticated. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Reset Password On Next Logon | Requires users to change their Windows Live ID password the next time they sign in to their cloud-based mailbox. This property is active when the value is set to True. This property applies to objects in the cloud-based service. It isn't available for on-premises deployments. Default value is True, when selected. Note This property isn't available in a Microsoft 365 environment. |
True, False |
| Resource Capacity | Specifies the resource capacity, if this mailbox is a resource mailbox. The capacity must have a value of a non-negative integer. | String |
| Resource Custom | Specifies additional information about the resource. | String |
| Retain Deleted Items For | Specifies the length of time to keep deleted items. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. For example, to specify a 15-hour interval, enter 15:00:00. Note This property is available only in an on-premises environment. |
String |
| Retain Deleted Items Until Backup | Specifies whether to retain deleted items until the next backup. Default value is True, when selected. |
True, False |
| Retention Comment | Specifies a comment that is displayed in Outlook regarding the user's retention hold status. This comment can only be set if the Retention Hold Enabled property is set to True. This comment should be localized to the user's preferred language. Note This property is available only in an on-premises environment. |
String |
| Retention Hold Enabled | Specifies whether retention hold is enabled for messaging retention policies. To set the start date for retention hold, use the Start Date For Retention Hold property. Default value is True, when selected. |
True, False |
| Retention Policy | Specifies the name of a retention policy that you want to apply to this mailbox. Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. | String |
| Retention URL | Specifies the URL or an external Web page with additional details about the organization's messaging retention policies. This URL can be used to expose details regarding retention policies in general, which is usually a customized legal or IT website for the company. Note This property isn't available in the Live@edu environment. |
String |
| Role Assignment Policy | Specifies the management of the Role Assignment policy that you can assign to the mailbox when it's created or enabled. If the Assignment policy name contains spaces, the name must be enclosed in quotation marks ("). If you don't want to assign an Assignment policy when a mailbox is created or enabled, leave it empty. Note This property isn't available in the Live@edu environment. |
String |
| Rules Quota | Specifies the size limit of rules for this mailbox. When you enter a value, qualify the value with one of the following: B (bytes) KB (kilobytes) Unqualified values are treated as bytes. The default value for this property is 64 KB. The maximum value is 256 KB. Note The quota for mailbox rules applies only to enabled rules. There's no restriction on the number of disabled rules that a mailbox can have. However, the total size of rules that are enabled or active can't exceed the value that is specified for this property. Note This property isn't available in the Microsoft 365 environment. |
String |
| SAM Account Name | Specifies the user name for earlier operating systems, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This property is used to support clients and servers that run older versions of the operating system. This attribute must be less than 20 characters in length. Note This property is available only in an on-premises environment. |
String |
| SCL Delete Enabled | Specifies whether messages that meet the spam confidence level (SCL) threshold defined by the SCL Delete Threshold property are deleted. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| SCL Delete Threshold | Specifies the SCL at which a message is deleted, if the SCL Delete Enabled property is set to True. Note This property is available only in an on-premises environment. |
String |
| SCL Junk Enabled | Specifies whether messages that meet the SCL threshold specified by the SCL Junk Threshold property are moved to the Junk email folder. Note This property is available only in an on-premises environment. |
True, False |
| SCL Junk Threshold | Specifies the SCL threshold. Messages with an SCL greater than the value that you specify for the SCL Junk Threshold property are moved to the Junk email folder, if the SCL Junk Enabled property is set to True. Note This property is available only in an on-premises environment. |
String |
| SCL Quarantine Enabled | Specifies whether messages that meet the SCL threshold specified by the SCL Quarantine Threshold property are quarantined. If a message is quarantined, it's sent to the quarantine mailbox where the messaging administrator can review it. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| SCL Quarantine Threshold | Specifies the SCL at which a message is quarantined, if the SCL Quarantine Enabled property is set to True. | String |
| SCL Reject Enabled | Specifies whether messages that meet the SCL threshold specified by the SCL Reject Threshold property are rejected. If a message is rejected, it's deleted and a rejection response is sent to the sender. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| SCL Reject Threshold | Specifies the SCL at which a message is rejected, if the SCL Reject Enabled property is set to True. Note This property is available only in an on-premises environment. |
String |
| Secondary Address | Specifies the secondary address used by the UM-enabled user. | String |
| Secondary Dial Plan | Specifies a secondary UM dial plan to use. This property is provided to create a secondary proxy address. Note This property isn't available in a Live@edu environment. |
String |
| Send Moderation Notifications | Specifies whether status notifications are sent to users when a message that they sent to the moderated distribution group is rejected by one of the moderators. Set this property to Always if you want notifications to be sent to all senders. Set this property to Internal if you want notifications to be sent to only the senders that are internal to your organization. Set this property to Never to disable all status notifications. Default value is Never. |
Always Internal Never |
| Sharing Policy | Specifies the sharing policy associated with this mailbox. | String |
| Simple Display Name | Used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively. | String |
| Single Item Recovery Enabled | Specifies whether to prevent the Recovery Items folder from being purged. When this property is set to True, it prevents the Recovery Items folder from being purged. It prevents any items from being removed that have been deleted or edited. Default value is True, when selected. | True, False |
| Start Date For Retention Hold | Specifies the start date for retention hold for MRM. To use this property, the Retention Hold Enabled property must be set to True. | DateTime |
| Throttling Policy | Specifies the identity of the throttling policy for this mailbox. Note This property is available only in an on-premises environment. |
String |
| Type | Specifies the type for the mailbox. | Regular Room Equipment Shared |
| UM DTMF Map | Specifies a user-defined DTMF map for the UM-enabled user. Note This property isn't available in a Live@edu environment. |
String |
| Use Database Quota Defaults | Specifies that this mailbox uses the quota attributes that are specified for the mailbox database where this mailbox resides. The quota attributes are: ProhibitSendQuota ProhibitSendReceiveQuota IssueWarningQuota RulesQuota Default value is True, when selected. Note This property is available only in an on-premises environment. |
True, False |
| Usage Location | Note This property is available only in an on-premises environment. |
String |
| Use Database Retention Defaults | Specifies that this mailbox uses the Mailbox Retention attribute that is specified for the mailbox database where this mailbox resides. Note This property is available only in an on-premises environment. |
True, False |
| User Principal Name | Specifies the UPN for this mailbox. This is the sign-in name for the user. The UPN consists of a user name and a suffix. Typically, the suffix is the domain name where the user account resides. Note This property is available only in an on-premises environment. |
String |
| Windows Email Address | Specifies the Windows email address for this mailbox. This address isn't used by Exchange. | String |
| Windows Live ID(Live@edu only) | Renames the Windows Live ID associated with the mailbox. This property applies to objects in the cloud-based service. It isn't available for on-premises deployments. Note This property is available only in a Live@edu environment. |
String |
Published data for Update Mailbox activity
| Element | Description | Value type |
|---|---|---|
| Exchange Environment | Indicates the type of Exchange environment where this activity will be executed. | String |
| Exchange PowerShell Application | Specifies the application name segment of the connection URI. | String |
| Exchange Server Host | Specifies the connected Exchange Server. | String |
| Exchange Server Port | Specifies the connected Exchange Server port. | String |
| Exchange User Name | Specifies the username used to connect to Exchange Server. | String |
| Identity | Specifies the identity of the mailbox or mail user. | String |
| Skip CA Check | Indicates whether the client validates that the server certificate is signed by a trusted certification authority (CA) when connecting over Hypertext Transfer Protocol, over Secure Socket Layer. | String |
| Skip CN Check | Indicates whether the client validates that the certificate common name (CN) of the server matches the hostname of the server. | String |
| Skip Revocation Check | Indicates whether the connection doesn't validate the revocation status of the server certificate. | String |
| Use SSL | Indicates whether SSL encryption is used. | String |