Get-Message

模块:: ExchangePowerShell

适用于:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

此 cmdlet 仅适用于本地 Exchange。

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

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

语法

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

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

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

说明

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

您必须先获得权限，然后才能运行此 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

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

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-BookmarkObject

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

类型:	ExtensibleMessageInfo
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Filter

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

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

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Identity

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

类型:	MessageIdentity
Position:	1
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IncludeBookmark

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

类型:	Boolean
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IncludeComponentLatencyInfo

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

如果包含此开关，则返回的消息对象将包括每个已排队消息的本地服务器延迟的传输组件的延迟度量。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IncludeRecipientInfo

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
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Queue

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

如果使用 Queue 参数，则不能使用标识、筛选器或服务器参数。

类型:	QueueIdentity
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-ResultSize

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

类型:	Unlimited
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ReturnPageInfo

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

类型:	Boolean
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SearchForward

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

类型:	Boolean
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Server

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

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

Exchange 旧版 DN

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

类型:	ServerIdParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SortOrder

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

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

类型:	QueueViewerSortOrderEntry[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

Input types

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

输出

Output types

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