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

Get-CASMailbox

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-12

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-CASMailbox cmdlet to view the client access settings that are configured on a mailbox.

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

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

This example returns the values of the following client access settings for the user named Jeff Hay.

  • ActiveSyncEnabled

  • OWAEnabled

  • PopEnabled

  • ImapEnabled

  • MapiEnabled

Get-CASMailbox "Jeff Hay"

This example returns all IMAP4 settings for the user tony@contoso.com.

Get-CASMailbox tony@contoso.com | Format-List Imap*

This example returns all Exchange Web Services settings for the user chris@contoso.com.

Get-CASMailbox chris@contoso.com | Format-List Ews*

This cmdlet returns a variety of client access settings for one or more mailboxes. These settings include options for Microsoft Outlook Web App, Microsoft Exchange ActiveSync, POP3, and IMAP4.

The Get-CASMailbox cmdlet can run only on a 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.

 

Parameter Required Type Description

AccountPartition

Optional

Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter

This parameter is reserved for internal Microsoft use.

ActiveSyncDebugLogging

Optional

System.Management.Automation.SwitchParameter

The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. If you don't use this switch, the value always appears as $false.

To see this value, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List.

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 user name and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions.

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

This parameter is available only in on-premises Exchange 2013.

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

This parameter is reserved for internal Microsoft use.

GetPopProtocolLog

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox that you want to view.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

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.

Monitoring

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The Monitoring switch includes mailboxes that were created by monitoring accounts in the results. By default, these mailboxes aren't included in the results. You don't have to specify a value with this switch.

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 the specified organizational unit (OU). You can use any value that uniquely identifies the OU. For example:

  • Distinguished name (DN)

    Example: OU=Users,DC=contoso,DC=com

  • Canonical name (CN)

    Example: contoso.com/Users

  • GUID

    Example: 8d3d920d-fe9c-4432-8b94-d84027f5d627

ProtocolSettings

Optional

System.Management.Automation.SwitchParameter

The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:

  • ExternalImapSettings

  • InternalImapSettings

  • ExternalPopSettings

  • InternalPopSettings

  • ExternalSmtpSettings

  • InternalSmtpSettings

To see these values, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The ReadFromDomainController switch 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.

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 requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

SendLogsTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

SortBy

Optional

System.String

The SortBy parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. The results are sorted in ascending order.

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.