Поделиться через


Get-Message

Этот командлет доступен только в локальной среде Exchange.

Командлет 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.

Пример 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 задает позицию в наборе результатов, с которой начинаются отображаемые результаты. Значение этого параметра — индекс с отсчетом от единицы в общем наборе результатов. Параметр BookmarkIndex невозможно использовать вместе с параметром 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

Параметр BookmarkObject задает в наборе результатов объект, с которого начинаются отображаемые результаты. Параметр BookmarkObject невозможно использовать вместе с параметром 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

Параметр Filter задает одно или несколько сообщений с помощью синтаксиса фильтра OPATH. Фильтр OPATH включает имя свойства сообщения, за которым следует оператор сравнения и значение (например, "FromAddress -like '*@contoso.com'"). Дополнительные сведения о свойствах фильтруемых сообщений и операторах сравнения см. в статьях Свойства сообщений в очередях и Поиск очередей и сообщений в очередях в командной консоли Exchange.

Можно указать несколько условий с помощью оператора сравнения и . Значения свойств, не выраженные в виде целого числа, должны заключаться в кавычки (").

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

Параметр Identity определяет сообщение. Чтобы указать этот параметр, используйте синтаксис Server\Queue\MessageInteger, Queue\MessageInteger или MessageInteger, например Mailbox01\contoso.com\5 или 10. Дополнительные сведения об идентификаторе сообщения см. в разделе Удостоверение сообщения.

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

Параметр IncludeBookmark указывает, используется ли объект закладок при отображении результатов запроса. Параметр IncludeBookmark допустимо использовать только с параметром BookmarkObject или BookmarkIndex. Если значение для параметра IncludeBookmark не указано, используется значение по умолчанию — $true.

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

Переключатель IncludeComponentLatencyInfo указывает, будут ли сведения о задержке компонентов включаться в свойства сообщения. Указывать значение для этого параметра необязательно.

Если используется этот переключатель, объекты сообщений будут включаться в измерения задержки для каждого компонента транспорта, который влияет на задержку локального сервера для каждого сообщения в очереди.

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

Параметр IncludeRecipientInfo указывает, будут ли отображаться получатели сообщений в поле Получатели. Для этого переключателя не требуется указывать значение.

Если параметр IncludeRecipientInfo не включен, поле Получатели будет пустым.

Хранение результатов Get-Message -IncludeRecipientInfo команды в переменной позволяет отображать дополнительные свойства для получателей сообщений. В следующем списке перечислены доступные свойства получателя:

  • Address. Адрес электронной почты получателя.
  • Тип: тип получателя, который может быть внешним, почтовым ящиком или группой рассылки. Группа рассылки используется, когда назначением является сервер расширения.
  • FinalDestination. Различающееся имя объекта, которое используется для маршрутизации сообщения.
  • Состояние: состояние получателя может быть завершено, готово или повторите попытку.
  • LastError. Ответ SMTP после последней попытки доставки или локализованное сообщение об ошибке, если сообщение помещено в недоступную очередь.

Например, чтобы сохранить сведения о получателе сообщения в очереди удаленной доставки contoso.com со значением MessageIdentity 1234 в переменную с именем $x, используйте следующую команду: $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo.

Чтобы отобразить расширенные свойства получателя, которые теперь хранятся в переменной $x, используйте следующую команду: $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

Параметр Queue указывает удостоверение очереди, содержащей сообщения, которые нужно отобразить. Допустимые входные данные для этого параметра используют синтаксис <Server>\<Queue> или <Queue>, например Mailbox01\contoso.com или Unreachable. Дополнительные сведения об идентификаторе очереди см. в разделе "Удостоверение очереди" статьи Поиск очередей и сообщений в очередях в командной консоли Exchange.

При использовании параметра Queue нельзя использовать параметры Identity, Filter и Server.

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

Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 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

ReturnPageInfo — это скрытый параметр. Он служит для получения сведений об общем количестве результатов и индексе первого объекта текущей страницы. Значение по умолчанию — $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

Параметр SearchForward указывает, должен ли поиск в наборе результатов выполняться в прямом или обратном порядке. Значение по умолчанию — $true. Если указано это значение, при возврате страницы результатов используется прямой порядок поиска от начала набора результатов или от закладки, если она указана.

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

Параметр Server задает сервер Exchange, на котором следует выполнить эту команду. Можно использовать любое значение, однозначно определяющее сервер. Примеры:

  • Имя.
  • полное доменное имя;
  • различающееся имя (DN);
  • Устаревшее различающееся имя Exchange

Устаревшее различающееся имя Exchange

Параметр Server можно использовать вместе с параметром Filter в одной команде. Параметр Server невозможно использовать вместе с параметром Identity в одной команде.

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

Параметр SortOrder указывает массив свойств сообщений, которые используются для управления порядком сортировки набора результатов. Каждое свойство отделяется запятой. Для отображения результатов в порядке возрастания вставьте символ "плюс" (+) в начале имени свойства. Для отображения результатов в порядке убывания вставьте символ "минус" (-) в начале имени свойства.

Если порядок сортировки не указан, результирующий набор отображается в порядке возрастания целого числа 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

Входные данные

Input types

Сведения о типах входных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип ввода для командлета пустое, командлет не принимает входные данные.

Выходные данные

Output types

Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.