lorentz/wulf-pulse
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
wulf-pulse/.firecrawl/mimecast-hold-docs.md
lorentz fcdec8e38b feat: Mimecast multi-tenant held mail viewer 
- migration 062: mimecast_tenants table (company_id, client_id/secret, account_code)
- Seed Wulf (CUSA13A95) + Seubert (CUSA96A181) tenants
- MimecastClient.getHeldMessages(): full pagination via meta.pagination.next cursor
  (API always returns 10/page regardless of pageSize param, totalCount in meta)
- getMimecastClientForTenant() factory for per-tenant instantiation
- GET /api/mimecast/held?tenantId=&recipient= — fetches all tenants in parallel,
  merges + sorts by date, returns per-tenant counts + combined messages[]
- Held Mail tab on /admin/sync/mimecast (on-demand load, recipient filter,
  tenant badges, policy filter dropdown, DMARC/impersonation highlighted red)
2026-03-31 22:38:22 -04:00

1074 lines
No EOL
42 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[Mimecast](https://integrations.mimecast.com/)
Getting started
[API 2.0 Overview](https://developer.services.mimecast.com/api-overview) [API 1.0 to 2.0 Migration Guide](https://developer.services.mimecast.com/api-1-0-to-2-0-migration-guide) [What's New](https://developer.services.mimecast.com/whats-new)
API Documentation
[Action Usecase](https://developer.services.mimecast.com/action-usecase) [Alerting Usecase](https://developer.services.mimecast.com/alerting-usecase) [Analysis and Response API's](https://developer.services.mimecast.com/analysis-and-response-apis) [Building Search Queries](https://developer.services.mimecast.com/building-search-queries) [Configuration Backup Restore and Export APIs](https://developer.services.mimecast.com/configuration-backup-restore-and-export-apis) [Enrichment Usecase](https://developer.services.mimecast.com/enrichment-usecase) [Groups Usecase](https://developer.services.mimecast.com/groups-usecase) [Mimecast API In Power BI](https://developer.services.mimecast.com/mimecast-api-powerbi) [Secure Email Gateway](https://developer.services.mimecast.com/secure-email-gateway) [SIEM Tutorial CG](https://developer.services.mimecast.com/siem-tutorial-cg) [SIEM Tutorial CI](https://developer.services.mimecast.com/siem-tutorial-ci) [SIEM Batch CG Guidelines](https://developer.services.mimecast.com/siem-batch-guidelines) [SIEM Batch CI Guidelines](https://developer.services.mimecast.com/siem-batch-guidelines-ci)
APIs
[API 2.0 Reference](https://developer.services.mimecast.com/apis) [API 1.0 Reference](https://integrations.mimecast.com/documentation/api-overview/)
[Technology Partners](https://integrations.mimecast.com/tech-partners/)
[Become a Partner](https://integrations.mimecast.com/become-a-technology-alliance-partner/)
EN
[English](https://integrations.mimecast.com/) [Deutsch](https://integrations.mimecast.com/de/) [Français](https://integrations.mimecast.com/fr/) [Español](https://integrations.mimecast.com/es/) [Italiano](https://integrations.mimecast.com/it/)
1. [Tech Connect](https://integrations.mimecast.com/)
2. [Documentation](https://integrations.mimecast.com/documentation/)
3. [API 1.0 Endpoint Reference](https://integrations.mimecast.com/documentation/endpoint-reference/)
4. [Message Queues](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/)
5. Get Hold Message List
# Get Hold Message List
[Documentation](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
Documentation
- API 2.0 Overview
- API 2.0 Reference
- API 1.0 Reference
- What's New
- API 1.0 Overview [Expand or Collapse API 1.0 Overview Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [API Concepts](https://integrations.mimecast.com/documentation/api-overview/api-concepts/)
- [Authentication and Authorization](https://integrations.mimecast.com/documentation/api-overview/authentication-and-authorization/)
- [Authentication (Scripts and Server Apps)](https://integrations.mimecast.com/documentation/api-overview/authentication-scripts-server-apps/)
- [Authorization](https://integrations.mimecast.com/documentation/api-overview/authorization/)
- [Response Codes](https://integrations.mimecast.com/documentation/api-overview/response-code/)
- [API Call Restrictions](https://integrations.mimecast.com/documentation/api-overview/rate-limiting/)
- [Global Base URLs](https://integrations.mimecast.com/documentation/api-overview/global-base-urls/)
- API 1.0 Tutorials [Expand or Collapse API 1.0 Tutorials Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Action Use Cases](https://integrations.mimecast.com/documentation/tutorials/action-use-cases/)
- [Alerting Use Cases](https://integrations.mimecast.com/documentation/tutorials/alerting-use-cases/)
- [Enrichment Use Cases](https://integrations.mimecast.com/documentation/tutorials/enrichment-use-cases/)
- [Groups Use Cases](https://integrations.mimecast.com/documentation/tutorials/groups-use-cases/)
- [Understanding SIEM Logs](https://integrations.mimecast.com/documentation/tutorials/understanding-siem-logs/)
- [Downloading SIEM logs](https://integrations.mimecast.com/documentation/tutorials/downloading-siem-logs/)
- [Building Search Queries](https://integrations.mimecast.com/documentation/tutorials/building-search-queries/)
- [Mimecast API in Power BI](https://integrations.mimecast.com/documentation/tutorials/mimecast-api-in-power-bi/)
- [Using Postman](https://integrations.mimecast.com/documentation/tutorials/using-postman/)
- API 1.0 Endpoint Reference [Expand or Collapse API 1.0 Endpoint Reference Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Event Streaming Service](https://integrations.mimecast.com/documentation/endpoint-reference/event-streaming-service/) [Expand or Collapse Event Streaming Service Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Events](https://integrations.mimecast.com/documentation/endpoint-reference/event-streaming-service/get-events/)
- [Get Latest Token](https://integrations.mimecast.com/documentation/endpoint-reference/event-streaming-service/get-latest-token/)
- [Web Security Logs](https://integrations.mimecast.com/documentation/endpoint-reference/event-streaming-service/web-security-logs/) [Expand or Collapse Web Security Logs Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [DNS Request Logs](https://integrations.mimecast.com/documentation/endpoint-reference/event-streaming-service/web-security-logs/dns-request-logs/)
- [Proxy Event Logs](https://integrations.mimecast.com/documentation/endpoint-reference/event-streaming-service/web-security-logs/proxy-event-logs/)
- [Account](https://integrations.mimecast.com/documentation/endpoint-reference/account/) [Expand or Collapse Account Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Support Info](https://integrations.mimecast.com/documentation/endpoint-reference/account/get-support-info/)
- [Get Products](https://integrations.mimecast.com/documentation/endpoint-reference/account/get-products/)
- [Get Dashboard Notifications](https://integrations.mimecast.com/documentation/endpoint-reference/account/get-dashboard-notifications/)
- [Get Account](https://integrations.mimecast.com/documentation/endpoint-reference/account/get-account/)
- [Archive](https://integrations.mimecast.com/documentation/endpoint-reference/archive/) [Expand or Collapse Archive Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Search](https://integrations.mimecast.com/documentation/endpoint-reference/archive/search/)
- [Get Message Part](https://integrations.mimecast.com/documentation/endpoint-reference/archive/get-message-part/)
- [Get Message List](https://integrations.mimecast.com/documentation/endpoint-reference/archive/get-message-list/)
- [Get Message Detail](https://integrations.mimecast.com/documentation/endpoint-reference/archive/get-message-detail/)
- [Get File](https://integrations.mimecast.com/documentation/endpoint-reference/archive/get-file/)
- [Awareness Training](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/) [Expand or Collapse Awareness Training Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Campaigns](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-campaigns/)
- [Get Campaign User Data](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-campaign-user-data/)
- [Get Performance Details](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-performance-details/)
- [Get Performance Summary](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-performance-summary/)
- [Get Phishing Campaign](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-phishing-campaign/)
- [Get Phishing User Data](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-phishing-user-data/)
- [Get SAFE Score Details](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-safe-score-details/)
- [Get SAFE Score Summary](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-safe-score-summary/)
- [Get Training Queue](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-training-queue/)
- [Get Training Details](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-training-details/)
- [Get Watchlist Details](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-watchlist-details/)
- [Get Watchlist Summary](https://integrations.mimecast.com/documentation/endpoint-reference/awareness-training/get-watchlist-summary/)
- [Policies](https://integrations.mimecast.com/documentation/endpoint-reference/policies/) [Expand or Collapse Policies Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Address Alteration](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/) [Expand or Collapse Address Alteration Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Create Definition](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/create-definition/)
- [Create Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/create-policy/)
- [Create Set](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/create-set/)
- [Delete Definition](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/delete-definition/)
- [Delete Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/delete-policy/)
- [Get Definition](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/get-definition/)
- [Get Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/get-policy/)
- [Get Set](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/get-set/)
- [Update Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/address-alteration/update-policy/)
- [Anti-Spoofing SPF Bypass](https://integrations.mimecast.com/documentation/endpoint-reference/policies/antispoofing-spf-bypass/) [Expand or Collapse Anti-Spoofing SPF Bypass Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Create Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/antispoofing-spf-bypass/create-policy/)
- [Delete Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/antispoofing-spf-bypass/delete-policy/)
- [Get Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/antispoofing-spf-bypass/get-policy/)
- [Update Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/antispoofing-spf-bypass/update-policy/)
- [Blocked Sender Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/blocked-sender-policy/) [Expand or Collapse Blocked Sender Policy Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/blocked-sender-policy/get-policy/)
- [Create Policy](https://integrations.mimecast.com/documentation/endpoint-reference/policies/blocked-sender-policy/create-policy/)
- [Directory](https://integrations.mimecast.com/documentation/endpoint-reference/directory/) [Expand or Collapse Directory Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Create Group](https://integrations.mimecast.com/documentation/endpoint-reference/directory/create-group/)
- [Update Group](https://integrations.mimecast.com/documentation/endpoint-reference/directory/update-group/)
- [Delete Group](https://integrations.mimecast.com/documentation/endpoint-reference/directory/delete-group/)
- [Remove Group Member](https://integrations.mimecast.com/documentation/endpoint-reference/directory/remove-group-member/)
- [Get Group Members](https://integrations.mimecast.com/documentation/endpoint-reference/directory/get-group-members/)
- [Find Groups](https://integrations.mimecast.com/documentation/endpoint-reference/directory/find-groups/)
- [Add Group Member](https://integrations.mimecast.com/documentation/endpoint-reference/directory/add-group-member/)
- [Directory Sync](https://integrations.mimecast.com/documentation/endpoint-reference/directory-sync/) [Expand or Collapse Directory Sync Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Connection](https://integrations.mimecast.com/documentation/endpoint-reference/directory-sync/get-connection/)
- [Execute Sync](https://integrations.mimecast.com/documentation/endpoint-reference/directory-sync/execute-sync/)
- [Domain](https://integrations.mimecast.com/documentation/endpoint-reference/domain/) [Expand or Collapse Domain Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Verify Domain](https://integrations.mimecast.com/documentation/endpoint-reference/domain/verify-domain/)
- [Get Verification Code](https://integrations.mimecast.com/documentation/endpoint-reference/domain/get-verification-code/)
- [Get Provision Status](https://integrations.mimecast.com/documentation/endpoint-reference/domain/get-provision-status/)
- [Get Pending Domain](https://integrations.mimecast.com/documentation/endpoint-reference/domain/get-pending-domain/)
- [Get Internal Domain](https://integrations.mimecast.com/documentation/endpoint-reference/domain/get-internal-domain/)
- [Delete Pending Domain](https://integrations.mimecast.com/documentation/endpoint-reference/domain/delete-pending-domain/)
- [Create Domain](https://integrations.mimecast.com/documentation/endpoint-reference/domain/create-domain/)
- [Email](https://integrations.mimecast.com/documentation/endpoint-reference/email/) [Expand or Collapse Email Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [File Upload](https://integrations.mimecast.com/documentation/endpoint-reference/email/file-upload/)
- [Send Email](https://integrations.mimecast.com/documentation/endpoint-reference/email/send-email/)
- [Logs and Statistics](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/) [Expand or Collapse Logs and Statistics Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Archive Message View](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-archive-message-view-logs/)
- [Get Archive Search Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-archive-search-logs/)
- [Get Audit Events](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-audit-events/)
- [Get DLP Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-dlp-logs/)
- [Get Journal Service](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-journal-service/)
- [Message Release Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-message-release-logs/)
- [Get Rejection Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-rejection-logs/)
- [Get Search Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-search-logs/)
- [Get SIEM Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-siem-logs/)
- [Get TTP Attachment Protection Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-ttp-attachment-protection-logs/)
- [Get TTP Impersonation Protect Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-ttp-impersonation-protect-logs/)
- [Get TTP URL Logs](https://integrations.mimecast.com/documentation/endpoint-reference/logs-and-statistics/get-ttp-url-logs/)
- [Managed Sender](https://integrations.mimecast.com/documentation/endpoint-reference/managed-sender/) [Expand or Collapse Managed Sender Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Permit or Block Sender](https://integrations.mimecast.com/documentation/endpoint-reference/managed-sender/permit-or-block-sender/)
- [Message Finder (formerly Tracking)](https://integrations.mimecast.com/documentation/endpoint-reference/message-finder-formerly-tracking/) [Expand or Collapse Message Finder (formerly Tracking) Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Search](https://integrations.mimecast.com/documentation/endpoint-reference/message-finder-formerly-tracking/search/)
- [Get Message Info](https://integrations.mimecast.com/documentation/endpoint-reference/message-finder-formerly-tracking/get-message-info/)
- [Message Queues](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/) [Expand or Collapse Message Queues Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Find Processing Messages](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/find-processing-messages/)
- [Get Hold Message List](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/)
- [Get Message Detail](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-message-detail/)
- [Get File](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-file/)
- [Get Message Hold Summary List](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-summary-list/)
- [Reject Message](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/reject-message/)
- [Release Message](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/release-message/)
- [Inbound & Outbound Queues](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/inbound-outbound-queues/)
- [Targeted Threat Protection URL Protect](https://integrations.mimecast.com/documentation/endpoint-reference/targeted-threat-protection-url-protect/) [Expand or Collapse Targeted Threat Protection URL Protect Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Get Managed URL](https://integrations.mimecast.com/documentation/endpoint-reference/targeted-threat-protection-url-protect/get-managed-url/)
- [Delete Managed URL](https://integrations.mimecast.com/documentation/endpoint-reference/targeted-threat-protection-url-protect/delete-managed-url/)
- [Decode URL](https://integrations.mimecast.com/documentation/endpoint-reference/targeted-threat-protection-url-protect/decode-url/)
- [Create Managed URL](https://integrations.mimecast.com/documentation/endpoint-reference/targeted-threat-protection-url-protect/create-managed-url/)
- [Threat Intel](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/) [Expand or Collapse Threat Intel Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Bring Your Own](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/bring-your-own/) [Expand or Collapse Bring Your Own Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Create Batch](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/bring-your-own/create-batch/)
- [Get Batches](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/bring-your-own/get-batches/)
- [Delete Batch](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/bring-your-own/delete-batch/)
- [Get Quota](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/bring-your-own/get-quota/)
- [Get Feed](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/get-feed/)
- [Search Hash](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/search-hash/)
- [Find Incidents](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/find-incidents/)
- [Get Incident](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/get-incident/)
- [Create Incident](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/create-incident/)
- [Create Incident v2](https://integrations.mimecast.com/documentation/endpoint-reference/threat-intel/create-incident-v2/)
- [Web Security](https://integrations.mimecast.com/documentation/endpoint-reference/web-security/) [Expand or Collapse Web Security Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Create Policy](https://integrations.mimecast.com/documentation/endpoint-reference/web-security/create-policy/)
- [Get Policies](https://integrations.mimecast.com/documentation/endpoint-reference/web-security/get-policies/)
- [Delete Policy](https://integrations.mimecast.com/documentation/endpoint-reference/web-security/delete-policy/)
- [Update Policy](https://integrations.mimecast.com/documentation/endpoint-reference/web-security/update-policy/)
- [User](https://integrations.mimecast.com/documentation/endpoint-reference/user/) [Expand or Collapse User Children](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
- [Update User](https://integrations.mimecast.com/documentation/endpoint-reference/user/update-user/)
- [Update Attributes](https://integrations.mimecast.com/documentation/endpoint-reference/user/update-attributes/)
- [Update Alias](https://integrations.mimecast.com/documentation/endpoint-reference/user/update-alias/)
- [Remove Alias](https://integrations.mimecast.com/documentation/endpoint-reference/user/remove-alias/)
- [Get Profile](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-profile/)
- [Get Most Used Contacts](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-most-used-contacts/)
- [Get Internal Users](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-internal-users/)
- [Remove Delegate User](https://integrations.mimecast.com/documentation/endpoint-reference/user/remove-delegate-user/)
- [Add Delegate User](https://integrations.mimecast.com/documentation/endpoint-reference/user/add-delegate-user/)
- [Find Delegate Users](https://integrations.mimecast.com/documentation/endpoint-reference/user/find-delegate-users/)
- [Get Delegated Access](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-delegated-access/)
- [Get Attributes](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-attributes/)
- [Get Aliases](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-aliases/)
- [Create user](https://integrations.mimecast.com/documentation/endpoint-reference/user/create-user/)
- [Import Users](https://integrations.mimecast.com/documentation/endpoint-reference/user/import-users/)
- [Get User Import Status](https://integrations.mimecast.com/documentation/endpoint-reference/user/get-user-import-status/)
**In this guide:**
- [Description](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#description)
- [Pre-requisites](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#pre-requisites)
- [URI](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#uri)
- [Request Headers](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#request-headers)
- [Request Body](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#request-body)
- [Response](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#response)
- [Sample Code](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#sample-code)
#### Description
This API endpoint can be used to get information about held messages, including the reason, hold level, sender and recipients. The ID can be used to act on a message using the Release Message or Reject Message API endpoints.
#### Pre-requisites
- In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the **Account \| Dashboard \| Read** permission.
#### URI
To use this endpoint you send a POST request to:
- /api/gateway/get-hold-message-list
#### Request Headers
The following request headers must be included in your request:
| **Field** | **Description** |
| --- | --- |
| Authorization | Please see the [Authorization](https://integrations.mimecast.com/documentation/api-overview/authorization/) guide for more information on building the Authorization header. |
| x-mc-req-id | A randomly generated GUID, for example,<br>```<br>8578FCFC-A305-4D9A-99CB-F4D5ECEFE297<br>``` |
| x-mc-app-id | The Application ID provided with your Registered API Application. |
| x-mc-date | The current date and time in the following format, for example,<br>```<br>Tue, 24 Nov 2015 12:50:11 UTC<br>``` |
#### Request Body
```
{
"data": [\
\
{\
\
"admin": true,\
\
"start": "2015-11-16T14:49:18+0000",\
\
"searchBy": {\
\
"fieldName": "String",\
\
"value": "String"\
\
},\
\
"end": "2015-11-16T14:49:18+0000"\
\
}\
\
]
}
```
##### data
| **Field** | **Type** | **Required** | **Description** |
| --- | --- | --- | --- |
| admin | Boolean | Optional | Level of results to return. If false, only results for the currenlty authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false. |
| searchBy | Object | Optional | Object data used to filter results |
| start | Date String | Optional | The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000 |
| end | Date String | Optional | The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000 |
##### searchBy
| **Field** | **Type** | **Required** | **Description** |
| --- | --- | --- | --- |
| value | String | Optional | The text used to filter results |
| fieldName | String | Optional | Message fields to filter based on. Possible values are: all, subject, sender, recipient, reason\_code |
#### Response
```
{
"fail": [],
"meta": {
"status": 200
},
"data": [\
\
{\
\
"dateReceived": "String",\
\
"reason": "String",\
\
"reasonCode": "String",\
\
"id": "String",\
\
"size": 1000,\
\
"from": {\
\
"displayableName": "String",\
\
"emailAddress": "String"\
\
},\
\
"hasAttachments": "true",\
\
"route": "String",\
\
"policyInfo": "String",\
\
"fromHeader": {\
\
"displayableName": "String",\
\
"emailAddress": "String"\
\
},\
\
"to": {\
\
"displayableName": "String",\
\
"emailAddress": "String"\
\
},\
\
"reasonId": "String",\
\
"subject": "String"\
\
}\
\
]
}
```
##### meta object
| **Field** | **Type** | **Description** |
| --- | --- | --- |
| status | Number | The function level status of the request. |
##### meta
| **Field** | **Type** | **Description** |
| --- | --- | --- |
| status | Number | The function level status of the request. |
##### data
| **Field** | **Type** | **Description** |
| --- | --- | --- |
| id | String | The Mimecast secure ID for a message |
| reason | String | The summary reason for holding the message |
| reasonId | String | Mirrors the reason field, formatted without spaces. However, reasonCode should be used instead |
| reasonCode | String | Reason code for holding the message |
| from | Object | Contains the envelope sender information |
| fromHeader | Object | Contains the header sender information |
| to | Object | Contains the envelope recipient information |
| toHeader | Object | Contains the header recipient information |
| subject | String | The message subject |
| route | String | Direction of message being held. Possible values are: INBOUND, OUTBOUND, INTERNAL, EXTERNAL |
| hasAttachments | Boolean | Returns true if the message contains attachments. False indicates no attachments |
| size | Integer | The size of the message in bytes |
| dateReceived | Date String | The timestamp of the message transmission |
| policyInfo | String | Information or definition name triggering the message hold action |
#### Sample Code
Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the [Global Base URL's](https://integrations.mimecast.com/documentation/api-overview/global-base-urls/) page to find the correct base URL to use for your account.
HTTPPythonC#PowerShellJava
```
POST {base_url}/api/gateway/get-hold-message-list
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json
{
"data":[\
\
{\
\
"data":[\
\
{\
\
"searchBy": {\
\
"value": "String",\
\
"fieldName": "String"\
\
},\
\
"start": "2015-11-16T14:49:18+0000",\
\
"admin": true,\
\
"end": "2015-11-16T14:49:18+0000"\
\
}\
\
]\
\
}\
\
]
}
```
```
import base64
import hashlib
import hmac
import uuid
import datetime
import requests
# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/gateway/get-hold-message-list"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"
app_id = "YOUR APPLICATION ID"
app_key = "YOUR APPLICATION KEY"
# Generate request header values
request_id = str(uuid.uuid4())
hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"
# DataToSign is used in hmac_sha1
dataToSign = ':'.join([hdr_date, request_id, uri, app_key])
# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(base64.b64decode(secret_key), dataToSign.encode(), digestmod=hashlib.sha1).digest()
# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.b64encode(hmac_sha1).rstrip()
# Create request headers
headers = {
'Authorization': 'MC ' + access_key + ':' + sig.decode(),
'x-mc-app-id': app_id,
'x-mc-date': hdr_date,
'x-mc-req-id': request_id,
'Content-Type': 'application/json'
}
payload = {
'data': [\
\
{\
\
"searchBy": {\
\
"value": "String",\
\
"fieldName": "String"\
\
},\
\
"start": "2015-11-16T14:49:18+0000",\
\
"admin": true,\
\
"end": "2015-11-16T14:49:18+0000"\
\
}\
\
]
}
r = requests.post(url=url, headers=headers, data=str(payload))
print(r.text)
```
```
static void Main(string[] args)
{
//Setup required variables
string baseUrl = "https://xx-api.mimecast.com";
string uri = "/api/gateway/get-hold-message-list";
string accessKey = "YOUR ACCESS KEY";
string secretKey = "YOUR SECRET KEY";
string appId = "YOUR APPLICATION ID";
string appKey = "YOUR APPLICATION KEY";
//Generate request header values
string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
string requestId = System.Guid.NewGuid().ToString();
//Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));
//Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));
//Build the signature to be included in the Authorization header in your request
string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);
//Build Request
System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
request.Method = "POST";
request.ContentType = "application/json";
//Add Headers
request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
request.Headers.Add("x-mc-date", hdrDate);
request.Headers.Add("x-mc-req-id", requestId);
request.Headers.Add("x-mc-app-id", appId);
//Add request body
//Create and write data to stream
string postData = @"{
""data"": [\
\
{\
\
""searchBy"": {\
\
""value"": ""String"",\
\
""fieldName"": ""String""\
\
},\
\
""start"": ""2015-11-16T14:49:18+0000"",\
\
""admin"": true,\
\
""end"": ""2015-11-16T14:49:18+0000""\
\
}\
\
]
}";
byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);
System.IO.Stream stream = request.GetRequestStream();
stream.Write(payload, 0, payload.Length);
stream.Close();
//Send Request
System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();
//Output response to console
System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
string responseBody = "";
string temp = null;
while ((temp = reader.ReadLine()) != null)
{
responseBody += temp;
};
System.Console.WriteLine(responseBody);
System.Console.ReadLine();
}
```
```
#Setup required variables
$baseUrl = "https://xx-api.mimecast.com"
$uri = "/api/gateway/get-hold-message-list"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"
$appId = "YOUR APPLICATION ID"
$appKey = "YOUR APPLICATION KEY"
#Generate request header values
$hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
$requestId = [guid]::NewGuid().guid
#Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
$sha = New-Object System.Security.Cryptography.HMACSHA1
$sha.key = [Convert]::FromBase64String($secretKey)
$sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
$sig = [Convert]::ToBase64String($sig)
#Create Headers
$headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
"x-mc-date" = $hdrDate;
"x-mc-app-id" = $appId;
"x-mc-req-id" = $requestId;
"Content-Type" = "application/json"}
#Create post body
$postBody = "{
""data"": [\
\
{\
\
""searchBy"": {\
\
""value"": ""String"",\
\
""fieldName"": ""String""\
\
},\
\
""start"": ""2015-11-16T14:49:18+0000"",\
\
""admin"": true,\
\
""end"": ""2015-11-16T14:49:18+0000""\
\
}\
\
]
}"
#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url
#Print the response
$response
```
```
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {
//set up variables for request
String baseUrl = "https://xx-api.mimecast.com";
String uri = "/api/gateway/get-hold-message-list";
String url = "https://" + baseUrl + uri;
String accessKey = "YOUR ACCESS KEY";
String secretKey = "YOUR SECRET KEY";
String appId = "YOUR APPLICATION ID";
String appKey = "YOUR APPLICATION KEY";
//create URL object
java.net.URL obj = new java.net.URL(url);
// set guid for x-mc-req-id header
String guid = java.util.UUID.randomUUID().toString();
// set date for x-mc-date header
java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
String date = sdf.format(new java.util.Date());
//create signature for the Authorization header
String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
String hmacSHA1 = "HmacSHA1";
javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
mac.init(signingKey);
String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));
// create request object
javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();
//set request type to POST
con.setRequestMethod("POST");
con.setDoOutput(true);
//add reuqest headers
con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
con.setRequestProperty("x-mc-req-id", guid);
con.setRequestProperty("x-mc-app-id", appId);
con.setRequestProperty("x-mc-date", date);
con.setRequestProperty("Content-Type", "application/json");
con.setRequestProperty("Accept", "application/json");
//Add post body to the request
String postBody = "{\n" +
" \"data\": [\n" +\
\
" {\n" +\
\
" \"searchBy\": {\n" +\
\
" \"value\": \"String\",\n" +\
\
" \"fieldName\": \"String\"\n" +\
\
" }\n" +\
\
" \"start\": \"2015-11-16T14:49:18+0000\",\n" +\
\
" \"admin\": true,\n" +\
\
" \"end\": \"2015-11-16T14:49:18+0000\"\n" +\
\
" }\n" +\
\
" ]\n" +
"}";
java.io.OutputStream os = con.getOutputStream();
os.write(postBody.getBytes("UTF-8"));
os.close();
//process response
java.io.BufferedReader in = new java.io.BufferedReader(
new java.io.InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
//return result
java.lang.System.out.println(response.toString());
}
```
![Mimecast-White-Logo.png](https://assets.mimecast.com/api/public/content/9610786917994c9abf8bdbed75cc8f5a?v=890c9fbb)
[Privacy Statement](https://www.mimecast.com/legal/privacy-statement/)
[Legal](https://www.mimecast.com/legal/)
[Privacy Preferences](https://www.mimecast.com/privacy-preferences/)
[Responsible Disclosure](https://www.mimecast.com/responsible-disclosure/)
© 2003 – 2026 Mimecast Services limited.
[Back to Top](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#)
Reference in a new issue View git blame Copy permalink