Get-Message
La cmdlet est disponible uniquement dans Exchange en local.
La cmdlet Get-Message permet d'afficher les détails d'un ou plusieurs messages en file d'attente sur les serveurs de boîte aux lettre ou les serveurs Edge.
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
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
Vous pouvez afficher des messages en incluant le nom du serveur dans le paramètre Identity ou le paramètre Queue, ou en incluant le paramètre Server avec une requête de filtre. Les paramètres Identity, Queue et Filter s'excluent mutuellement.
Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que cette rubrique répertorie tous les paramètres de cette cmdlet, il est possible que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous ont été attribuées. Pour rechercher les autorisations requises pour exécuter une cmdlet ou un paramètre dans votre organisation, voir Find the permissions required to run any Exchange cmdlet.
Exemples
Exemple 1
Get-Message -Filter "FromAddress -like '*@contoso.com'" | Format-ListCet exemple affiche des informations détaillées sur tous les messages en file d'attente sur le serveur local et provenant d'un expéditeur dans le domaine contoso.com.
Exemple 2
Get-Message -Filter "FromAddress -like '*@contoso.com' -and SCL -gt 3"Cet exemple répertorie tous les messages mis en file d’attente sur le serveur local, reçus de n’importe quel expéditeur au contoso.com domaine et dont la valeur SCL est supérieure à 3.
Exemple 3
Get-Message -Server Server01.contoso.com -SortOrder: +FromAddress,-SizeCet exemple affiche tous les messages en file d'attente sur le serveur Server01. Les résultats sont d'abord triés dans l'ordre croissant des adresses des expéditeurs, puis dans l'ordre décroissant de la taille.
Paramètres
-BookmarkIndex
Le paramètre BookmarkIndex spécifie la position, dans le jeu de résultats, à partir de laquelle les résultats s’affichent. La valeur de ce paramètre est un index basé sur 1 dans le jeu total des résultats. Il n’est pas possible d’utiliser le paramètre BookmarkIndex avec le paramètre 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
Le paramètre BookmarkObject permet de spécifier l’objet du jeu de résultats où l’affichage dans le jeu de résultats commence. Il n’est pas possible d’utiliser le paramètre BookmarkObject avec le paramètre 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
Le paramètre Filter spécifie un ou plusieurs messages à l’aide de la syntaxe de filtre OPATH. Le filtre OPATH inclut un nom de propriété de message suivi d’un opérateur de comparaison et d’une valeur (par exemple, "FromAddress -like '*@contoso.com'"). Pour plus d’informations sur les propriétés des messages filtrables et les opérateurs de comparaison, consultez Propriétés des messages dans les files d’attente et Rechercher des files d’attente et des messages dans des files d’attente dans l’environnement de ligne de commande Exchange Management Shell.
Vous pouvez spécifier plusieurs critères à l’aide de l’opérateur de comparaison et . Les valeurs de propriété qui ne sont pas exprimées sous la forme d'un nombre entier doivent être entrées entre guillemets (« »).
| 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
Le paramètre Identity spécifie le message. Une entrée valide pour ce paramètre utilise la syntaxe Server\Queue\MessageInteger ou Queue\MessageInteger ou MessageInteger, par exemple, Mailbox01\contoso.com\5 ou 10. Pour plus d’informations sur l’identité des messages, consultez Identité de message.
| 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
Le paramètre IncludeBookmark permet de spécifier l’inclusion ou non d’un objet signet lorsque les résultats de la recherche s’affichent. Le paramètre IncludeBookmark est valide lorsqu’il est utilisé avec les paramètres BookmarkObject ou BookmarkIndex. Si vous ne spécifiez pas de valeur pour le paramètre IncludeBookmark, la valeur par défaut $true est utilisée.
| 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
Le commutateur IncludeComponentLatencyInfo spécifie si les informations de latence de composant sont incluses dans les propriétés du message. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Si vous incluez ce commutateur, les objets de message renvoyés contiendront des mesures de latence pour chaque composant Transport qui a contribué à la latence du serveur local pour chaque message en file d'attente.
| 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
Le paramètre IncludeRecipientInfo spécifie si les destinataires du message doivent apparaître dans le champ Destinataires. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Si vous n'incluez pas le commutateur IncludeRecipientInfo, le champ Destinataires est vide.
Le stockage des résultats d’une Get-Message -IncludeRecipientInfo commande dans une variable vous permet d’afficher des propriétés supplémentaires pour les destinataires du message. La liste suivante décrit les propriétés de destinataires disponibles :
- Adresse : L'adresse de messagerie électronique du destinataire.
- Type : type de destinataire, qui peut être Externe, Boîte aux lettres ou Groupe de distribution. Le groupe de distribution est utilisé lorsque la destination est un serveur d’extension.
- FinalDestination: DN (nom unique) de l'objet utilisé pour router le message.
- État : l’état du destinataire peut être Terminé, Prêt ou Réessayer.
- LastError : Réponse SMTP suite à la dernière tentative de remise ou à un message d'erreur localisé si le message est placé dans une file d'attente inaccessible.
Par exemple, pour stocker les informations de destinataire d’un message dans le contoso.com file d’attente de remise à distance dont la valeur MessageIdentity est 1234 dans une variable nommée $x, utilisez la commande suivante : $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo.
Pour afficher les propriétés de destinataire étendues qui sont maintenant stockées dans la variable $x, utilisez la commande suivante : $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
Le paramètre Queue permet de spécifier l'identité de la file d'attente contenant les messages que vous voulez afficher. L’entrée valide pour ce paramètre utilise la syntaxe <Server>\<Queue> ou <Queue>, par exemple, Mailbox01\contoso.com ou Unreachable. Pour plus d’informations sur l’identité de file d’attente, consultez la section « Identité de file d’attente » dans Rechercher des files d’attente et des messages dans des files d’attente dans Exchange Management Shell.
Si vous utilisez le paramètre Queue, vous ne pouvez pas utiliser les paramètres Identity, Filter ouServer.
| 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
Le paramètre ResultSize spécifie le nombre maximal de résultats à renvoyer. Pour retourner toutes les demandes correspondant à la requête, utilisez unlimited comme valeur pour ce paramètre. La valeur par défaut est 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
Le paramètre ReturnPageInfo est un paramètre masqué. Utilisez-le pour renvoyer des informations sur le nombre total de résultats et l'index du premier objet de la page actuelle. La valeur par défaut est $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
Le paramètre SearchForward permet de spécifier le sens de la recherche dans le jeu de résultats. La valeur par défaut est $true. Cette valeur implique que la page des résultats est calculée à partir du début du jeu des résultats ou à partir d'un signet spécifié.
| 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
Le paramètre Server définit le serveur Exchange sur lequel vous souhaitez exécuter cette commande. Vous pouvez utiliser n’importe quelle valeur qui identifie uniquement le serveur. Par exemple :
- Nom
- FQDN
- Nom unique
- DN Exchange hérité
DN Exchange hérité
Vous pouvez utiliser les paramètres Server et Filter dans la même commande. Vous ne pouvez pas utiliser les paramètres Server et Identity dans la même commande.
| 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
Le paramètre SortOrder permet de spécifier un tableau des propriétés de message qui sont utilisées pour contrôler l’ordre de tri du jeu de résultats. Séparez les propriétés par des virgules. Ajoutez un symbole plus (+) au début du nom de propriété pour afficher les résultats dans l’ordre croissant. Ajoutez un symbole moins (-) au début du nom de propriété pour afficher les résultats dans l’ordre décroissant.
Si vous ne spécifiez aucun ordre de tri, le jeu de résultats s'affiche dans l'ordre croissant des valeurs (nombres entiers) de 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 |
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.