Get-Message
Этот командлет доступен только в локальной среде Exchange.
Командлет Get-Message используется для просмотра сведений одного или нескольких сообщений в очереди на серверах почтовых ящиков или пограничных транспортных серверах.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Filter
Get-Message
[-Filter <String>]
[-BookmarkIndex <Int32>]
[-BookmarkObject <ExtensibleMessageInfo>]
[-IncludeBookmark <Boolean>]
[-IncludeComponentLatencyInfo]
[-IncludeRecipientInfo]
[-ResultSize <Unlimited>]
[-ReturnPageInfo <Boolean>]
[-SearchForward <Boolean>]
[-Server <ServerIdParameter>]
[-SortOrder <QueueViewerSortOrderEntry[]>]
[<CommonParameters>]
Identity
Get-Message
[[-Identity] <MessageIdentity>]
[-BookmarkIndex <Int32>]
[-BookmarkObject <ExtensibleMessageInfo>]
[-IncludeBookmark <Boolean>]
[-IncludeComponentLatencyInfo]
[-IncludeRecipientInfo]
[-ResultSize <Unlimited>]
[-ReturnPageInfo <Boolean>]
[-SearchForward <Boolean>]
[-SortOrder <QueueViewerSortOrderEntry[]>]
[<CommonParameters>]
Queue
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
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр BookmarkIndex задает позицию в наборе результатов, с которой начинаются отображаемые результаты. Значение этого параметра — индекс с отсчетом от единицы в общем наборе результатов. Параметр BookmarkIndex невозможно использовать вместе с параметром BookmarkObject.
Свойства параметров
| Тип: | Int32 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-BookmarkObject
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр BookmarkObject задает в наборе результатов объект, с которого начинаются отображаемые результаты. Параметр BookmarkObject невозможно использовать вместе с параметром BookmarkIndex.
Свойства параметров
| Тип: | ExtensibleMessageInfo |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Filter
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр Filter задает одно или несколько сообщений с помощью синтаксиса фильтра OPATH. Фильтр OPATH включает имя свойства сообщения, за которым следует оператор сравнения и значение (например, "FromAddress -like '*@contoso.com'"). Дополнительные сведения о свойствах фильтруемых сообщений и операторах сравнения см. в статьях Свойства сообщений в очередях и Поиск очередей и сообщений в очередях в командной консоли Exchange.
Можно указать несколько условий с помощью оператора сравнения и . Значения свойств, не выраженные в виде целого числа, должны заключаться в кавычки (").
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Filter
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр Identity определяет сообщение. Чтобы указать этот параметр, используйте синтаксис Server\Queue\MessageInteger, Queue\MessageInteger или MessageInteger, например Mailbox01\contoso.com\5 или 10. Дополнительные сведения об идентификаторе сообщения см. в разделе Удостоверение сообщения.
Внимание! Значение $null или несуществующее значение для параметра Identity возвращает все объекты, как если бы вы выполнили команду Get- без параметра Identity. Убедитесь, что все списки значений для параметра Identity являются точными и не содержат несуществующих $null значений.
Свойства параметров
| Тип: | MessageIdentity |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Identity
| Position: | 1 |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-IncludeBookmark
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр IncludeBookmark указывает, используется ли объект закладок при отображении результатов запроса. Параметр IncludeBookmark допустимо использовать только с параметром BookmarkObject или BookmarkIndex. Если значение для параметра IncludeBookmark не указано, используется значение по умолчанию — $true.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-IncludeComponentLatencyInfo
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Переключатель IncludeComponentLatencyInfo указывает, будут ли сведения о задержке компонентов включаться в свойства сообщения. С этим параметром не нужно указывать значение.
Если включить этот параметр, возвращаемые объекты сообщений включают измерения задержки для каждого компонента транспорта, который способствовал задержке локального сервера для каждого сообщения в очереди.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-IncludeRecipientInfo
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр 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.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Queue
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр Queue указывает удостоверение очереди, содержащей сообщения, которые нужно отобразить. Допустимые входные данные для этого параметра используют синтаксис <Server>\<Queue> или <Queue>, например Mailbox01\contoso.com или Unreachable. Дополнительные сведения об идентификаторе очереди см. в разделе "Удостоверение очереди" статьи Поиск очередей и сообщений в очередях в командной консоли Exchange.
При использовании параметра Queue нельзя использовать параметры Identity, Filter и Server.
Свойства параметров
| Тип: | QueueIdentity |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Queue
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-ResultSize
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.
Свойства параметров
| Тип: | Unlimited |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ReturnPageInfo
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
ReturnPageInfo — это скрытый параметр. Он служит для получения сведений об общем количестве результатов и индексе первого объекта текущей страницы. Значение по умолчанию — $false.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SearchForward
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр SearchForward указывает, должен ли поиск в наборе результатов выполняться в прямом или обратном порядке. Значение по умолчанию — $true. Если указано это значение, при возврате страницы результатов используется прямой порядок поиска от начала набора результатов или от закладки, если она указана.
Свойства параметров
| Тип: | Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Server
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр Server задает сервер Exchange, на котором следует выполнить эту команду. Можно использовать любое значение, однозначно определяющее сервер. Примеры:
- Имя.
- полное доменное имя;
- различающееся имя (DN);
- Устаревшее различающееся имя Exchange
Устаревшее различающееся имя Exchange
Параметр Server можно использовать вместе с параметром Filter в одной команде. Параметр Server невозможно использовать вместе с параметром Identity в одной команде.
Свойства параметров
| Тип: | ServerIdParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Filter
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-SortOrder
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Параметр SortOrder указывает массив свойств сообщений, которые используются для управления порядком сортировки набора результатов. Каждое свойство отделяется запятой. Для отображения результатов в порядке возрастания вставьте символ "плюс" (+) в начале имени свойства. Для отображения результатов в порядке убывания вставьте символ "минус" (-) в начале имени свойства.
Если порядок сортировки не указан, результирующий набор отображается в порядке возрастания целого числа MessageIdentity.
Свойства параметров
| Тип: | QueueViewerSortOrderEntry[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.
Входные данные
Input types
Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.
Выходные данные
Output types
Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.