Get-Message

此 cmdlet 仅适用于本地 Exchange。

使用 Get-Message cmdlet 查看邮箱服务器或边缘传输服务器上队列中一个或多个邮件的详细信息。

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

语法

Filter

Get-Message
    [-Filter <String>]
    [-BookmarkIndex <Int32>]
    [-BookmarkObject <ExtensibleMessageInfo>]
    [-IncludeBookmark <Boolean>]
    [-IncludeComponentLatencyInfo]
    [-IncludeRecipientInfo]
    [-ResultSize <Unlimited>]
    [-ReturnPageInfo <Boolean>]
    [-SearchForward <Boolean>]
    [-Server <ServerIdParameter>]
    [-SortOrder <QueueViewerSortOrderEntry[]>]
    [<CommonParameters>]

Identity

Get-Message
    [[-Identity] <MessageIdentity>]
    [-BookmarkIndex <Int32>]
    [-BookmarkObject <ExtensibleMessageInfo>]
    [-IncludeBookmark <Boolean>]
    [-IncludeComponentLatencyInfo]
    [-IncludeRecipientInfo]
    [-ResultSize <Unlimited>]
    [-ReturnPageInfo <Boolean>]
    [-SearchForward <Boolean>]
    [-SortOrder <QueueViewerSortOrderEntry[]>]
    [<CommonParameters>]

Queue

Get-Message
    [-Queue <QueueIdentity>]
    [-BookmarkIndex <Int32>]
    [-BookmarkObject <ExtensibleMessageInfo>]
    [-IncludeBookmark <Boolean>]
    [-IncludeComponentLatencyInfo]
    [-IncludeRecipientInfo]
    [-ResultSize <Unlimited>]
    [-ReturnPageInfo <Boolean>]
    [-SearchForward <Boolean>]
    [-SortOrder <QueueViewerSortOrderEntry[]>]
    [<CommonParameters>]

说明

可以通过将服务器名称作为 Identity 参数或 Queue 参数的一部分,或者通过将 Server 参数包含在筛选查询中来显示消息。 Identity 参数、Queue 参数和 Filter 参数设置是互斥的。

您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果分配给你的权限中未包含某些参数,则可能无权访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。

示例

示例 1

Get-Message -Filter "FromAddress -like '*@contoso.com'" | Format-List

此示例显示有关在本地服务器上排队以及从 contoso.com 域的任何发件人接收的所有邮件的详细信息。

示例 2

Get-Message -Filter "FromAddress -like '*@contoso.com' -and SCL -gt 3"

此示例列出了在本地服务器上排队的所有邮件,这些邮件从 contoso.com 域的任何发件人接收,并且 SCL 值大于 3。

示例 3

Get-Message -Server Server01.contoso.com -SortOrder: +FromAddress,-Size

此示例显示在名为 Server01 的服务器上排队的所有邮件。 结果首先按发件人地址升序排序,然后按大小降序排序。

参数

-BookmarkIndex

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

BookmarkIndex 参数指定所显示的结果在结果集中的起始位置。 此参数的值是总结果集中从 1 开始的索引。 BookmarkIndex 参数不能与 BookmarkObject 参数一起使用。

参数属性

类型:Int32
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-BookmarkObject

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

BookmarkObject 参数指定所显示的结果在结果集中的起始对象。 BookmarkObject 参数不能与 BookmarkIndex 参数一起使用。

参数属性

类型:ExtensibleMessageInfo
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Filter

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Filter 参数使用 OPATH 筛选语法指定一条或多条消息。 OPATH 筛选器包括邮件属性名称,后跟比较运算符和值 (,例如 "FromAddress -like '*@contoso.com'") 。 有关可筛选邮件属性和比较运算符的详细信息,请参阅 队列中邮件的属性 和在 Exchange 命令行管理程序中查找队列和队列中的邮件。

可使用 and 比较运算符指定多个条件。 不表示为整数的属性值必须用引号 (“) 括起来。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Filter
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Identity

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Identity 参数指定邮件。 参数的有效输入使用语法 Server\Queue\MessageInteger 或 Queue\MessageInteger 或 MessageInteger,例如 Mailbox01\contoso.com\5 或 10。 关于消息身份的详细信息,请参阅 消息身份。

注意: Identity 参数的值$null或不存在值将返回 所有 对象,就像您在没有 Identity 参数的情况下运行 Get- 命令一样。 验证 Identity 参数的任何值列表是否准确,且不包含不存在的$null值。

参数属性

类型:MessageIdentity
默认值:None
支持通配符:False
不显示:False

参数集

Identity
Position:1
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IncludeBookmark

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

IncludeBookmark 参数指定显示查询结果时是否包括书签对象。 IncludeBookmark 参数在与 BookmarkObject 或 BookmarkIndex 参数一起使用时有效。 如果您未指定 IncludeBookmark 参数的值,请使用默认值 $true。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IncludeComponentLatencyInfo

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

IncludeComponentLatencyInfo 开关指定消息属性中是否包含有关组件延迟的信息。 不必为此开关指定值。

如果包括此开关,则返回的消息对象将包括每个传输组件的延迟度量,这些组件导致了每个排队消息的本地服务器延迟。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IncludeRecipientInfo

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

IncludeRecipientInfo 开关指定是否在“收件人”字段中显示消息收件人。 不必为此开关指定值。

如果不包括 IncludeRecipientInfo 开关,则收件人字段为空。

通过将命令的结果 Get-Message -IncludeRecipientInfo 存储在变量中,可以显示消息收件人的其他属性。 下表描述了可用的收件人属性:

  • 地址:收件人的电子邮件地址。
  • 类型:收件人类型,可能是“外部”、“邮箱”或“通讯组”。 当目标为扩展服务器时使用通讯组。
  • FinalDestination:用于路由消息的对象的可分辨名称 (DN) 。
  • 状态:收件人状态可能是“完成”、“就绪”或“重试”。
  • LastError:上次传递尝试后的 SMTP 响应,或者如果邮件位于无法访问队列中,则显示本地化错误消息。

例如,要将 MessageIdentity 值为 1234 的 contoso.com 远程传递队列中消息的收件人信息存储到名为 $x 的变量中,请使用以下命令。 $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo

若要显示现在存储在 $x 变量中的扩展收件人属性,请使用以下命令: $x.Recipients.

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Queue

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

队列参数指定包含要显示的消息的队列的标识。 此参数的有效输入使用语法 <Server>\<Queue> ,例如 <Queue>Mailbox01\contoso.com 或 Unreachable。 有关队列标识的详细信息,请参阅“ 在 Exchange 命令行管理程序”的队列中查找队列和邮件中的“队列标识”部分。

如果使用队列参数,则不能使用标识、筛选器或服务器参数。

参数属性

类型:QueueIdentity
默认值:None
支持通配符:False
不显示:False

参数集

Queue
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResultSize

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

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

参数属性

类型:Unlimited
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ReturnPageInfo

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ReturnPageInfo 参数是隐藏参数。 使用它可返回当前页面的总结果数以及第一个对象的索引。 默认值为 $false。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SearchForward

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

SearchForward 参数指定在结果集中是向前搜索还是向后搜索。 默认值为 $true。 此值可从结果集的开头或指定的书签向前计算结果页。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Server

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

服务器参数指定要运行此命令的Exchange服务器。 可以使用唯一标识该服务器的任何值。 例如:

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

Exchange 旧版 DN

不能在同一命令中同时使用 Server 参数和 Filter 参数。 不能在同一命令中同时使用 Server 参数和 Identity 参数。

参数属性

类型:ServerIdParameter
默认值:None
支持通配符:False
不显示:False

参数集

Filter
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-SortOrder

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

SortOrder 参数指定一个邮件属性数组,用于控制结果集的排序顺序。 使用逗号分隔各个属性。 如果在属性名开头添加加号 (+),则按升序显示结果。 如果在属性名开头添加减号 (-),则按降序显示结果。

如果未指定排序顺序,则结果集将按 MessageIdentity 整数升序显示。

参数属性

类型:

QueueViewerSortOrderEntry[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持以下常用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。

输入

Input types

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

输出

Output types

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