Commands › Exchange Online

Get-RemoteMailbox

Exchange Online ExchangeOnlineManagement Get-*

Retrieve the mail-related attributes of users in the on-premises organization that have associated mailboxes in the cloud-based service.

Quick start script

# Get-RemoteMailbox — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Get-RemoteMailbox | Format-List

# 3. Export for evidence / drift tracking
Get-RemoteMailbox | Export-Clixml .\RemoteMailbox-$(Get-Date -Format yyyyMMdd).xml

Syntax — 2 parameter sets

AnrSet

Get-RemoteMailbox [-Anr <String>]
 [-Archive]
 [-Credential <PSCredential>]
 [-DomainController <Fqdn>]
 [-Filter <String>]
 [-IgnoreDefaultScope]
 [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
 [-ReadFromDomainController]
 [-ResultSize <Unlimited>]
 [-SortBy <String>] [<CommonParameters>]

Identity

Get-RemoteMailbox [[-Identity] <RemoteMailboxIdParameter>]
 [-Archive]
 [-Credential <PSCredential>]
 [-DomainController <Fqdn>]
 [-Filter <String>]
 [-IgnoreDefaultScope]
 [-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
 [-ReadFromDomainController]
 [-ResultSize <Unlimited>]
 [-SortBy <String>] [<CommonParameters>]

Parameters (11)

ParameterTypeRequiredWhat it controls
-Identity RemoteMailboxIdParameter The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. For example:
-Anr 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...
-Archive SwitchParameter The Archive switch is required to return the user's archive mailbox in the results. You don't need to specify a value with this switch.
-Credential PSCredential The Credential parameter specifies the username 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.
-DomainController Fqdn The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-Filter String The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.
-IgnoreDefaultScope SwitchParameter The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch.
-OnPremisesOrganizationalUnit OrganizationalUnitIdParameter The OnPremisesOrganizationalUnit parameter filters the results by the object's location in Active Directory.
-ReadFromDomainController SwitchParameter The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch.
-ResultSize 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.
-SortBy String The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.