Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-08-22

The Get-CASMailbox cmdlet returns a list of the attributes of a Microsoft Exchange Server 2007 mailbox on a computer that has the Client Access server role installed.

Syntax

get-CASMailbox [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]
get-CASMailbox [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]
get-CASMailbox [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

Parameters

Parameter Required Type Description

Anr

Optional

System.String

This parameter accepts a set of characters to perform an ambiguous name resolution search. The attributes that are searched include the following:

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

Credential

Optional

System.Management.Automation.PSCredential

This parameter specifies the account to use to read from the Active Directory directory service.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the domain controller to connect to for Active Directory validation.

Filter

Optional

System.String

This parameter specifies a set of attributes that are used to construct a query to retrieve a set of mailboxes. This parameter cannot be used together with the Database parameter.

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

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter can be the ADObjectID or a string that represents the GUID, distinguished name, domain\account, user principal name, legacy Exchange distinguished name, SMTP address, or alias.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

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

  • You cannot use the DomainController parameter. The command will use 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 are not accepted.

  • You cannot use the OrganizationalUnit and Identity parameters together.

You cannot use the Credential parameter.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

This parameter is used to limit the search to a specific container.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter specifies that the user information will be read from a domain controller in the user's domain. If you have set the recipient scope to include all recipients in the forest and if you do not use this parameter, the user information may be read from a global catalog server whose information is outdated. If you do 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 Exchange servers.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

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

SortBy

Optional

System.String

This parameter specifies the attribute that is used to sort the results. The results are sorted in ascending order.

Detailed Description

The Get-CASMailbox cmdlet returns a complete list of the attributes of a mailbox on an Exchange 2007 Client Access server. A variety of CASMailbox attributes are returned. The types of attributes that are returned include Outlook Web Access, 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 2007 computer that has the Mailbox server role installed. To run the Get-CASMailbox cmdlet, the account you use must be delegated the Exchange View-Only Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The following code 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