MimecastFindEmail
Find an email across all mailboxes, and return the list of mailboxes where the email was found, as well as Yes if the mail was found anywhere or No otherwise.
python · Mimecast
Details
| ID | MimecastFindEmail |
|---|---|
| Language | python |
| From Version | 5.0.0 |
| Docker Image | demisto/python3:3.12.13.10116658 |
| Tags | Mimecast |
README
Searches all mailboxes to find an email, and returns the list of mailboxes where the email was found. “Yes” will be displayed if the mail was found anywhere or “No” if not.
Script Data
| Name | Description |
|---|---|
| Script Type | python |
| Tags | Mimecast |
Dependencies
This script uses the following commands and scripts.
- mimecast-query
Inputs
| Argument Name | Description |
|---|---|
| queryXml | The query string XML for the search, using Mimecast Unified Search Experience (MUSE). For more on information click here. Using this will override other query arguments. |
| text | The search for this text in API messages. |
| dryRun | Will not execute the query, but will just return the query string that was built. |
| date | Searches the specific dates only. |
| dateFrom | Searches emails from a specific date. In format 2015-09-21T23:00:00Z. |
| dateTo | Searches emails up until a specific date. In format 2015-09-21T23:00:00Z. |
| sentTo | The filter on the messages to a specific address. |
| sentFrom | The filter on the messages from a specific address. |
| subject | Searches emails by subject. This will override the text argument. |
| attachmentType | The messages with and without attachments. Any messages with any attachment documents can contain, “doc”, “dot”, “docx”, “docm”, “dotx”, “dotm”, “pdf”, “rtf”, “html” attachments. Spreadsheets can contain, “xls”, “xlt”, “xlsx”, “xlsm”, “xltx”, “xltm”, “xlsb”, “xlam”, “csv”. Presentations can contain, “ppt”, “pptx”, “pptm”, “potx”, “potm”, “ppam”, “ppsx”, “ppsm”, “sldx”, “sldm”, “thms”, “pps”. Text messages can contain, “txt”, “text”, “html”, “log”. Images messages can contain, “jpg”, “jpeg”, “png”, “bmp”, “gif”, “psd”, “tif”, “tiff”. Media messages can contain, “mp3”, “mp4”, “m4a”, “mpg”, “mpeg”, “avi”, “wav”, “aac”, “wma”, “mov”. Zip messages can contain, “zip”, “rar”, “cab”, “gz”, “gzip”, “7z”. None messages will have no attachments and will not be present in the results. |
| attachmentText | Searches for text in the attachments. |
| body | Searches emails by text in the body. This will override the text and subject arguments. |
| pageSize | Sets the number of results to return per page. The default is 25. |
| startRow | Sets the result to start returning results. The default is 0. |
| active | Defines if the search should query recently received messages that are not fully indexed yet. The default is false. Search can be done by mailbox and date time across active messages. |
Outputs
There are no outputs for this script.
commonfields: id: MimecastFindEmail version: -1 name: MimecastFindEmail script: '' type: python subtype: python3 tags: - Mimecast comment: Find an email across all mailboxes, and return the list of mailboxes where the email was found, as well as Yes if the mail was found anywhere or No otherwise. system: true args: - name: queryXml default: true description: The query string xml for the search using Mimecast Unified Search Experience (MUSE) - read more on https://community.mimecast.com/docs/DOC-2262, using this will override other query arguments. - name: text description: search for this text in api messages. - name: dryRun auto: PREDEFINED predefined: - "true" - "false" description: Will no execute the query, but just return the query string builded. - name: date auto: PREDEFINED predefined: - today - yesterday - last_week - last_month - last_year description: Search in specific dates only. - name: dateFrom description: search emails from date, format 2015-09-21T23:00:00Z. - name: dateTo description: search emails to date, format 2015-09-21T23:00:00Z. - name: sentTo description: filter on messages to a specific address. - name: sentFrom description: filter on messages from a specific address. - name: subject description: search email by subject, will override the text argument. - name: attachmentType auto: PREDEFINED predefined: - optional - any - documents - spreadsheets - presentations - text - images - media - zips - none description: optional - messages with and without attachments any - messages with any attachment documents - messages with doc, dot, docx, docm, dotx, dotm, pdf, rtf, html attachments spreadsheets - messages with xls, xlt, xlsx, xlsm, xltx, xltm, xlsb, xlam, csv attachments presentations - messages with ppt, pptx, pptm, potx, potm, ppam, ppsx, ppsm, sldx, sldm, thms, pps attachments text - messages with txt, text, html, log attachments images - messages with jpg, jpeg, png, bmp, gif, psd, tif, tiff attachments media - messages with mp3, mp4, m4a, mpg, mpeg, avi, wav, aac, wma, mov attachments zips - messages with zip, rar, cab, gz, gzip, 7z attachments none - No attachments are to be present in the results. - name: attachmentText description: search for text in attachments. - name: body description: search email by text in body, will override the text and subject arguments. - name: pageSize description: Sets the number of results to return per page (default 25). - name: startRow description: Sets the result to start returning results (default 0). - name: active auto: PREDEFINED predefined: - "true" - "false" description: Defines if the search should query recently received messages that are not fully indexed yet (default false). You can search by mailbox and date time across active messages. scripttarget: 0 dependson: must: - mimecast-query timeout: 0s fromversion: 5.0.0 dockerimage: demisto/python3:3.12.13.10116658 tests: - No tests (auto formatted)