Applies to: Exchange Server 2013

Topic Last Modified: 2012-07-11

Use the Get-CASMailbox cmdlet to return a complete list of the attributes of a Microsoft Exchange Server 2013 mailbox.

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax


`Get-CASMailbox [-Anr <String>] <COMMON PARAMETERS>`


`Get-CASMailbox [-Identity <MailboxIdParameter>] <COMMON PARAMETERS>`


COMMON PARAMETERS: [-AccountPartition <AccountPartitionIdParameter>] [-ActiveSyncDebugLogging <SwitchParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-GetImapProtocolLog <SwitchParameter>] [-GetPopProtocolLog <SwitchParameter>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ProtocolSettings <SwitchParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SendLogsTo <MultiValuedProperty>] [-SortBy <String>]

COMMON PARAMETERS: [-AccountPartition
<AccountPartitionIdParameter>] [-ActiveSyncDebugLogging
<SwitchParameter>] [-Credential <PSCredential>]
[-DomainController <Fqdn>] [-Filter <String>]
[-GetImapProtocolLog <SwitchParameter>] [-GetPopProtocolLog
<SwitchParameter>] [-IgnoreDefaultScope
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-OrganizationalUnit
<OrganizationalUnitIdParameter>] [-ProtocolSettings
<SwitchParameter>] [-ReadFromDomainController
<SwitchParameter>] [-ResultSize <Unlimited>]
[-SendLogsTo <MultiValuedProperty>] [-SortBy
<String>]

Examples

EXAMPLE 1

This example returns all Client Access server mailbox details for the user Jeff Hay in the Contoso domain.

	Copy Code
Get-CASMailbox -Identity jeffhay@contoso.com

EXAMPLE 2

This example returns all Client Access server mailbox details for the user Tony Smith in the Contoso domain.

	Copy Code
Get-CASMailbox -Identity contoso\tonysmith

EXAMPLE 3

This example returns all Client Access server mailbox details for the user Tony Smith in the fourthcoffee domain.

	Copy Code
Get-CASMailbox -Identity fourthcoffee\tonysmith

Detailed Description

A variety of CASMailbox attributes are returned. The types of attributes returned include Microsoft Office Outlook Web App, Microsoft Exchange ActiveSync, POP3, and IMAP4.

By default, all attributes are returned for all mailboxes in the Exchange organization. You can filter these results by using the functionality in the Exchange Management Shell.

The Get-CASMailbox cmdlet can run only on an Exchange Mailbox server.

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 "Client Access user settings" entry in the Clients and Mobile Devices Permissions topic.

Parameters

Parameter

Required

Type

Description

AccountPartition

Optional

Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter

The AccountPartition parameter is reserved for Microsoft internal use.

ActiveSyncDebugLogging

Optional

System.Management.Automation.SwitchParameter

The ActiveSyncDebugLogging parameter specifies whether logging is enabled for Exchange ActiveSync for the mailbox.

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 that string. The default attributes searched are:

CommonName (CN)
DisplayName
FirstName
LastName
Alias

Credential

Optional

System.Management.Automation.PSCredential

The Credential parameter specifies the account to use to read from Active Directory.

This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.

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.

Filter

Optional

System.String

The Filter parameter indicates the OPath filter used to filter recipients.

For more information about the filterable properties, see Filterable Properties for the -Filter Parameter.

GetImapProtocolLog

Optional

System.Management.Automation.SwitchParameter

The GetImapProtocolLog parameter specifies whether to retrieve the IMAP protocol log.

GetPopProtocolLog

Optional

System.Management.Automation.SwitchParameter

The GetPopProtocolLog parameter specifies whether to retrieve the POP protocol log.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox ID. You can use the following values:

GUID
Distinguished name (DN)
User principal name (UPN)
SMTP address
Alias

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.
You can't use the OrganizationalUnit and Identity parameters together.
You can't use the Credential parameter.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter limits the search to a specific container.

ProtocolSettings

Optional

System.Management.Automation.SwitchParameter

The ProtocolSettings parameter returns the POP3, IMAP4, and SMTP server names for the mailbox.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you've set the recipient scope to include all recipients in the forest and you don't use this parameter, the user information may be read from a global catalog server whose information is outdated. If you use this parameter, multiple reads may be necessary to retrieve the information.

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

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. The default value is 1000.

SendLogsTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SendLogsTo parameter specifies an address to receive the log files.

SortBy

Optional

System.String

The SortBy parameter specifies the attribute used to sort the results. The results are sorted in ascending order.

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.