Applies to: Exchange Server 2013
Topic Last Modified: 2012-08-02
Use the Test-SiteMailbox cmdlet to test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Test-SiteMailbox [-BypassOwnerCheck
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-SharePointUrl <Uri>]
[-Confirm [<SwitchParameter>]] [-Identity
<RecipientIdParameter>] [-RequestorIdentity
<RecipientIdParameter>] [-UseAppTokenOnly
<SwitchParameter>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
The example tests a SharePoint site's connectivity only. You can use this command before creating a site mailbox or if you're having a problem creating a site mailbox.
 Copy Code |
|
|---|---|
Test-SiteMailbox -BypassOwnerCheck -SharePointUrl "https://myserver/teams/edu" |
|
EXAMPLE 2
This example tests the Exchange server connectivity with an existing site mailbox using the Identity and UseAppTokenOnly parameters. The Identity parameter specifies the site mailbox, and the UseAppTokenOnly parameter specifies that you want to test under the identity of the Exchange server. Run this command for troubleshooting documentation synchronization issues.
| Copy Code |
|
|---|---|
Test-SiteMailbox -BypassOwnerCheck -Identity mysitemailbox@contoso.com -UseAppTokenOnly |
|
EXAMPLE 3
This example tests a specific user's ability to access a SharePoint site by using the RequestorIdentity parameter.
| Copy Code |
|
|---|---|
Test-SiteMailbox -BypassOwnerCheck -RequestorIdentity "kweku@contoso.com" -SharePointUrl "https://myserver/teams/edu" |
|
Detailed Description
If you don't specify the RequestorIdentity parameter, the command uses the identification of the user running this command.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the"Site mailboxes" entry in the Sharing and Collaboration Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
BypassOwnerCheck |
Optional |
System.Management.Automation.SwitchParameter |
The BypassOwnerCheck parameter specifies that the user running this command isn't the owner of the site mailbox being tested. If you're running this command and you aren't the owner of the site mailbox, you must use this parameter for the command to complete successfully. You don't have to supply a value with this parameter. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The Identity parameter specifies the identity of the site mailbox. You can use any of the following values:
You can't use this parameter in conjunction with the SharePointUrl parameter. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
RequestorIdentity |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The RequestorIdentity parameter specifies the identity of a user for whom you want to test to make sure that they have the correct permissions to connect to the SharePoint site mailbox. If you don't specify this parameter, the command uses the identification of the user running this command. You can use any of the following values:
You can't use this parameter in conjunction with the UseAppTokenOnly parameter. |
|
SharePointUrl |
Optional |
System.Uri |
The SharePointUrl parameter specifies the SharePoint URL
where the site mailbox is hosted, for example,
You can't use this parameter in conjunction with the Identity parameter. |
|
UseAppTokenOnly |
Optional |
System.Management.Automation.SwitchParameter |
The UseAppTokenOnly parameter specifies that you want to test under the identity of the Exchange server. You can't use this cmdlet in conjunction with the RequestorIdentity parameter. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.