|
|
Line 1: |
Line 1: |
| {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Exchange Server Mailbox Management (OnPremise) |[[:Category:ITOM|Index]]}} | | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Exchange Server Mailbox Management (OnPremise) |[[:Category:ITOM|Index]]}} |
− | [[File:microsoft_logo.png|300px]] | + | [[File:microsoft_logo.png|300px]] [[File:Microsoft_Exchange_(2019-present).svg.png|150px]] |
− | {{IntroAndLinks|This package provides operations for On-Premise Exchange server mailbox management, supported for use on Exchange Server version 2016 and above. | + | {{IntroAndLinks|Provides operations for On-Premise Exchange server mailbox management. This package is supported for use on Exchange Server version 2016 and above. |
− | | |
− | ==Target Environment==
| |
− | This package utilises the Exchange Server Powershell provided by the Exchange Management Shell, which requires installation on the target device.
| |
− | | |
− | See the [https://docs.microsoft.com/en-us/exchange/plan-and-deploy/post-installation-tasks/install-management-tools?view=exchserver-2019 Install Exchange Management Tools] for more information
| |
| | | | | |
| <!-- Related Links go here --> | | <!-- Related Links go here --> |
Line 43: |
Line 38: |
| | | |
| <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> | | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> |
− | ===Get Mailbox Details=== | + | ===Get User Mailbox=== |
| <div class="mw-collapsible-content"> | | <div class="mw-collapsible-content"> |
| Returns the specified mailbox's properties | | Returns the specified mailbox's properties |
Line 49: |
Line 44: |
| ====Input Parameters==== | | ====Input Parameters==== |
| | | |
− | * <code>Identity</code> '''MANDATORY''' - Specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. | + | * <code>Identity</code> '''MANDATORY''' - Unique Identity of mailbox to be returned |
| | | |
| ====Output Parameters==== | | ====Output Parameters==== |
| | | |
| * <code>Name</code> | | * <code>Name</code> |
− | * <code>Type</code>
| |
| * <code>Alias</code> | | * <code>Alias</code> |
| * <code>EmailAddress</code> | | * <code>EmailAddress</code> |
| * <code>DistinguishedName</code> | | * <code>DistinguishedName</code> |
− | * <code>Database</code>
| |
− | * <code>ForwardingAddress</code>
| |
− | * <code>ForwardingSMTPAddress</code>
| |
− | * <code>DeliverToMailboxAndForward</code>
| |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL) | | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL) |
| * <code>errors</code> Any errors returned by the operation | | * <code>errors</code> Any errors returned by the operation |
Line 70: |
Line 60: |
| ===Create New Mailbox=== | | ===Create New Mailbox=== |
| <div class="mw-collapsible-content"> | | <div class="mw-collapsible-content"> |
− | Enables the creation of a user mailbox and linked Active Directory user account at the same time.
| + | Creates a New Exchange Mailbox and AD user account |
| | | |
| ====Input Parameters==== | | ====Input Parameters==== |
| | | |
− | * <code>UserPrincipalName</code> '''MANDATORY''' - Specifies the logon name for the user account. The UPN uses an email address format: username@domain. Typically, the domain value is the domain where the user account resides. | + | * <code>UserPrincipalName</code> '''MANDATORY''' - Provide the AD User principal name |
− | * <code>MailboxName</code> '''MANDATORY''' - The unique name of the mailbox. | + | * <code>MailboxName</code> '''MANDATORY''' - Provide the mailbox name |
− | * <code>FirstName</code> - Specifies the user's first name. | + | * <code>FirstName</code> - |
− | * <code>Lastname</code> - Specifies the user's last name. | + | * <code>Surname</code> - |
− | * <code>DisplayName</code> - Specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook. | + | * <code>DisplayName</code> - |
− | * <code>Password</code> '''MANDATORY''' - Specifies the password for the mailbox (the user account that's associated with the mailbox). | + | * <code>Password</code> '''MANDATORY''' - |
− | * <code>ResetPassword</code> - Specify if the user is required to change their password the next time they log on to their mailbox. | + | * <code>ResetPassword</code> - |
− | * <code>OrganisationalUnit</code> - Specifies the location in Active Directory where the new mailbox is created. | + | * <code>OrganisationalUnit</code> - |
− | * <code>Database</code> - Specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database.
| |
| | | |
| ====Output Parameters==== | | ====Output Parameters==== |
Line 97: |
Line 86: |
| ===Remove Mailbox=== | | ===Remove Mailbox=== |
| <div class="mw-collapsible-content"> | | <div class="mw-collapsible-content"> |
− | Enables the Deletion of a mailbox and the associated Active Directory user account.
| + | Remove the specified mailbox |
| | | |
| ====Input Parameters==== | | ====Input Parameters==== |
| | | |
− | * <code>Identity</code> '''MANDATORY''' - Identifies the mailbox that you want to remove. You can use any value that uniquely identifies the mailbox. | + | * <code>Identity</code> '''MANDATORY''' - Mailbox Identity |
− | * <code>Permanent</code> - specifies whether to permanently delete the mailbox from the mailbox database. | + | * <code>Permanent</code> - Permanently remove mailbox |
| | | |
| ====Output Parameters==== | | ====Output Parameters==== |
Line 114: |
Line 103: |
| ===Enable Mailbox=== | | ===Enable Mailbox=== |
| <div class="mw-collapsible-content"> | | <div class="mw-collapsible-content"> |
− | Creates a mailbox for an existing user who doesn't already have an associated mailbox. | + | Creates a new mailbox for an existing AD account |
| | | |
| ====Input Parameters==== | | ====Input Parameters==== |
Line 127: |
Line 116: |
| * <code>DistinguishedName</code> | | * <code>DistinguishedName</code> |
| * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL) | | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL) |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Create New Room Mailbox===
| |
− | <div class="mw-collapsible-content">
| |
− | Enables the creation of an Exchange Room mailbox and linked Active Directory user account at the same time.
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>MailboxName</code> '''MANDATORY''' - Specifies the unique name of the mailbox. The maximum length is 64 characters.
| |
− | * <code>UserPrincipalName</code> - The logon name for the user account. The UPN uses an email address format: username@domain.
| |
− | * <code>FirstName</code> - Specifies the user's first name.
| |
− | * <code>Surname</code> - Specifies the user's last name.
| |
− | * <code>DisplayName</code> - Specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook.
| |
− | * <code>OrganisationalUnit</code> - Specifies the location in Active Directory where the new mailbox is created.
| |
− | * <code>Alias</code> - Specifies the Exchange alias (also known as the mail nickname) for the recipient.
| |
− | * <code>Database</code> - Specifies the mailbox database that contains the mailbox.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>Name</code>
| |
− | * <code>Alias</code>
| |
− | * <code>EmailAddress</code>
| |
− | * <code>DistinguishedName</code>
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Create Equipment Mailbox===
| |
− | <div class="mw-collapsible-content">
| |
− | Enables the creation of an Exchange Equipment mailbox and linked Active Directory user account at the same time.
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>MailboxName</code> '''MANDATORY''' - Specifies the unique name of the mailbox. The maximum length is 64 characters.
| |
− | * <code>UserPrincipalName</code> - The logon name for the user account. The UPN uses an email address format: username@domain.
| |
− | * <code>FirstName</code> - Specifies the user's first name.
| |
− | * <code>Surname</code> - Specifies the user's last name.
| |
− | * <code>DisplayName</code> - Specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook.
| |
− | * <code>OrganisationalUnit</code> - Specifies the location in Active Directory where the new mailbox is created.
| |
− | * <code>Alias</code> - Specifies the Exchange alias (also known as the mail nickname) for the recipient.
| |
− | * <code>Database</code> - Specifies the mailbox database that contains the mailbox.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>Name</code>
| |
− | * <code>Alias</code>
| |
− | * <code>EmailAddress</code>
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Set SMTP Forwarding===
| |
− | <div class="mw-collapsible-content">
| |
− | Enable SMTP Forwarding and how messages are delivered and forwarded.
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>MailboxName</code> '''MANDATORY''' - Specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox..
| |
− | * <code>ForwardingSMTPAddress</code> '''MANDATORY''' - Specifies a forwarding SMTP address for messages that are sent to this mailbox. Typically, you use this parameter to specify external email addresses that aren't validated.
| |
− | * <code>DeliverAndForward</code> - Specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: $true: Messages are delivered to this mailbox and forwarded to the specified recipient or email address. $false: If a forwarding recipient or email address is configured, messages are delivered only to the specified recipient or email address, and messages aren't delivered to this mailbox. If no forwarding recipient or email address is configured, messages are delivered only to this mailbox.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Set Mailbox Forwarding===
| |
− | <div class="mw-collapsible-content">
| |
− | Enable Internal Mail Forwarding and how messages are delivered and forwarded.
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>MailboxName</code> '''MANDATORY''' - Specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox.
| |
− | * <code>ForwardingMailbox</code> '''MANDATORY''' - Specifies a forwarding address in your organization for messages that are sent to this mailbox. You can use any value that uniquely identifies the internal recipient.
| |
− | * <code>DeliverAndForward</code> - Specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters. Valid values are: $true: Messages are delivered to this mailbox and forwarded to the specified recipient or email address. $false: If a forwarding recipient or email address is configured, messages are delivered only to the specified recipient or email address, and messages aren't delivered to this mailbox. If no forwarding recipient or email address is configured, messages are delivered only to this mailbox.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Remove SMTP Forwarding===
| |
− | <div class="mw-collapsible-content">
| |
− | Disable SMTP Forwarding
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>MailboxName</code> '''MANDATORY''' - Specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox.
| |
− | * <code>DeliverAndForward</code> - Specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Remove Mailbox Forwarding===
| |
− | <div class="mw-collapsible-content">
| |
− | Disable Internal Mail Forwarding
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>MailboxName</code> '''MANDATORY''' - Specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox.
| |
− | * <code>DeliverAndForward</code> - Specifies the message delivery behavior when a forwarding address is specified by the ForwardingAddress or ForwardingSmtpAddress parameters.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Add Mailbox Permission===
| |
− | <div class="mw-collapsible-content">
| |
− | Use to add permissions to a mailbox, from the following list:
| |
− |
| |
− | ChangeOwner, ChangePermission, DeleteItem, ExternalAccount
| |
− | FullAccess, ReadPermission
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>UserName</code> '''MANDATORY''' - Specifies who gets the permissions on the mailbox. You can specify the following types of users or groups (security principals) for this parameter: Mailbox users Mail users Security groups
| |
− | * <code>AccessRights</code> '''MANDATORY''' - Specifies the permission that you want to add for the user on the mailbox. Valid values are: ChangeOwner ChangePermission DeleteItem ExternalAccount FullAccess ReadPermission
| |
− | * <code>InheritanceType</code> - Specifies how permissions are inherited by folders in the mailbox
| |
− | * <code>AutoMapping</code> - Specifies whether to enable or disable the auto-mapping feature in Microsoft Outlook that uses Autodiscover to automatically open other mailboxes for the user.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>Identity</code>
| |
− | * <code>User</code>
| |
− | * <code>AccessRights</code>
| |
− | * <code>IsInherited</code>
| |
− | * <code>InheritanceType</code>
| |
− | * <code>Deny</code>
| |
− | * <code>ObjectState</code>
| |
− | * <code>IsValid</code>
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Remove Mailbox Permission===
| |
− | <div class="mw-collapsible-content">
| |
− | Use to remove mailbox permissions, from the following list:
| |
− |
| |
− | ChangeOwner, ChangePermission, DeleteItem, ExternalAccount
| |
− | FullAccess, ReadPermission
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>UserName</code> '''MANDATORY''' - Specifies whose permissions are being removed from the specified mailbox. You can specify the following types of users or groups (security principals) for this parameter: Mailbox users Mail users Security groups
| |
− | * <code>AccessRights</code> '''MANDATORY''' - Specifies the permission that you want to remove from the user on the mailbox. Valid values are: FullAccess SendAs ExternalAccount DeleteItem ReadPermission ChangePermission ChangeOwner
| |
− | * <code>InheritanceType</code> - Specifies whether permissions are inherited to folders within the mailbox.
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Add Mailbox Send As Permission===
| |
− | <div class="mw-collapsible-content">
| |
− | Set the Send As permission for a user on the specified mailbox
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>UserName</code> '''MANDATORY''' - Specifies who gets the permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: Mailbox users Mail users Security groups
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>User</code>
| |
− | * <code>Identity</code>
| |
− | * <code>Deny</code>
| |
− | * <code>InheritanceType</code>
| |
− | * <code>ExtendedRights</code>
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Remove Mailbox Send As Permission===
| |
− | <div class="mw-collapsible-content">
| |
− | Remove the Send As permission for a user on the specified mailbox
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>UserName</code> '''MANDATORY''' - Specifies who gets the permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: Mailbox users Mail users Security groups
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Add Mailbox Send On Behalf Permission===
| |
− | <div class="mw-collapsible-content">
| |
− | Set the Send On Behalf permission for a user on the specified mailbox
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>UserName</code> '''MANDATORY''' - Specifies who gets the permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: Mailbox users Mail users Security groups
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Remove Mailbox Send On Behalf Permission===
| |
− | <div class="mw-collapsible-content">
| |
− | Remove the Send On Behalf permission for a user on the specified mailbox
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>UserName</code> '''MANDATORY''' - Specifies who gets the permissions on the Active Directory object. You can specify the following types of users or groups (security principals) for this parameter: Mailbox users Mail users Security groups
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Move Mailbox To Another Database===
| |
− | <div class="mw-collapsible-content">
| |
− | Begin the process of an asynchronous mailbox or personal archive move. The operation will probe the process and finish once the mailbox has is moved. A configurable timeout defaulted to 1 hour allows the operation to exit, leaving the move process still running. The outcome will be a warning in the event of a timeout,
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identy</code> '''MANDATORY''' - Specifies the mailbox where you want to assign permissions to the user
| |
− | * <code>TargetDB</code> '''MANDATORY''' - Specifies the destination mailbox database for the mailbox. You can use any value that uniquely identifies the database. For example: Name Distinguished name (DN) GUID
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>ExchangeGuid</code>
| |
− | * <code>MailboxIdentity</code>
| |
− | * <code>DisplayName</code>
| |
− | * <code>RecipienttypeDetails</code>
| |
− | * <code>SourceDatabase</code>
| |
− | * <code>TargetDatabase</code>
| |
− | * <code>TotalMailboxSize</code>
| |
− | * <code>TotalMailboxItemCount</code>
| |
− | * <code>OverallDuration</code>
| |
− | * <code>Status</code>
| |
− | * <code>StatusDetail</code>
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− | * <code>warnings</code>
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Disable Mailbox===
| |
− | <div class="mw-collapsible-content">
| |
− | Removes the mailbox's Exchange attributes from Active Directory. The mailbox isn't deleted and can be reconnected to its user later by using the Connect Mailbox operation.
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identity</code> '''MANDATORY''' - Specifies the mailbox that you want to disable. You can use any value that uniquely identifies the mailbox
| |
− | * <code>DomainController</code> - Specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
− | * <code>errors</code> Any errors returned by the operation
| |
− |
| |
− | </div></div>
| |
− |
| |
− | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
− | ===Connect Mailbox===
| |
− | <div class="mw-collapsible-content">
| |
− | Connects disconnected mailboxes to existing user accounts that don't already have mailboxes.
| |
− |
| |
− | Be aware that linking a mailbox to an existing user account gives them full access to the mailbox and all mail in the mailbox.
| |
− |
| |
− | ====Input Parameters====
| |
− |
| |
− | * <code>Identity</code> '''MANDATORY''' - Specifies the mailbox that you want to connect to a user account. This parameter doesn't specify an Active Directory object. You can use the following values to identify the mailbox: [Display name, GUID, LegacyExchangeDN]
| |
− | * <code>Database</code> '''MANDATORY''' - Specifies the Exchange database that contains the mailbox that you want to connect. You can use any value that uniquely identifies the database.
| |
− | * <code>User</code> '''MANDATORY''' - Specifies the user object in Active Directory that you want to connect the mailbox to. You can use any value that uniquely identifies the user.
| |
− | * <code>DomainController</code> - specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN)
| |
− | * <code>Equipment</code> - Required to connect equipment mailboxes
| |
− | * <code>Room</code> - Required to connect room mailboxes
| |
− | * <code>Shared</code> - Required to connect shared mailboxes
| |
− |
| |
− | ====Output Parameters====
| |
− |
| |
− | * <code>outcome</code> The outcome of the operation (OK/FAIL)
| |
| * <code>errors</code> Any errors returned by the operation | | * <code>errors</code> Any errors returned by the operation |
| | | |