Search-Mailbox
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
メールボックスを検索して、指定の対象メールボックスへの結果のコピーまたは元のメールボックスからのメッセージの削除、あるいはその両方を実行するには、Search-Mailbox コマンドレットを使用します。
注: クラウドベースの環境では、 New-ComplianceSearch と関連する電子情報開示コマンドレットを優先して、Search-Mailbox コマンドレットは非推奨になっています。
既定では、Search-Mailboxはメールボックス検索ロールまたはメールボックス インポート エクスポート ロールでのみ使用でき、これらの役割はどの役割グループ にも 割り当てられません。 このコマンドレットを使用するには、役割グループ (組織管理役割グループなど) にロールの一方または両方を追加する必要があります。 DeleteContent パラメーターにアクセスできるのは、メールボックスインポートエクスポートロールだけです。 役割グループへのロールの追加の詳細については、「役割グループ にロールを追加する」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Search-Mailbox
[-Identity] <MailboxOrMailUserIdParameter>
[-Confirm]
[-DeleteContent]
[-DomainController <Fqdn>]
[-DoNotIncludeArchive]
[-Force]
[-IncludeUnsearchableItems]
[-SearchDumpster]
[-SearchDumpsterOnly]
[-SearchQuery <String>]
[-WhatIf]
[<CommonParameters>]Search-Mailbox
[-Identity] <MailboxOrMailUserIdParameter>
[-EstimateResultOnly]
[-Confirm]
[-DomainController <Fqdn>]
[-DoNotIncludeArchive]
[-Force]
[-IncludeUnsearchableItems]
[-SearchDumpster]
[-SearchDumpsterOnly]
[-SearchQuery <String>]
[-WhatIf]
[<CommonParameters>]Search-Mailbox
[-Identity] <MailboxOrMailUserIdParameter>
-TargetFolder <String>
-TargetMailbox <MailboxIdParameter>
[-Confirm]
[-DeleteContent]
[-DomainController <Fqdn>]
[-DoNotIncludeArchive]
[-Force]
[-IncludeUnsearchableItems]
[-LogLevel <LoggingLevel>]
[-LogOnly]
[-SearchDumpster]
[-SearchDumpsterOnly]
[-SearchQuery <String>]
[-WhatIf]
[<CommonParameters>]説明
Search-Mailbox コマンドレットを使用すると、指定のメールボックス内のメッセージを検索して次のいずれかの作業を実行できます。
- 指定された対象のメールボックスにメッセージをコピーします。
- 元のメールボックスからメッセージを削除します。 メッセージを削除するには、"Mailbox Import Export/メールボックスのインポートとエクスポート" 管理役割の割り当てが必要です。
- 単一アイテムの回復を実行して、ユーザーの 回復可能なアイテム フォルダーからアイテムを回復します。
- メールボックスの 回復可能なアイテム フォルダーが回復可能なアイテムのハード クォータに達した場合、このフォルダーをクリーンアップします。
例
例 1
Search-Mailbox -Identity "Joe Healy" -SearchQuery "Subject:Project Hamilton" -TargetMailbox "DiscoveryMailbox" -TargetFolder "JoeHealy-ProjectHamilton" -LogLevel Fullこの例は、Joe Healy のメールボックスを検索し、検索結果をフォルダー JoeHealy-ProjectHamilton 内の DiscoveryMailbox にコピーします。
例 2
Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -TargetMailbox "administrator" -TargetFolder "SearchAndDeleteLog" -LogOnly -LogLevel Fullこの例は、April Stewart のメールボックスに対し、件名に「Your bank statement」という語句が含まれるメッセージを検索し、その結果を、管理者のメールボックスの SearchAndDeleteLog フォルダーに記録します。 メッセージは、対象のメールボックスにコピーされません。
例 3
Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -DeleteContentこの例は、April Stewart のメールボックスに対し、件名に「Your bank statement」という語句が含まれるメッセージを検索し、そのメッセージを元のメールボックスから削除します。 DeleteContent スイッチを使用するには、"Mailbox Import Export/メールボックスのインポートとエクスポート" 管理役割の割り当てが必要です。
例 4
Get-Mailbox | Search-Mailbox -SearchQuery 'election OR candidate OR vote' -TargetMailbox "Discovery Search Mailbox" -TargetFolder "AllMailboxes-Election" -LogLevel Fullこの例は、すべてのメールボックスの中から「election」、「candidate」、または「vote」という語句が含まれるメッセージを検索します。 検索結果が、[AllMailboxes-Election] フォルダーの探索検索メールボックスにコピーされます。
パラメーター
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
| Type: | SwitchParameter |
| Aliases: | cf |
| 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, Exchange Online |
-DeleteContent
注: このスイッチを使用するには、メールボックスインポートエクスポート管理ロールを割り当てる必要があります。 既定では、このロールはどの役割グループにも割り当てられません (組織の管理を含む)。 通常、役割は、組み込みまたはカスタムの役割グループに割り当てます。
DeleteContent スイッチは、検索で返されるメッセージが元のメールボックスから完全に削除されることを指定します。 このスイッチで値を指定する必要はありません。
TargetMailbox パラメーターでこのスイッチを使用すると、メッセージがターゲット メールボックスにコピーされ、ソース メールボックスから削除されます。 検索のログ レベルに Basic または Full を指定する場合、ログを配置する対象メールボックスと対象フォルダーを指定する必要があります。 メッセージを対象メールボックスにコピーせずに元のメールボックスから削除するには、TargetMailbox、TargetFolder、および LogLevel パラメーターを指定しないでください。
DeleteContent スイッチを使用して内容を削除する前に、例 2 に示すように LogOnly パラメーターを使用して検索パラメーターをテストすることをお勧めします。
| 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, Exchange Online |
-DomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
| Type: | Fqdn |
| 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 |
-DoNotIncludeArchive
DoNotIncludeArchive スイッチは、ユーザーのアーカイブ メールボックスを検索対象にしないよう指定します。 このスイッチに値を指定する必要はありません。
既定では、アーカイブ メールボックスは常に検索対象です。
Exchange Online メールボックスに対して自動拡張アーカイブが有効になっている場合、ユーザーのプライマリ アーカイブ メールボックスのみが検索されます。 補助アーカイブ メールボックスは検索に含まれません。
| 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, Exchange Online |
-EstimateResultOnly
EstimateResultOnly スイッチは、メッセージの合計数とサイズの見積もりのみを返します。 メッセージは、対象のメールボックスにコピーされません。 このスイッチで値を指定する必要はありません。
このスイッチを TargetMailbox パラメーターと併用することはできません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Force
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
DeleteContent スイッチを使用してメッセージを完全に削除するときに、確認プロンプトを非表示にするには、このスイッチを使用します。
| 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, Exchange Online |
-Identity
Identity パラメーターは、検索するメールボックスの ID を指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
| Type: | MailboxOrMailUserIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IncludeUnsearchableItems
IncludeUnsearchableItems スイッチには、検索結果に Exchange Search でインデックスを作成できなかったアイテムが含まれています。 このスイッチで値を指定する必要はありません。
| 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, Exchange Online |
-LogLevel
LogLevel パラメーターには、検索のログ レベルを指定します。 次のいずれかの値を取ることができます。
- 抑制: ログは保持されません。
- 基本: クエリに関する基本情報と実行者は保持されます。
- Full: Basic ログ レベルで保持される情報に加えて、完全なログ レベルによって検索結果の完全な一覧が追加されます。
既定のログ レベルは Basic です。
このパラメーターを含めると、電子メール メッセージが作成され、TargetMailbox パラメーターで指定されたメールボックスに送信されます。 ログ ファイル (Search Results.csv という名前の CSV 形式のファイル) は、この電子メール メッセージに添付され、TargetFolder パラメーターで指定されたフォルダーに配置されます。 ログ ファイルには、 Search-Mailbox コマンドレットを実行すると、検索結果に含まれる各メッセージの行が含まれています。
| Type: | LoggingLevel |
| 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, Exchange Online |
-LogOnly
LogOnly スイッチは検索を実行しますが、ログのみが生成されます。 検索によって返されたメッセージは、対象メールボックスにコピーされません。 このスイッチで値を指定する必要はありません。
ログ レベルは、LogLevel パラメーターを使用して指定します。
| 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, Exchange Online |
-SearchDumpster
SearchDumpster スイッチは、回復可能なアイテム フォルダーを検索に含めるかどうかを指定します。 回復可能なアイテム フォルダーには、削除済みアイテム フォルダーから削除されたアイテム、またはメールボックス データベースから削除されるまでハード削除されたアイテムが格納されます。
既定では、回復可能なアイテム フォルダーは常に検索に含まれます。 回復可能なアイテム フォルダーを検索から除外するには、次の正確な構文を使用します。 -SearchDumpster:$false
| 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, Exchange Online |
-SearchDumpsterOnly
SearchDumpsterOnly スイッチは、指定したメールボックスの回復可能なアイテム フォルダーのみが検索されるように指定します。 このスイッチで値を指定する必要はありません。
回復可能なアイテム フォルダーには、削除済みアイテム フォルダーから削除されたアイテム、またはメールボックス データベースから削除されるまでハード削除されたアイテムが格納されます。
このスイッチを DeleteContent スイッチと共に使用することで、[回復可能なアイテム] フォルダーからメッセージを削除して、フォルダーのサイズを縮小することができます。
| 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, Exchange Online |
-SearchQuery
SearchQuery パラメーターには、検索文字列を指定するか、キーワード クエリ言語 (KQL) によって書式設定されたクエリを指定します。 Exchange の KQL の詳細については、「 電子情報開示のメッセージ プロパティと検索演算子」In-Place参照してください。
このパラメーターを空白にすると、すべてのメッセージが返されます。
注: 検索クエリが指定されている場合、Search-Mailbox コマンドレットはメールボックスごとに最大 1,0000 件の結果を返します。
| 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, Exchange Online |
-TargetFolder
TargetFolder パラメーターには、対象メールボックス内に検索結果を保存するフォルダー名を指定します。 フォルダーは実行時に対象メールボックス内に作成されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-TargetMailbox
TargetMailbox パラメーターは、検索結果のコピー先メールボックスを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
このパラメーターは TargetFolder パラメーターと共に使用する必要があります。 このパラメーターを EstimateResultOnly スイッチと併用することはできません。
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-WhatIf
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Aliases: | wi |
| 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, Exchange Online |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。