Get-Message
內部部署 Exchange 才有提供此 Cmdlet。
使用 Get-Message 指令小程式查看郵件匣伺服器或邊緣傳輸伺服器佇列中一個或多個訊息的詳細資料。
如需下方<語法>一節中參數集的詳細資訊,請參閱 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>]
Description
你可以透過將伺服器名稱作為身份參數或佇列參數的一部分來顯示訊息,或是透過篩選查詢加入伺服器參數來呈現訊息。 身份參數、佇列參數與過濾器參數設定是互斥的。
您必須已獲指派權限,才能執行此指令程式。 雖然這篇文章列出了 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 Management Shell 中的「佇列訊息屬性」及「尋找佇列與佇列中的訊息」。
你可以透過使用 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或不存在的值,會回傳 所有 物件,就像你執行 Get- 指令時沒有 Identity 參數一樣。 請確認 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 開關,Recipients 欄位會是空白。
將指令結果 Get-Message -IncludeRecipientInfo 儲存在變數中,可以顯示訊息接收者的額外屬性。 以下列表描述了可用的受贈財產:
- 地址:收件人的電子郵件地址。
- 類型:收件人類型,可能是外部、信箱或分發群組。 當目的地是擴充伺服器時,會使用分發群組。
- FinalDestination:用於路由訊息的物件 (DN) 的區別名稱。
- 狀態:收件人狀態可能是完成、準備或重試。
- LastError:最後一次傳遞嘗試後的 SMTP 回應,或若訊息被置於無法存取的隊列中,則會發出局部錯誤訊息。
例如,若要將訊息的收件人資訊儲存在 contoso.com 遠端傳遞佇列中,且 MessageIdentity 值為 1234,變數為 $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
Queue 參數指定包含你想顯示訊息的佇列身份。 此參數的有效輸入使用語法 <Server>\<Queue> ,例如 <Queue>Mailbox01\contoso.com 或 Unreachable。 關於佇列身份的詳細資訊,請參閱 Exchange Management Shell 中「尋找佇列與佇列中的訊息」中的「佇列身份」章節。
如果你使用 Queue 參數,就無法使用 Identity、Filter 或 Server 參數。
參數屬性
| 類型: | 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 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求,請使用 unlimited 作為此參數的值。 預設值為 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
Server 參數指定您要執行此命令的 Exchange 伺服器。 您可以使用唯一識別伺服器的任何值。 例如:
- Name
- FQDN
- 辨別名稱 (DN)
- Exchange Legacy DN
Exchange Legacy 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
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。