Set Mailbox activity

The Set Mailbox activity modifies the settings of an existing Microsoft Exchange mailbox.

Use the optional parameters variable to pass specific values to the Exchange server. This activity implements the Microsoft Exchange Set-Mailbox command.

To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Exchange > Mailbox.

Note: This activity replaces an Exchange activity by the same name available in releases prior to Geneva. If you have a workflow created in a previous version that uses the deprecated activity, your workflow will continue to work normally after upgrading to Geneva. However, all new workflows must use the custom version of this activity. This activity was built with the PowerShell activity designer, which gives workflow administrators the ability to store input and output variables in the databus.

Input variables

Table 1. Set Mailbox input variables
Variable	Description
hostname	The hostname of the Exchange server with which the activity interacts. Do not enter an IP address in this variable.
domain	The name of the Exchange server's assigned domain.
user	Active Directory user whose mailbox you want to modify. The activity passes this value to Exchange as the Identity Exchange variable.
parameters	Optional parameters to pass to the Exchange server written in JavaScript Object Notation (JSON). Exchange activities cannot pass parameters that reference an object, such as a PSCredential object. Plain text is automatically converted to SecureString objects for parameters that require that data type. Attempting to save an activity that specifies duplicate parameters, including parameters from activity variables, or incorrectly formatted JSON causes a warning message to appear. Note: When passing a switch parameter, such as ForceUpgrade, you must use the format "parameter":"true".

Output variables

Table 2. Set Mailbox output variables
Variable	Description
result	Either success or failure.
error	Error message if the operation fails.

Conditions

Table 3. Set Mailbox conditions
Conditions	Description
Success	The activity succeeded in modifying the settings of the specified mailbox.
Failure	The activity failed to modify the settings of the specified mailbox.

Set Mailbox activity

The Set Mailbox activity modifies the settings of an existing Microsoft Exchange mailbox.

Use the optional parameters variable to pass specific values to the Exchange server. This activity implements the Microsoft Exchange Set-Mailbox command.

To access this activity in the Workflow Editor, select the Custom tab, and then navigate to Custom Activities > Exchange > Mailbox.

Input variables

Table 1. Set Mailbox input variables
Variable	Description
hostname	The hostname of the Exchange server with which the activity interacts. Do not enter an IP address in this variable.
domain	The name of the Exchange server's assigned domain.
user	Active Directory user whose mailbox you want to modify. The activity passes this value to Exchange as the Identity Exchange variable.
parameters	Optional parameters to pass to the Exchange server written in JavaScript Object Notation (JSON). Exchange activities cannot pass parameters that reference an object, such as a PSCredential object. Plain text is automatically converted to SecureString objects for parameters that require that data type. Attempting to save an activity that specifies duplicate parameters, including parameters from activity variables, or incorrectly formatted JSON causes a warning message to appear. Note: When passing a switch parameter, such as ForceUpgrade, you must use the format "parameter":"true".

Output variables

Table 2. Set Mailbox output variables
Variable	Description
result	Either success or failure.
error	Error message if the operation fails.

Conditions

Table 3. Set Mailbox conditions
Conditions	Description
Success	The activity succeeded in modifying the settings of the specified mailbox.
Failure	The activity failed to modify the settings of the specified mailbox.

How search works:

Topics are ranked in search results by how closely they match your search terms

Set Mailbox activity

Set Mailbox activity

Input variables

Output variables

Conditions

On this page

Set Mailbox activity

Set Mailbox activity

Input variables

Output variables

Conditions

Log in to personalize your search results and subscribe to topics