Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Get-SiteMailbox

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2013-04-12

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.

Get-SiteMailbox <COMMON PARAMETERS>
Get-SiteMailbox [-BypassOwnerCheck <SwitchParameter>] [-DeletedSiteMailbox <SwitchParameter>] [-Organization <OrganizationIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AccountPartition <AccountPartitionIdParameter>] [-Anr <String>] [-DomainController <Fqdn>] [-Identity <RecipientIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>]

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.

Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite

This example returns the full information about the site mailbox ContentSite.

Get-SiteMailbox -BypassOwnerCheck -Identity ContentSite | Format-List

This example queries for site mailboxes that are marked for deletion and removes them from the mailbox database by pipelining the Remove-Mailbox cmdlet.

Get-SiteMailbox -BypassOwnerCheck -DeletedSiteMailbox | Remove-Mailbox -Confirm:$false

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.

 

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:

  • CommonName (CN)

  • DisplayName

  • Name

  • Alias

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.

DeletedSiteMailbox

Optional

System.Management.Automation.SwitchParameter

The DeletedSiteMailbox parameter returns site mailboxes that have been marked for pending deletion.

When the lifecycle application in SharePoint closes a site mailbox, the site mailbox is retained for the period specified in the lifecycle policy in the closed state. The mailbox can then be reactivated by an end user or by a SharePoint administrator. After the retention period, the Exchange site mailbox that’s housed in the mailbox database will have its name prepended with MDEL: to indicate that it has been marked for deletion. To free storage space and the alias, use the Remove-Mailbox cmdlet to manually remove these site mailboxes from the mailbox database.

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:

  • GUID

  • Distinguished name (DN)

  • Display name

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch.

NoteNote:
By default, the recipient scope is set to the domain that hosts your Exchange servers.

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 unlimited for the value of this parameter. The default value is 1000.

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.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.