Search-Mailbox

Référence

Module:: ExchangePowerShell

S’applique à:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

Cette cmdlet est disponible dans Exchange sur site et dans le service cloud. Certains paramètres peuvent être propres à un environnement ou à un autre.

La cmdlet Search-Mailbox permet de rechercher une boîte aux lettres et copier les résultats dans une boîte aux lettres cible spécifiée, de supprimer des messages de la boîte aux lettres source, ou bien les deux.

Remarque : Dans les environnements cloud, l’applet de commande Search-Mailbox est déconseillée en faveur de New-ComplianceSearch et des applets de commande eDiscovery associées.

Par défaut, Search-Mailbox est disponible uniquement dans les rôles Recherche de boîtes aux lettres ou Exportation d’importation de boîtes aux lettres, et ces rôles ne sont attribués à aucun groupe de rôles. Pour utiliser cette applet de commande, vous devez ajouter l’un des rôles ou les deux à un groupe de rôles (par exemple, le groupe de rôles Gestion de l’organisation). Seul le rôle Importation d’exportation de boîte aux lettres vous donne accès au paramètre DeleteContent. Pour plus d’informations sur l’ajout de rôles à des groupes de rôles, consultez Ajouter un rôle à un groupe de rôles.

Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.

Syntax

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>]

Description

La cmdlet Search-Mailbox permet de rechercher des messages dans une boîte aux lettres spécifique et de réaliser les tâches suivantes :

Copier des messages dans une boîte aux lettres cible spécifiée.
Supprimer des messages de la boîte aux lettres source. Vous devez disposer du rôle de gestion Importation/Exportation de boîte aux lettres pour supprimer des messages.
Procéder à une récupération d’élément unique pour récupérer des éléments à partir du dossier Éléments récupérables d’un utilisateur.
Nettoyer le dossier Éléments récupérables d’une boîte aux lettres dès qu’il a atteint le quota inconditionnel fixé pour ce dossier.

Exemples

Exemple 1

Search-Mailbox -Identity "Joe Healy" -SearchQuery "Subject:Project Hamilton" -TargetMailbox "DiscoveryMailbox" -TargetFolder "JoeHealy-ProjectHamilton" -LogLevel Full

Cet exemple effectue une recherche dans la boîte aux lettres de Joe Healy et copie les résultats de la recherche dans le dossier JoeHealy ProjectHamilton de DiscoveryMailbox.

Exemple 2

Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -TargetMailbox "administrator" -TargetFolder "SearchAndDeleteLog" -LogOnly -LogLevel Full

Cet exemple recherche dans la boîte aux lettres d’April Stewart des messages dont l’objet contient l’expression « Your bank statement » (Votre relevé de compte) et consigne le résultat dans le dossier SearchAndDeleteLog de la boîte aux lettres de l’administrateur. Les messages ne sont pas copiés dans la boîte aux lettres cible.

Exemple 3

Search-Mailbox -Identity "April Stewart" -SearchQuery 'Subject:"Your bank statement"' -DeleteContent

Cet exemple recherche dans la boîte aux lettres d’April Stewart des messages dont l’objet contient l’expression « Your bank statement » et supprime les messages de la boîte aux lettres source. Vous devez disposer du rôle de gestion Importation/Exportation de boîte aux lettres pour utiliser le commutateur DeleteContent.

Exemple 4

Get-Mailbox | Search-Mailbox -SearchQuery 'election OR candidate OR vote' -TargetMailbox "Discovery Search Mailbox" -TargetFolder "AllMailboxes-Election" -LogLevel Full

Cet exemple effectue une recherche dans toutes les boîtes aux lettres au sein de votre organisation et cherche des messages contenant les mots « election » (élection), « candidate » (candidat) ou « vote ». Les résultats de la recherche sont copiés dans la boîte aux lettres « Discovery Search Mailbox », dans le dossier « AllMailboxes-Election ».

Paramètres

-Confirm

Le commutateur Confirme spécifie s’il faut afficher ou masquer l’invite de confirmation. L’incidence de ce commutateur sur la cmdlet varie selon que la cmdlet requiert une confirmation avant de poursuivre.

Les applets de commande destructrices (par exemple, les applets de commande Remove-*) ont une pause intégrée qui vous oblige à accuser réception de la commande avant de continuer. Pour ces cmdlets, vous pouvez ignorer l’invite de confirmation à l’aide de cette syntaxe exacte : -Confirm:$false.
La plupart des autres applets de commande (par exemple, les applets de commande New-* et Set-*) n’ont pas de pause intégrée. Pour ces cmdlets, la spécification du commutateur Confirm sans valeur introduit une pause qui vous oblige à confirmer la commande avant de poursuivre.

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

Remarque : Le rôle de gestion Importation d’exportation de boîte aux lettres doit vous être attribué pour utiliser ce commutateur. Par défaut, ce rôle n’est attribué à aucun groupe de rôles (y compris gestion de l’organisation). Généralement, vous attribuez un rôle à un groupe de rôles intégrés ou personnalisés.

Le commutateur DeleteContent spécifie que les messages renvoyés par la recherche sont définitivement supprimés dans la boîte aux lettres source. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Lorsque vous utilisez ce commutateur avec le paramètre TargetMailbox, les messages sont copiés dans la boîte aux lettres cible et supprimés de la boîte aux lettres source. Si vous définissez le niveau d’enregistrement de la recherche sur Basic ou Full, vous devez spécifier une boîte aux lettres cible et un dossier cible dans lequel stocker le journal. Pour supprimer les messages de la boîte aux lettres source sans les copier dans la boîte aux lettres cible, ne spécifiez pas les paramètres TargetMailbox, TargetFolder et LogLevel.

Avant d’utiliser le commutateur DeleteContent pour supprimer du contenu, nous vous conseillons de tester les paramètres de recherche au moyen du paramètre LogOnly, comme le montre l’exemple 2.

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

Ce paramètre est disponible uniquement dans Exchange sur site.

Le paramètre DomainController spécifie le contrôleur de domaine qui est utilisé par cette cmdlet pour lire ou écrire les données dans Active Directory. Vous identifiez le contrôleur de domaine par son nom de domaine complet (FQDN). Par exemple : « 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

Le commutateur DoNotIncludeArchive indique que la boîte aux lettres d’archivage de l’utilisateur ne doit pas faire partie de la recherche. Vous n’avez pas besoin de spécifier une valeur pour ce commutateur.

Par défaut, une recherche est toujours effectuée dans la boîte aux lettres d’archivage.

Si l’archivage à extension automatique est activé pour une boîte aux lettres Exchange Online, seule la boîte aux lettres d’archivage principale de l’utilisateur fait l’objet d’une recherche. Les boîtes aux lettres d’archivage supplémentaires ne sont pas incluses dans la recherche.

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

Le commutateur EstimateResultOnly retourne uniquement une estimation du nombre total et de la taille des messages. Les messages ne sont pas copiés dans la boîte aux lettres cible. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Vous ne pouvez pas utiliser ce commutateur avec le paramètre 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

Le commutateur Force masque les messages d’avertissement ou de confirmation. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Utilisez ce commutateur pour masquer l’invite de confirmation lorsque vous utilisez le commutateur DeleteContent pour supprimer définitivement des messages.

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

Le paramètre Identity spécifie le nom de la boîte aux lettres à rechercher. Vous pouvez utiliser n’importe quelle valeur qui identifie la boîte aux lettres de manière unique. Par exemple :

Nom
Alias
Nom unique
Nom unique
Domaine\Nom d’utilisateur
Adresse e-mail
GUID
LegacyExchangeDN
SamAccountName
Identifiant utilisateur ou nom d’utilisateur principal (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

Le commutateur IncludeUnsearchableItems inclut des éléments qui n’ont pas pu être indexés par recherche Exchange dans les résultats de la recherche. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Le paramètre LogLevel spécifie le niveau de journalisation de la recherche. Il peut prendre l’une des valeurs suivantes :

Supprimer : aucun journal n’est conservé.
De base : les informations de base sur la requête et la personne qui l’a exécutée sont conservées.
Complet : en plus des informations conservées par le niveau de journal de base, le niveau de journal complet ajoute une liste complète des résultats de la recherche.

Le niveau par défaut du journal est Basic.

Lorsque vous avez inclus ce paramètre, un e-mail est créé et envoyé à la boîte aux lettres spécifiée par le paramètre TargetMailbox. Le fichier journal (qui est un fichier au format CSV nommé Search Results.csv) est joint à ce message électronique et se trouve dans le dossier spécifié par le paramètre TargetFolder. Le fichier journal comporte une ligne par message inclus dans les résultats de la recherche lorsque vous exécutez la cmdlet 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

Le commutateur LogOnly effectue une recherche, mais génère uniquement un journal. Les messages renvoyés par la recherche ne sont pas copiés dans la boîte aux lettres cible. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Le niveau d’enregistrement est précisé à l’aide du paramètre 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

Le commutateur SearchDumpster spécifie s’il faut inclure le dossier Éléments récupérables dans la recherche. Le dossier Éléments récupérables stocke les éléments supprimés du dossier Éléments supprimés ou ceux qui ont été supprimés de manière définitive jusqu’à ce qu’ils soient vidés de la base de données de boîtes aux lettres.

Par défaut, le dossier Éléments récupérables est toujours inclus dans la recherche. Pour exclure le dossier Éléments récupérables de la recherche, utilisez la syntaxe exacte suivante : -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

Le commutateur SearchDumpsterOnly spécifie que seul le dossier Éléments récupérables de la boîte aux lettres spécifiée fait l’objet d’une recherche. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Le dossier Éléments récupérables stocke les éléments supprimés du dossier Éléments supprimés ou ceux qui ont été supprimés de manière définitive jusqu’à ce qu’ils soient vidés de la base de données de boîtes aux lettres.

Vous pouvez également utiliser ce commutateur avec le commutateur DeleteContent pour supprimer des messages du dossier Éléments récupérables et réduire la taille du dossier.

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

Le paramètre SearchQuery spécifie une chaîne de recherche ou une requête formatée en utilisant la syntaxe KQL (Keyword Query Language). Pour plus d’informations sur KQL dans Exchange, consultez Propriétés de message et opérateurs de recherche pour In-Place eDiscovery.

Si ce paramètre est vide, tous les messages sont renvoyés.

Remarque : l’applet de commande Search-Mailbox retourne jusqu’à 10 000 résultats par boîte aux lettres si une requête de recherche est spécifiée.

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

Le paramètre TargetFolder spécifie le nom d’un dossier de la boîte aux lettres cible dans lequel les résultats de la recherche sont enregistrés. Le dossier est créé dans la boîte aux lettres cible dès exécution.

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

Le paramètre TargetMailbox spécifie la boîte aux lettres de destination dans laquelle les résultats de la recherche sont copiés. Vous pouvez utiliser n’importe quelle valeur qui identifie la boîte aux lettres de manière unique. Par exemple :

Nom
Alias
Nom unique
Nom unique
Domaine\Nom d’utilisateur
Adresse e-mail
GUID
LegacyExchangeDN
SamAccountName
Identifiant utilisateur ou nom d’utilisateur principal (UPN)

Vous devez utiliser ce paramètre avec le paramètre TargetFolder. Vous ne pouvez pas utiliser ce paramètre avec le commutateur 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

Le commutateur WhatIf simule les actions de la commande. Vous pouvez utiliser ce commutateur pour afficher les modifications qui se produiraient sans réellement appliquer ces modifications. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Entrées

Input types

Pour visualiser les types d'entrées acceptés par cette cmdlet, consultez la rubrique Types d'entrée et de sortie de la cmdlet d'Exchange Management Shell. Si le champ Type d'entrée pour une cmdlet est vide, la cmdlet n'accepte pas les données d'entrée.

Sorties

Output types

Pour visualiser les types de retours, également appelés types de sorties, acceptés par cette cmdlet, consultez la rubrique Types d'entrée et de sortie de la cmdlet d'Exchange Management Shell. Si le champ Type de sortie est vide, la cmdlet ne renvoie pas de données.