The CloudRadial AutomationAI Mimecast extension lets a workflow or agent work with your Mimecast email-security gateway: trace a message, triage the held-message queue, review URL Protect, Attachment Protect, and rejection logs, and look up directory and audit data. With approval, it can release or reject held messages, permit or block a sender, and add or remove URL Protect managed URLs. This article covers what the extension can do, the API 2.0 credentials it needs, which tools require approval, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Creating the API 2.0 Keys
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With Mimecast Data
What the Extension Covers
The extension calls the Mimecast API 2.0 and provides 18 tools across these areas:
| Area | What you can automate |
| Message tracking | Search for messages that passed through the gateway by sender, recipient, or subject within a time window, and read a message's delivery route, status, and spam and threat verdicts |
| Held messages | List held (quarantined) messages, summarize the held queue by hold reason, read one held message's headers, route, and attachments, and release or reject held messages |
| Logs | Read held-message release logs, rejection and deferral logs, URL Protect click logs, and Attachment Protect scan logs within a date window |
| Senders | Read blocked-sender policies, and permit or block a sender for a recipient |
| Managed URLs | List the URL Protect managed URLs (the permit and block list), and add or remove an entry |
| Directory and audit | List the internal users and mailboxes for a domain, and read the admin audit trail within a date window |
Install it from Extensions like any other catalog extension. It appears in the catalog as Mimecast. See Browsing and installing extensions for the general install flow.
Creating the API 2.0 Keys
The extension signs in to the Mimecast API 2.0 with an application's client id and client secret. API 1.0 access keys and secret keys are not used.
- In the Mimecast Administration Console, go to Administration > Services > API and Platform Integrations > Mimecast API 2.0.
- Click Generate Keys to create an API 2.0 application.
- Copy the client id and the client secret. Mimecast shows the client secret only once.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names:
| Secret | Value |
Mimecast-ApiUrl |
The Mimecast API 2.0 base URL, normally https://api.services.mimecast.com, with no path after it. API 2.0 uses this single global host. |
Mimecast-ClientId |
The client id of your API 2.0 application |
Mimecast-ClientSecret |
The client secret that pairs with that client id |
The extension uses the client id and secret to request an access token from Mimecast and renews it as needed. For how to add secrets, see Accessing and updating your runner's Key Vault. If you keep a separate Mimecast account per client, see Managing companies and per-company credentials.
The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground for a summary of your held-message queue to confirm the connection works.
Reads and Approval-Gated Changes
Of the 18 tools, 13 are read-only and run without interruption. The other 5 change mail flow or policy, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Release a held message; reject held messages; permit or block a sender; add a managed URL; remove a managed URL |
| Read-only | Search messages; read message tracking detail; list held messages; read the hold summary; read held-message detail; read release, rejection, URL Protect, and Attachment Protect logs; read blocked-sender policies; list managed URLs; list internal users; read audit events |
The agent identifies the message, sender, or managed URL with a read tool before it asks to change anything. Releasing a message delivers it to the recipient, and a permit or block entry overrides spam scoring for that sender, so review the details in the approval request before you approve it.
Skills
The extension ships five skills that guide an agent through common Mimecast tasks:
| Skill | Use it to |
| Investigate Email (Message Tracking) | Find and trace a message by sender, recipient, or subject, and read its delivery route and threat verdicts. Read-only. |
| Manage Held Messages | Triage the held queue, then release legitimate mail or reject malicious mail. Release and reject are approval-gated. |
| Manage Sender Policies / Managed URLs | Block or permit a sender, or add or remove a URL in the URL Protect permit and block list. Changes are approval-gated. |
| Review Threat Logs | Review URL Protect clicks, Attachment Protect scans, and edge rejections to spot malicious mail or measure exposure. Read-only. |
| Audit & Directory Lookups | Review the admin audit trail or look up the internal users and mailboxes for a domain. Read-only. |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With Mimecast Data
- Give a time window when you ask to trace a message or review logs. Message tracking requires one; a relative window such as "the last 24 hours" works, and the agent converts it.
- The admin audit trail looks back up to 60 days
- Mimecast has no list of managed senders in API 2.0. To see which senders are blocked, ask for the blocked-sender policies.
- A managed URL entry blocks or permits either an exact URL or a whole domain. Say which you want, and the agent checks the existing list first to avoid a duplicate.
- When you reject held messages, say whether the sender should be notified; the agent notifies the sender only if you ask
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.