Get-Message
內部部署 Exchange 才有提供此 Cmdlet。
使用 Get-Message Cmdlet 來檢視信箱伺服器或 Edge Transport Server 上佇列中一或多個訊息的詳細資料。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
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>]
Description
您可以將伺服器名稱包含為 Identity 參數或 Queue 參數的一部分,或是將 Server 參數包含在篩選查詢中,以顯示訊息。 Identity 參數、Queue 參數和 Filter 參數設定互斥。
您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 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 參數一起使用。
Type: | Int32 |
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 |
-BookmarkObject
BookmarkObject 參數指定在結果集中開始顯示結果的物件。 BookmarkObject 參數不能與 BookmarkIndex 參數一起使用。
Type: | ExtensibleMessageInfo |
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 篩選語法來指定一或多個訊息。 OPATH 篩選器包含訊息屬性名稱,後面接著比較運算子和值 (例如, "FromAddress -like '*@contoso.com'"
) 。 如需可篩選訊息屬性和比較運算子的詳細資訊,請參閱 佇列中的訊息屬性 和 在 Exchange 管理命令介面的佇列中尋找佇列和訊息。
您可以使用 和 比較運算子來指定多個準則。 未以整數表示的屬性值必須以引號括住 (「) 。
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 |
-Identity
Identity 參數會指定郵件。 此參數的有效輸入會使用以下語法:Server\Queue\MessageInteger 或 Queue\MessageInteger 或 MessageInteger,例如,Mailbox01\contoso.com\5 或 10。 如需訊息識別的詳細資訊,請參閱 訊息身分識別。
Type: | MessageIdentity |
Position: | 1 |
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 |
-IncludeBookmark
IncludeBookmark 參數指定顯示的查詢結果是否要包含書籤物件。 IncludeBookmark 參數配合 BookmarkObject 或 BookmarkIndex 參數使用時有效。 如果未指定 IncludeBookmark 參數的值,則會使用預設值 $true。
Type: | Boolean |
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 |
-IncludeComponentLatencyInfo
IncludeComponentLatencyInfo 參數會指定訊息屬性中是否包含元件延遲的相關資訊。 您不需要使用此參數指定值。
如果您包含此參數,傳回的訊息物件會包含每個傳輸元件的延遲度量,這些元件已對每個佇列訊息造成本機伺服器延遲。
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 |
-IncludeRecipientInfo
IncludeRecipientInfo 參數會指定是否要在 [收件者] 欄位中顯示郵件收件者。 您不需要使用此參數指定值。
如果您未包含 IncludeRecipientInfo 參數,[收件者] 欄位會是空白的。
將命令的結果 Get-Message -IncludeRecipientInfo
儲存在變數中,可讓您顯示郵件收件者的其他屬性。 下列清單描述可用的收件者屬性:
- 位址:收件者的電子郵件地址。
- 類型:收件者類型,可能是外部、信箱或通訊群組。 當目的地是擴充伺服器時,會使用通訊群組。
- FinalDestination:用來路由訊息之物件的辨別名稱 (DN) 。
- 狀態:收件者狀態可能是 [完成]、[就緒] 或 [重試]。
- LastError:上次傳遞嘗試之後的 SMTP 回應,如果訊息放在無法連線的佇列中,則為當地語系化的錯誤訊息。
例如,若要將 MessageIdentity 值為 1234 的訊息收件者資訊儲存到名為 $x 的 contoso.com 遠端傳遞佇列中,請使用下列命令: $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo
。
若要顯示現在儲存在 $x 變數中的擴充收件者屬性,請使用下列命令: $x.Recipients
。
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 |
-Queue
Queue 參數會指定佇列的身分識別,其中包含您想要顯示的訊息。 此參數的有效輸入會使用 語 <Server>\<Queue>
法或 <Queue>
,例如 Mailbox01\contoso.com 或 Unreachable。 如需佇列身分識別的詳細資訊,請參閱在 Exchange 管理命令介面中尋找佇列和佇列中的訊息中的一節。
如果您使用 Queue 參數,則無法使用 Identity、Filter 或 Server 參數。
Type: | QueueIdentity |
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 |
-ResultSize
ResultSize 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求,請使用 unlimited 作為此參數的值。 預設值為 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 |
-ReturnPageInfo
ReturnPageInfo 參數是隱藏參數。 使用它以傳回有關總結果數及目前頁面之第一個物件的索引的相關資訊。 預設值為 $false。
Type: | Boolean |
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 |
-SearchForward
SearchForward 參數指定要在結果集中進行往前或往回搜尋。 預設值為 $true。 此值會從結果集的開頭或從所指定的書籤往前計算結果頁。
Type: | Boolean |
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 |
-Server
Server 參數指定您要執行此命令的 Exchange 伺服器。 您可以使用唯一識別伺服器的任何值。 例如:
- Name
- FQDN
- 辨別名稱 (DN)
- Exchange Legacy DN
Exchange Legacy DN
同一個命令中可以同時使用 Server 參數和 Filter 參數。 同一個命令中不能同時使用 Server 參數和 Identity 參數。
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 |
-SortOrder
SortOrder 參數指定用來控制結果集之排序順序的郵件內容陣列。 以逗號分隔每個屬性。 在屬性名稱的開頭加上加號 (+),以使用遞增順序顯示結果。 在屬性名稱的開頭加上減號 (-),以使用遞減順序顯示結果。
如果您未指定排序次序,結果集會依 MessageIdentity 整數以遞增順序顯示。
Type: | QueueViewerSortOrderEntry[] |
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 |
輸入
Input types
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。