Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-18
Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-SiteMailbox <COMMON PARAMETERS>
|
Get-SiteMailbox [-BypassOwnerCheck
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-AccountPartition
<AccountPartitionIdParameter>] [-Anr <String>]
[-DomainController <Fqdn>] [-Identity
<RecipientIdParameter>] [-ResultSize
<Unlimited>]
|
Examples
EXAMPLE 1
This example returns the default information about the site mailbox ContentSite, which includes the site name, when the site mailbox was closed, and the SharePoint URL.
 Copy Code |
|
|---|---|
Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite |
|
EXAMPLE 2
This example returns the full information about the site mailbox ContentSite.
| Copy Code |
|
|---|---|
Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite | Format-List |
|
Detailed Description
If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error.
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 |
|---|---|---|---|
|
AccountPartition |
Optional |
Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter |
This parameter is reserved for internal Microsoft use. |
|
Anr |
Optional |
System.String |
The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches the string. The default attributes searched are:
|
|
BypassOwnerCheck |
Optional |
System.Management.Automation.SwitchParameter |
The BypassOwnerCheck parameter is used by administrators who aren't members or owners of the site mailbox. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The Identity parameter specifies the identity of the site mailbox. You can use one of the following values:
|
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter specifies the maximum number of
results to return. If you want to return all site mailboxes that
match the query, use |
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.