Get-Mailbox

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。

使用 Get-Mailbox cmdlet 可以查看邮箱对象和属性、填充属性页或向其他任务提供邮箱信息。

注意:在 Exchange Online PowerShell 中,建议使用 Get-EXOMailbox cmdlet 而不是此 cmdlet。 有关详细信息,请参阅使用远程 PowerShell 连接到 Exchange Online

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

Get-Mailbox
   [-Anr <String>]
   [-Arbitration]
   [-Archive]
   [-AuditLog]
   [-AuxAuditLog]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-GroupMailbox]
   [-IgnoreDefaultScope]
   [-InactiveMailboxOnly]
   [-IncludeEmailAddressDisplayNames]
   [-IncludeInactiveMailbox]
   [-Migration]
   [-Monitoring]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-ReadFromDomainController]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-RemoteArchive]
   [-ResultSize <Unlimited>]
   [-ServiceSafetyConfiguration]
   [-SoftDeletedMailbox]
   [-SortBy <String>]
   [-SupervisoryReviewPolicy]
   [<CommonParameters>]
Get-Mailbox
   [-Database <DatabaseIdParameter>]
   [-Arbitration]
   [-Archive]
   [-AuditLog]
   [-AuxAuditLog]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-GroupMailbox]
   [-IgnoreDefaultScope]
   [-Migration]
   [-Monitoring]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-ReadFromDomainController]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-RemoteArchive]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-SupervisoryReviewPolicy]
   [<CommonParameters>]
Get-Mailbox
   [[-Identity] <MailboxIdParameter>]
   [-Arbitration]
   [-Archive]
   [-AuditLog]
   [-AuxAuditLog]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-GroupMailbox]
   [-IgnoreDefaultScope]
   [-InactiveMailboxOnly]
   [-IncludeEmailAddressDisplayNames]
   [-IncludeInactiveMailbox]
   [-Migration]
   [-Monitoring]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-ReadFromDomainController]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-RemoteArchive]
   [-ResultSize <Unlimited>]
   [-ServiceSafetyConfiguration]
   [-SoftDeletedMailbox]
   [-SortBy <String>]
   [-SupervisoryReviewPolicy]
   [<CommonParameters>]
Get-Mailbox
   [-Server <ServerIdParameter>]
   [-Arbitration]
   [-Archive]
   [-AuditLog]
   [-AuxAuditLog]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-GroupMailbox]
   [-IgnoreDefaultScope]
   [-Migration]
   [-Monitoring]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-ReadFromDomainController]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-RemoteArchive]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-SupervisoryReviewPolicy]
   [<CommonParameters>]
Get-Mailbox
   [-MailboxPlan <MailboxPlanIdParameter>]
   [-Archive]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeEmailAddressDisplayNames]
   [-IncludeInactiveMailbox]
   [-Migration]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PublicFolder]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-ServiceSafetyConfiguration]
   [-SoftDeletedMailbox]
   [-SortBy <String>]
   [<CommonParameters>]

说明

在本地 Exchange 环境中使用 Get-Mailbox cmdlet 查看邮箱的配额设置时,首先需要检查 UseDatabaseQuotaDefaults 属性的值。 值 True 意味着将忽略每个邮箱的配额设置,您需要使用 Get-MailboxDatabase cmdlet 查看实际值。 如果 UseDatabaseQuotaDefaults 属性是 False,将使用每个邮箱配额设置,所以使用 Get-Mailbox cmdlet 查看到的将是该邮箱的实际配额值。

您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

示例

示例 1

Get-Mailbox -ResultSize unlimited

本示例返回贵组织中所有邮箱的摘要列表。

示例 2

Get-Mailbox -OrganizationalUnit Users

本示例返回贵组织内名为 Users 的 OU 中所有邮箱的列表。

示例 3

Get-Mailbox -Anr Chr

本示例将返回对字符串“Chr”进行不明确名称解析搜索处理后得到的所有邮箱。 本示例返回 Chris Ashton、 Christian Hess 和 Christa Geller 等用户的邮箱。

示例 4

Get-Mailbox -Archive -Database MBXDB01

此示例返回名为 MBXDB01 的数据库中的所有存档邮箱的摘要列表。

示例 5

Get-Mailbox -Identity ed@contoso.com -RemoteArchive

此示例返回有关用户 ed@contoso.com的远程存档邮箱的信息。

参数

-Anr

Anr 参数指定字符串,用于执行模糊名称解析 (ANR) 搜索。 可以指定部分字符串,并搜索其属性与该字符串匹配的对象。 搜索的默认属性是:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • 别名
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Arbitration

此参数只在本地 Exchange 中可用。

仲裁开关指定是否在结果中仅返回仲裁邮箱。 不必为此开关指定值。

仲裁邮箱是用于存储不同类型的系统数据和管理邮件审批工作流的系统邮箱。

若要返回用于存储审核日志设置或数据的仲裁邮箱,请不要使用此开关。 请改用 AuditLog 或 AuxAuditLog 开关。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Archive

存档开关指定是否仅返回结果中启用了存档的邮箱。 不必为此开关指定值。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-AuditLog

此参数只在本地 Exchange 中可用。

AuditLog 开关指定是否在结果中仅返回审核日志邮箱。 不必为此开关指定值。

审核日志邮箱是用于存储审核日志设置的仲裁邮箱。

若要返回其他类型的仲裁邮箱,请不要使用此开关。 请改用仲裁开关。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-AuxAuditLog

此参数只在本地 Exchange 中可用。

AuxAuditLog 开关指定是否在结果中仅返回辅助审核日志邮箱。 不必为此开关指定值。

审核日志邮箱是用于存储审核日志设置的仲裁邮箱。

若要返回其他类型的仲裁邮箱,请不要使用此开关。 请改用仲裁开关。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Credential

此参数只在本地 Exchange 中可用。

Credential 参数指定用于运行此命令的用户名和密码。 通常情况下,您可以在脚本中或在需要提供具有所需权限的不同凭据时使用此参数。

此参数的值需要 Get-Credential cmdlet。 要暂停此命令并接收凭据提示,请使用值 (Get-Credential)。 或者,在运行此命令之前,请将凭据存储在变量(例如,$cred = Get-Credential)中,然后将变量名称 ($cred) 用作此参数。 有关详细信息,请参阅 Get-Credential

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Database

此参数只在本地 Exchange 中可用。

Database 参数按邮箱数据库筛选结果。 使用此参数时,仅将指定的数据库中的邮箱包含在结果中。 可以使用任何能够唯一标识该数据库的值。 例如:

  • 名称
  • 可分辨名称 (DN)
  • GUID

此参数不能与 Anr、Identity 或 Server 参数一起使用。

Type:DatabaseIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

此参数只在本地 Exchange 中可用。

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Filter

Filter 参数使用 OPATH 语法按指定的属性和值筛选结果。 搜索条件使用 语法 "Property -ComparisonOperator 'Value'"

  • 将整个 OPATH 筛选器括在双引号“”中。 如果筛选器包含系统值 (,例如 $true$false$null) ,请改用单引号 ' 。 虽然此参数是 (不是系统块) 的字符串,但也可以使用大括号 { },但前提是筛选器不包含变量。
  • 属性是可筛选的属性。 有关可筛选属性的详细信息,请参阅 Filter 参数的可筛选属性
  • ComparisonOperator 是一个 OPATH 比较运算符, (例如 -eq 用于等于和 -like 字符串比较) 。 有关比较运算符的详细信息,请参阅 about_Comparison_Operators
  • Value 是要搜索的属性值。 将文本值和变量括在单引号 ('Value''$Variable') 。 如果变量值包含单引号,则需要识别 (转义) 单引号才能正确展开变量。 例如,使用 '$($User -Replace "'","''")'而不是 '$User'。 不要将整数或系统值括在引号 (例如,改用 500$true$false$null) 。

可以使用逻辑运算符 -and-or将多个搜索条件链接在一起。 例如,"Criteria1 -and Criteria2""(Criteria1 -and Criteria2) -or Criteria3"

有关 Exchange 中的 OPATH 筛选器的详细信息,请参阅 其他 OPATH 语法信息

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-GroupMailbox

GroupMailbox 开关指定是否仅返回结果中的Microsoft 365 组。 不必为此开关指定值。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online

-Identity

Identity 参数指定要查看的邮箱。 可以使用能够唯一标识邮箱的任意值。 例如:

  • 名称
  • 别名
  • 可分辨名称 (DN)
  • 可分辨名称 (DN)
  • 域\用户名
  • 电子邮件地址
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • 用户 ID 或用户主体名称 (UPN)

此参数不能与 Anr、Database、MailboxPlan 或 Server 参数一起使用。

Type:MailboxIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-IgnoreDefaultScope

此参数只在本地 Exchange 中可用。

IgnoreDefaultScope 开关指示命令忽略 Exchange PowerShell 会话的默认收件人范围设置,并将整个林用作范围。 不必为此开关指定值。

此开关使命令能够访问当前在默认范围中不可用的 Active Directory 对象,但也引入了以下限制:

  • 无法使用 DomainController 参数。 此命令自动使用相应的全局编录服务器。
  • 无法使用 DomainController 参数。 此命令自动使用相应的全局编录服务器。
Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-InactiveMailboxOnly

此参数仅在基于云的服务中可用。

InactiveMailboxOnly 开关指定是否仅返回结果中的非活动邮箱。 不必为此开关指定值。

非活动邮箱是在软删除之前置于诉讼保留或就地保留的邮箱。 除非删除该保留,否则会一直保留非活动邮箱的内容。

若要在结果中包含活动和非活动邮箱,请不要使用此开关。 请改用 IncludeInactiveMailbox 开关。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-IncludeEmailAddressDisplayNames

此参数仅在基于云的服务中可用。

{{ Fill IncludeEmailAddressDisplayNames Description }}

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-IncludeInactiveMailbox

此参数仅在基于云的服务中可用。

IncludeInactiveMailbox 开关指定是否在结果中包括非活动邮箱。 不必为此开关指定值。

非活动邮箱是在软删除之前置于诉讼保留或就地保留的邮箱。 除非删除该保留,否则会一直保留非活动邮箱的内容。

若要在结果中仅返回非活动邮箱,请不要使用此开关。 请改用 InactiveMailboxOnly 开关。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-MailboxPlan

此参数仅在基于云的服务中可用。

MailboxPlan 参数按邮箱计划筛选结果。 使用此参数时,仅将那些分配了指定的邮箱计划的邮箱返回在结果中。 可以使用任何能够唯一标识该邮箱计划的值。 例如:

  • 名称
  • 别名
  • 显示名称
  • 可分辨名称 (DN)
  • GUID

邮箱计划指定基于云的组织中的邮箱用户可用的权限和功能。 您可以使用 Get-MailboxPlan cmdlet 查看可用的邮箱计划。

此参数不能与 Anr 或 Identity 参数一起使用。

Type:MailboxPlanIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

-Migration

迁移开关指定是否在结果中仅返回迁移邮箱。 不必为此开关指定值。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online

-Monitoring

此参数只在本地 Exchange 中可用。

监视开关指定是否在结果中仅返回监视邮箱。 不必为此开关指定值。

监视邮箱与托管可用性和 Exchange Health Manager 服务相关联,并且具有 MonitoringMailbox 的 RecipientTypeDetails 属性值。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-OrganizationalUnit

OrganizationUnit 参数根据对象在 Active Directory 中的位置筛选结果。 只返回存在于指定位置的对象。 此参数的有效输入是由 Get-OrganizationalUnit cmdlet 返回的组织单位 (OU) 或域。 可以使用任何能够唯一标识此 OU 或域的值。 例如:

  • 名称
  • 名称
  • 可分辨名称 (DN)
  • GUID
Type:OrganizationalUnitIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-PublicFolder

PublicFolder 开关指定是否在结果中仅返回公用文件夹邮箱。 不必为此开关指定值。

公用文件夹邮箱是专门用于存储公用文件夹的层次结构和内容的邮箱。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-ReadFromDomainController

此参数只在本地 Exchange 中可用。

ReadFromDomainController 开关指定从用户域中的域控制器读取的信息。 不必为此开关指定值。

命令: Set-AdServerSettings -ViewEntireForest $true 若要包含林中的所有对象,需要 ReadFromDomainController 开关。 否则,命令可能会使用包含过时信息的全局编录。 此外,可能需要使用 ReadFromDomainController 开关运行命令的多个迭代才能获取信息。

默认情况下,收件人范围设置为托管 Exchange 服务器的域。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-RecipientTypeDetails

RecipientTypeDetails 参数按指定的邮箱子类型筛选结果。 有效值包含:

  • DiscoveryMailbox
  • EquipmentMailbox
  • GroupMailbox (Exchange 2013 或更高版本和云)
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 或更高版本和云)
  • RoomMailbox
  • SchedulingMailbox (Exchange 2016 或更高版本和云)
  • SharedMailbox
  • TeamMailbox (Exchange 2013 或更高版本和云)
  • UserMailbox

可以指定用逗号分隔的多个值。

Type:RecipientTypeDetails[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-RemoteArchive

此参数只在本地 Exchange 中可用。

RemoteArchive 开关指定是否在结果中仅返回远程存档邮箱。 不必为此开关指定值。

远程存档邮箱是基于云的服务中的存档邮箱,与本地 Exchange 组织中的邮箱用户相关联。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ResultSize

ResultSize 参数指定了要返回的结果的最大数量。 若要返回所有与查询相匹配的请求,则请将此参数的值设为无限制。 默认值为 1000。

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Server

此参数只在本地 Exchange 中可用。

Server 参数按 Exchange 服务器筛选结果。 使用此参数时,结果中仅包含指定 Exchange 服务器上的邮箱。

可以使用唯一标识该服务器的任何值。 例如:

  • 名称
  • FQDN
  • 可分辨名称 (DN)
  • Exchange 旧版 DN

此参数不能与 Anr、Database 或 Identity 参数一起使用。

邮箱的 ServerName 和 ServerLegacyDN 属性可能不会在数据库可用性组 (DAG) 内的邮箱移动后立即更新。 若要获取这些邮箱属性的最新值,请运行 命令 Get-Mailbox <Identity> | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN

注意:此参数的结果可能是迁移前的旧值。 为了获得更好的结果,请改用 Database 参数。

Type:ServerIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ServiceSafetyConfiguration

此参数仅在基于云的服务中可用。

{{ Fill ServiceSafetyConfiguration Description }}

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-SoftDeletedMailbox

此参数仅在基于云的服务中可用。

SoftDeletedMailbox 开关指定是否在结果中仅返回软删除的邮箱。 不必为此开关指定值。

软删除的邮箱是仍然可以恢复的已删除邮箱。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-SortBy

SortBy 参数指定用作结果排序依据的属性。 每次只能按一个属性进行排序。 结果将按升序进行排序。

如果默认视图不包括要排序依据的属性,则可以使用 | Format-Table -Auto Property1,Property2,...PropertyX追加命令。 创建包含要查看的所有属性的新视图。 支持在属性名称中使用通配符 (*)。

可以按下列属性排序:

  • 名称
  • DisplayName
  • 别名
  • Office
  • ServerLegacyDN
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-SupervisoryReviewPolicy

此参数只在本地 Exchange 中可用。

保留此参数以供 Microsoft 内部使用。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

输入

Input types

若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。