Get-Message

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

メールボックスサーバーまたはエッジトランスポートサーバー上のキュー内の 1 つ以上のメッセージの詳細を表示するには、Get-Message コマンドレットを使用します。

以下の構文セクションのパラメーターセットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

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 パラメーターまたは Queue パラメーターの一部としてサーバー名を含めるか、またはフィルタークエリを指定した Server パラメーターを含めることで、メッセージを表示できます。 Identity パラメーター、Queue パラメーター、および Filter パラメーターの設定を同時に使用することはできません。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

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

この例では、ローカルサーバーでキューに入れられ、contoso.com ___domain の任意の送信者から送信されたすべてのメッセージに関する詳細を表示します。

例 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
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-BookmarkObject

BookmarkObject パラメーターは、表示される結果が始まる結果セット内のオブジェクトを指定します。 BookmarkObject パラメーターは、BookmarkIndex パラメーターと併用できません。

型:	ExtensibleMessageInfo
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Filter

Filter パラメーターは、OPATH フィルター構文を使用して 1 つ以上のメッセージを指定します。 OPATH フィルターには、メッセージプロパティ名の後に比較演算子と値 (たとえば、 "FromAddress -like '*@contoso.com'") が含まれます。フィルター可能なメッセージプロパティと比較演算子の詳細については、「キュー内のメッセージのプロパティ」および「Exchange Management Shell のキュー内のキューとメッセージを検索する」を参照してください。

および比較演算子を使用して、複数の条件を指定できます。整数として表されないプロパティ値は、引用符 (") で囲む必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Identity

Identity パラメーターは、メッセージを指定します。このパラメーターの有効な入力は、構文 Server\Queue\MessageInteger または Queue\MessageInteger または MessageInteger を使用します (例: Mailbox01\contoso.com\5 または 10)。メッセージ ID の詳細については、「メッセージ ID」を参照してください。

型:	MessageIdentity
配置:	1
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IncludeBookmark

IncludeBookmark パラメーターは、クエリ結果が表示されるときにブックマークオブジェクトを含めるかどうかを指定します。 IncludeBookmark パラメーターは、BookmarkObject パラメーターまたは BookmarkIndex パラメーターと併用した場合に有効になります。 IncludeBookmark パラメーターの値を指定しない場合、既定値 $true が使用されます。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IncludeComponentLatencyInfo

IncludeComponentLatencyInfo スイッチには、コンポーネントの待ち時間に関する情報がメッセージプロパティに含まれるかどうかを指定します。このスイッチで値を指定する必要はありません。

このスイッチを含める場合、返されるメッセージオブジェクトには、キューに入っているメッセージあたりのローカルサーバーの待ち時間の原因になった各トランスポートコンポーネントの待ち時間の測定値が含まれます。

型:	SwitchParameter
配置:	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
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Queue

Queue パラメーターは、表示するメッセージを含むキューの ID を指定します。このパラメーターの有効な入力では、Mailbox01\contoso.com や到達不能などの構文 <Server>\<Queue> または <Queue>が使用されます。キュー ID の詳細については、「 Exchange 管理シェルのキュー内のキューとメッセージを検索する」の「キュー ID」セクションを参照してください。

Queue パラメーターを使用する場合、Identity、Filter、または Server パラメーターは使用できません。

型:	QueueIdentity
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResultSize

ResultSize パラメーターは、返される結果の最大数を指定します。クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。既定値は 1,000 です。

型:	Unlimited
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReturnPageInfo

ReturnPageInfo パラメーターは、隠しパラメーターです。このパラメーターを使用すると、結果の総数と現在のページの最初のオブジェクトのインデックスに関する情報が返されます。既定値は $false です。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SearchForward

SearchForward パラメーターは、結果セット内を順方向に検索するか逆方向に検索するかを指定します。既定値は $true です。この値が指定されていると、結果のページは、結果セットの先頭から前方に、またはブックマークが指定されている場合はブックマークから前方に計算されます。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Server

Server パラメーターは、このコマンドの実行先となる Exchange サーバーを指定します。サーバーを一意に識別する任意の値を使用できます。次に例を示します。

名前
FQDN
識別名 (DN)
Exchange の従来の DN

このパラメーターを使用しない場合、コマンドはローカルサーバー上で実行されます。

Server パラメーターと Filter パラメーターを同じコマンド内で使用することができます。 Server パラメーターと Identity パラメーターを同じコマンド内で使用することはできません。

型:	ServerIdParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SortOrder

SortOrder パラメーターは、結果セットの並べ替えの順序を制御するために使用されるメッセージプロパティの配列を指定します。各プロパティはコンマで区切ります。プロパティ名の先頭にプラス記号 (+) を追加すると、結果は昇順で表示されます。プロパティ名の先頭にマイナス記号 (-) を追加すると、結果は降順で表示されます。

並べ替えの順序を指定しない場合、結果セットは MessageIdentity 整数によって昇順に表示されます。

型:	QueueViewerSortOrderEntry[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。