Get-Message

 

S’applique à : Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Dernière rubrique modifiée : 2007-08-29

La cmdlet Get-Message permet d'afficher les détails d'un ou plusieurs messages figurant dans une file d'attente sur un ordinateur sur lequel le rôle serveur de transport Edge ou de transport Hub est installé.

Syntaxe

Get-Message [-BookmarkIndex <Int32>] [-BookmarkObject <MessageInfo>] [-Filter <String>] [-IncludeBookmark <$true | $false>] [-IncludeRecipientInfo <SwitchParameter>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-Server <ServerIdParameter>] [-SortOrder <SortOrderEntry[]>]

Get-Message [-Identity <MessageIdentity>] [-BookmarkIndex <Int32>] [-BookmarkObject <MessageInfo>] [-IncludeBookmark <$true | $false>] [-IncludeRecipientInfo <SwitchParameter>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-SortOrder <SortOrderEntry[]>]

Get-Message [-BookmarkIndex <Int32>] [-BookmarkObject <MessageInfo>] [-IncludeBookmark <$true | $false>] [-IncludeRecipientInfo <SwitchParameter>] [-Queue <QueueIdentity>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-SortOrder <SortOrderEntry[]>]

Description détaillée

La cmdlet Get-Message affiche les détails d'un ou plusieurs messages figurant dans une file d'attente existante sur le serveur de transport Hub ou Edge. Si vous ne fournissez aucun paramètre, la commande interroge tous les messages de toutes les files d'attente sur le serveur local et renvoie une page de résultats. La taille de page par défaut est de 1000 objets. Vous pouvez afficher des messages figurant sur un serveur distant en incluant le nom de serveur dans le paramètre Identity ou le paramètre Queue, ou en incluant le paramètre Server avec une requête de filtre. Le paramètre Identity, le paramètre Queue et le jeu de paramètres Filter s'excluent mutuellement.

Pour exécuter la cmdlet Get-Message, vous devez utiliser un compte auquel est délégué le rôle Administrateurs de serveur Exchange.

Pour exécuter la cmdlet Get-Message sur un ordinateur sur lequel le rôle serveur de transport Edge est installé, vous devez ouvrir une session en utilisant un compte membre du groupe Administrateurs local sur cet ordinateur.

Pour plus d'informations sur les autorisations, la délégation de rôles et les droits requis pour administrer Microsoft Exchange Server 2007, consultez la rubrique Considérations relatives aux autorisations.

Paramètres

Paramètre Obligatoire Type Description

BookmarkIndex

Facultatif

System.Int32

Le paramètre BookmarkIndex permet de spécifier la position, dans le jeu de résultats, où l'affichage des résultats commence. La valeur de ce paramètre est un index basé sur 1 dans le jeu total des résultats. BookmarkIndex ne peut pas être utilisé avec le paramètre BookmarkObject.

BookmarkObject

Facultatif

Microsoft.Exchange.Data.QueueViewer.MessageInfo

Le paramètre BookmarkIndex permet de spécifier l'objet dans le jeu de résultats où l'affichage des résultats commence. BookmarkIndex ne peut pas être utilisé avec le paramètre BookmarkObject.

Filter

Facultatif

System.String

Le paramètre Filter exige une expression qui spécifie les critères de valeur de propriété pour les messages que vous voulez afficher. L'expression comprend un nom de propriété suivi d'un opérateur de comparaison et d'une valeur. Les propriétés de message suivantes sont des critères valides pour le paramètre Filter :

  • DateReceived   Date de réception du message.

  • ExpirationTime   Heure d'expiration du message.

  • FromAddress   Adresse SMTP (Simple Mail Transfer Protocol) de l'expéditeur d'un message. Cette valeur est extraite de MAIL FROM: dans l'enveloppe du message.

  • Identity   Nombre entier représentant un message particulier et une identité de serveur et de file d'attente particulière.

  • InternetMessageId   Valeur du champ d'en-tête Message-ID:. Cette propriété est exprimée comme un GUID suivi de l'adresse SMTP du serveur d'envoi, comme dans l'exemple suivant : 67D7543D6103DC4FBEBA6BC7205DACABA61231@exchange.contoso.com.

  • LastError   Chaîne de texte de la dernière erreur enregistrée pour un message.

  • MessageSourceName   Chaîne de texte du nom du composant ayant soumis ce message à la file d'attente.

  • Queue   Spécifie l'identité de la file d'attente contenant le message. Entrez l'identité de file d'attente sous la forme Serveur\destination, où destination est un domaine distant, un serveur de boîtes aux lettres ou un nom de file d'attente persistante.

  • RetryCount   Nombre de fois que la remise d'un message à une destination a été tentée.

  • SCL   La propriété SCL spécifie le contrôle d'accès du message. Les entrées SCL valides sont des entiers compris entre 0 et 9. Une valeur de propriété SCL vide indique que le message n'a pas été traité par l'agent de filtrage de contenu.

  • Size   Taille d'un message.

  • SourceIP   Adresse IP du serveur externe ayant soumis le message à l'organisation Exchange.

  • Status   État du message actuel. Les options d'état de message sont Active, Retry, Suspended, PendingSuspend ou PendingRemove.

  • Subject   Chaîne de texte représentant l'objet du message électronique. La valeur est extraite du champ d'en-tête Subject:.

Vous pouvez spécifier plusieurs critères de filtrage à l'aide de l'opérateur de comparaison - and. Les valeurs de propriété qui ne sont pas exprimées sous la forme d'un nombre entier unique doivent être entre guillemets.

Identity

Facultatif

Microsoft.Exchange.Data.QueueViewer.MessageIdentity

Le paramètre Identity permet de spécifier le nombre entier MessageIdentity. Il s'agit d'un nombre entier représentant un message particulier et une identité de serveur et de file d'attente facultative. Vous pouvez spécifier syntaxe de ce paramètre comme suit :

  • Server\QueueIdentity\MessageIdentity

  • QueueIdentity\MessageIdentity

  • Server\*\MessageIdentity

  • MessageIdentity

IncludeBookmark

Facultatif

System.Boolean

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 de $true est utilisée.

IncludeRecipientInfo

Facultatif

System.Management.Automation.SwitchParameter

Le paramètre IncludeRecipientInfo permet d'afficher les destinataires du message dans le champ Destinataires. Si vous n’incluez pas le paramètre IncludeRecipientInfo, le champ Destinataires est vide.

Le stockage des résultats d’une commande Get-Message -IncludeRecipientInfo 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 du destinataire

  • Type   Le type du destinataire peut être Externe, Boîte aux lettres ou DL (Liste de distribution). La DL est utilisée lorsque la destination est un serveur d'expansion.

  • FinalDestination   DN (nom unique) de l’objet utilisé pour router le message. L’objet peut être un connecteur, un serveur de boîtes aux lettres ou un serveur d’extension.

  • État   L'état du destinataire peut être Complété, 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 du destinataire d’un message dans la file d'attente de remise distante « Contoso.com » qui a la valeur MessageIdentity de 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 étendues des destinataires qui sont stockées dans la variable $x, utilisez la commande suivante :

$x.Recipients

Queue

Facultatif

Microsoft.Exchange.Data.QueueViewer.QueueIdentity

Le paramètre Identity permet de spécifier l'identité de la file d'attente contenant les messages que vous voulez afficher. Entrez l'identité de file d'attente sous la forme Serveur\destination, où destination est un domaine distant, un serveur de boîtes aux lettres ou un nom de file d'attente persistante.

ResultSize

Facultatif

Microsoft.Exchange.Data.Unlimited

Le paramètre ResultSize permet de spécifier le nombre total d'éléments à afficher dans le jeu de résultats. La valeur par défaut du paramètre ResultSize est définie sur 1000. ResultSize prend en charge un nombre illimité de résultats, mais Microsoft Exchange limite le jeu de résultats à 250 000.

ReturnPageInfo

Facultatif

System.Boolean

Le paramètre ReturnPageInfo est un paramètre caché. Utilisez-le pour retourner des informations sur le nombre total des résultats et l'index du premier objet de la page actuelle. La valeur par défaut est $false.

SearchForward

Facultatif

System.Boolean

Le paramètre SearchForward permet de spécifier le sens (avant ou arrière) de la recherche dans le jeu des 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é.

Server

Facultatif

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

Le paramètre Server permet de spécifier le nom du serveur auquel se connecter à l'aide de l'appel de procédure distante (RPC) contenant les files d'attente dans lesquelles figurent les messages que vous voulez afficher. Entrez le paramètre Server sous la forme d'un nom d'hôte ou d'un nom de domaine complet (FQDN). Si ce paramètre n'est pas utilisé, le serveur local est interrogé.

SortOrder

Facultatif

Microsoft.Exchange.Configuration.Tasks.SortOrderEntry[]

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 + au début du nom de propriété pour afficher les résultats dans l'ordre croissant. Ajoutez un symbole - 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.

Exemple

Les exemples suivants décrivent la procédure de requête pour les messages à l'aide de la commande Get-Message. Le premier exemple décrit la procédure d'affichage de tous les messages en attente sur le serveur local, qui ont été reçus d'un expéditeur quelconque dans le domaine spécifié. La commande est canalisée vers la commande Format-List pour disposer les résultats sous la forme d'une liste détaillée.

Le second exemple décrit la procédure d'affichage de tous les messages attente sur le serveur local, qui ont été reçus d'un expéditeur quelconque dans le domaine spécifié et dont la valeur de contrôle d'accès SCL est supérieure à 3.

Le troisième exemple décrit la procédure de connexion à un serveur distant, puis d'affichage de tous les messages en attente sur le serveur distant dans l'ordre de tri spécifié. 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.

Pour plus d'informations sur le traitement en pipeline, consultez la rubrique Traitement en pipeline.

Pour plus d'informations sur l'utilisation de la sortie d'une commande, consultez la rubrique Utilisation de la sortie d'une commande.

Pour plus d'informations sur l'utilisation d'Exchange Management Shell pour exécuter des tâches de l'Afficheur des files d'attente, consultez la rubrique Utilisation d'Exchange Management Shell pour la gestion des files d'attente.

Get-Message -Filter {FromAddress -like "*@contoso.com"} | format-list
Get-Message -Filter {FromAddress -like "*@contoso.com" -and SCL -gt 3}
Get-Message -Server exchange.contoso.com -SortOrder: +FromAddress,-Size