MimecastV2

Use the Mimecast integration to manage email security, continuity, and archiving services.

Rate Limiting

https://developer.services.mimecast.com/api-overview#rate-limiting
Mimecast uses quotas per period of time (i.e. rate limits) that apply to every API function, per registered App. A typical quota is a number of API calls per unit of time (but could also be expressed as the size of data returned, etc.). When the quota has been exhausted, further requests will fail until the new time period restarts the count of API calls. The rate limit reset value is the length of time in milliseconds before a minimum of 1 API will be permitted.

Configure Mimecast v2 in Cortex

Note: The fields User Email Address (Use for auto token refresh) and Password are not mandatory fields. You will only need them if you have expiry set on the auth of the user account you use to create the API keys. They will be used to auto refresh the API key once it expires.

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you
successfully execute a command, a DBot message appears in the War Room with the command details.

mimecast-query

Query Mimecast emails. This is an archive search command.

Prerequisite

In order to successfully use this endpoint to search across a customer’s entire archive, the role assigned to the app must have at least the following level of application permissions granted: Archive | Search | Read.
To use this endpoint to search for messages for the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required.

Required Permissions

Base Command

mimecast-query

Input

Context Output

mimecast-list-blocked-sender-policies

Deprecate - use mimecast-list-policies instead

Base Command

mimecast-list-blocked-sender-policies

Input

| Argument Name | Description | Required |
|——————-|—————–|————–|

Context Output

mimecast-get-policy

Get a policy by ID.

Base Command

mimecast-get-policy

Input

Context Output

Command example

!mimecast-get-policy policyType="address-alteration" policyID=eNoVjr0OgjAYAN-lKw5QoAqJQ5H4AwZQUBM2hKJV5IutFcX47uJ8yd19kGSlEoxXyEXqLNMl8frQfnVci4Mrk8XFwunCq09G3h5MvVknETV4crYK_6htaTaZZw7gFXO4jTecxHcVBTYmmh4WqnprPQ1Fv4jpdkxMv4Z83wDsu3QGUzRCpZIPuDFRQsWG-myXUkPHFJtkgE8mJIcWucYI1dBUTPwXiWUN9u8P87s5UQ

Context Example

{
    "Mimecast": {
        "AddressAlterationPolicy": {
            "Bidirectional": null,
            "FromDate": null,
            "ID": "eNoVzs2OgjAUQOF3uVtY0IKdkcRFxfiHgwqIhh3S4tRU70wrGjS--zD7k5zvBVbWrZFKQAiHMrrbtMvPQUy_dLSaJx0lC5rNxs2JlNe97-nVJuFEbb6DanJ0Up5_TvMh0oUcqgHdKrb-bZPlgDLHi6tWdM6Tx-Y5W_P0g_mTBstCIxaPLMIRuKBF9QNhU2krXahbe8OLNDUK2VOiXcaJRzn1WV_epbEKrxASFxrUQpp_LwuCfvX-A6m-PQc",
            "Reciever": {
                "Address": null,
                "Domain": null,
                "Group": null,
                "Type": null
            },
            "Sender": {
                "Address": null,
                "Domain": null,
                "Group": null,
                "Type": null
            },
            "ToDate": null
        },
        "Policy": {
            "Bidirectional": null,
            "FromDate": null,
            "ID": "eNoVzs2OgjAUQOF3uVtY0IKdkcRFxfiHgwqIhh3S4tRU70wrGjS--zD7k5zvBVbWrZFKQAiHMrrbtMvPQUy_dLSaJx0lC5rNxs2JlNe97-nVJuFEbb6DanJ0Up5_TvMh0oUcqgHdKrb-bZPlgDLHi6tWdM6Tx-Y5W_P0g_mTBstCIxaPLMIRuKBF9QNhU2krXahbe8OLNDUK2VOiXcaJRzn1WV_epbEKrxASFxrUQpp_LwuCfvX-A6m-PQc",
            "Reciever": {
                "Address": null,
                "Domain": null,
                "Group": null,
                "Type": null
            },
            "Sender": {
                "Address": null,
                "Domain": null,
                "Group": null,
                "Type": null
            },
            "ToDate": null
        }
    }
}

Human Readable Output

Mimecast Get address-alteration Policy

Policy ID	Sender	Reciever	Bidirectional	Start	End
eNoVzs2OgjAUQOF3uVtY0IKdkcRFxfiHgwqIhh3S4tRU70wrGjS–zD7k5zvBVbWrZFKQAiHMrrbtMvPQUy_dLSaJx0lC5rNxs2JlNe97-nVJuFEbb6DanJ0Up5_TvMh0oUcqgHdKrb-bZPlgDLHi6tWdM6Tx-Y5W_P0g_mTBstCIxaPLMIRuKBF9QNhU2krXahbe8OLNDUK2VOiXcaJRzn1WV_epbEKrxASFxrUQpp_LwuCfvX-A6m-PQc	Group: null Email Address: null Domain: null Type: null	Group: null Email Address: null Domain: null Type: null

mimecast-create-policy

Deprecated. Please use mimecast-create-block-sender-policy

Base Command

mimecast-create-policy

Input

Context Output

mimecast-delete-policy

Deletes a policy by ID.

Base Command

mimecast-delete-policy

Input

Context Output

mimecast-manage-sender

Permit or block a specific sender

Required Permissions

Base Command

mimecast-manage-sender

Input

Context Output

mimecast-list-managed-url

Get a list of all managed URLs

Required Permissions

Base Command

mimecast-list-managed-url

Input

Context Output

mimecast-create-managed-url

Create a managed URL on Mimecast

Required Permissions

Base Command

mimecast-create-managed-url

Input

Context Output

mimecast-list-messages

Get a list of messages for a given user. This is an archive search command. Required Permissions The following permissions
are required for this command.

• Mimecast administrator with at least one of the following permissions: Archive/Search/Read.
• or Mimecast user with delegate permissions to address or user.

Required Permissions

Base Command

mimecast-list-messages

Input

Context Output

mimecast-get-attachment-logs

Returns Attachment Protect logs for a Mimecast customer account

Required Permissions

Base Command

mimecast-get-attachment-logs

Input

Context Output

mimecast-get-url-logs

Returns URL protect logs for a Mimecast customer account. Default value of scanResult as malicious

Required Permissions

Base Command

mimecast-get-url-logs

Input

Context Output

mimecast-get-impersonation-logs

Returns Impersonation Protect logs for a Mimecast customer account

Required Permissions

Base Command

mimecast-get-impersonation-logs

Input

Context Output

mimecast-url-decode

Decodes a given url from mimecast

Required Permissions

Base Command

mimecast-url-decode

Input

Context Output

mimecast-discover

discover authentication types that are supported for your account and which base URL to use for the requesting user.
only for API 1.0 users.

Base Command

mimecast-discover

Input

There are no input arguments for this command.

Context Output

mimecast-refresh-token

Refresh access key validity
only for API 1.0 users

Base Command

mimecast-refresh-token

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

mimecast-login

Login to generate Access Key and Secret Key
only for API 1.0 users

Base Command

mimecast-login

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

mimecast-get-message

Get the contents or metadata of a given message. This is an archive search command.

Required Permissions

The following permissions are required for this command.

• Mimecast administrator with at least one of the following permissions: Archive

  Search Content View.

• or Mimecast user with delegate permissions to address or user.

Base Command

mimecast-get-message

Input

Context Output

mimecast-download-attachments

Download attachments from a specified message. This is an archive search command.

Required Permissions

The following permissions are required for this command.

• Mimecast administrator with at least one of the following permissions: Archive

  Search Content View

  Read.

• or Mimecast user with delegate permissions to address or user.

Base Command

mimecast-download-attachments

Input

Context Output

mimecast-find-groups

Returns the list of groups according to the specified query.

Required Permissions

Base Command

mimecast-find-groups

Input

Context Output

mimecast-get-group-members

Returns the members list for the specified group.

Required Permissions

Base Command

mimecast-get-group-members

Input

Context Output

mimecast-add-group-member

Adds a user to a group. The email_address and domain_address arguments are optional, but one of them must be supplied.

Required Permissions

Base Command

mimecast-add-group-member

Input

Context Output

mimecast-remove-group-member

Removes a user from a group. The email_address and domain_address arguments are optional, but one of them must be
supplied.

Required Permissions

Base Command

mimecast-remove-group-member

Input

Context Output

mimecast-create-group

Creates a new Mimecast group.

Required Permissions

Base Command

mimecast-create-group

Input

Context Output

mimecast-update-group

Updates an existing Mimecast group.

Required Permissions

Base Command

mimecast-update-group

Input

Context Output

mimecast-create-remediation-incident

Creates a new Mimecast remediation incident.

Required Permissions

Base Command

mimecast-create-remediation-incident

Input

Context Output

mimecast-get-remediation-incident

Returns a Mimecast remediation incident.

Required Permissions

Base Command

mimecast-get-remediation-incident

Input

Context Output

mimecast-search-file-hash

Searches for one or more file hashes in the account. Maximum is 100.

Required Permissions

Base Command

mimecast-search-file-hash

Input

Context Output

mimecast-update-policy

Updates the specified policy.

Base Command

mimecast-update-policy

Input

Context Output

mimecast-search-message

Searches a message

Required Permissions

Base Command

mimecast-search-message

Input

Context Output

mimecast-get-message-info

Retrieves detailed information about a specific message.

Required Permissions

Base Command

mimecast-get-message-info

Input

Context Output

mimecast-list-held-message

Get information about held messages, including the reason, hold level, sender and recipients

Required Permissions

Base Command

mimecast-list-held-message

Input

Context Output

mimecast-held-message-summary

Get counts of currently held messages for each hold reason.

Required Permissions

Base Command

mimecast-held-message-summary

Input

| Argument Name | Description | Required |
|——————-|—————–|————–|

Context Output

mimecast-reject-held-message

Reject a currently held message.

Required Permissions

Base Command

mimecast-reject-held-message

Input

Context Output

There is no context output for this command.

Command example

!mimecast-reject-emessage ids="1234" message="MESSAGE CONTAINS UNDESIRABLE CONTENT" reason_type="MESSAGE CONTAINS UNDESIRABLE CONTENT" notify="True"

Human Readable Output

Held messages were rejected successfully

mimecast-release-held-message

Release a currently held message.

Required Permissions

Base Command

mimecast-release-held-message

Input

Context Output

There is no context output for this command.

Command example

!mimecast-release-held-message id="1234-test""

Human Readable Output

Held message with id 1234_test was released successfully

mimecast-search-processing-message

Return messages currently being processed by Mimecast. Note that most of the time, no results are returned.

Required Permissions

Base Command

mimecast-search-processing-message

Input

Context Output

mimecast-list-email-queues

Get the count of the inbound and outbound email queues at specified times.

Required Permissions

Base Command

mimecast-list-email-queues

Input

Context Output

Command example

!mimecast-list-email-queues from_date="2015-11-16T14:49:18+0000" to_date="2022-11-16T14:49:18+0000"

Context Example

{
  "Mimecast": {
    "EmailQueue": [
      {
        "inboundEmailQueue": [
          {
            "count": 2,
            "date": "2022-07-19T08:10:00+0000"
          },
          {
            "count": 4,
            "date": "2022-07-19T08:20:00+0000"
          },
          {
            "count": 4,
            "date": "2022-07-19T08:30:00+0000"
          },
          {
            "count": 4,
            "date": "2022-07-19T08:40:00+0000"
          }
        ]
      }
    ]
  }
}

Human Readable Output

Inbound Email Queue

Inbound Email Queue Count	Inbound Email Queue Date
2	2022-07-19T08:10:00+0000
4	2022-07-19T08:20:00+0000
4	2022-07-19T08:30:00+0000
4	2022-07-19T08:40:00+0000

mimecast-get-archive-search-logs

Retrieves archived search logs.

Required Permissions

Base Command

mimecast-get-archive-search-logs

Input

Context Output

Command example

!mimecast-get-archive-search-logs query="Message Tracking Search" limit=1

Context Example

{
    "Mimecast": {
        "ArchiveSearchLog": [
            {
                "createTime": "2024-03-20T11:39:36+0000",
                "description": "Message Tracking Search",
                "emailAddr": "integration.com",
                "searchReason": "",
                "searchText": "eNo1jrs12345",
                "source": "archive"
            }
        ]
    }
}

Human Readable Output

Results

createTime	description	emailAddr	searchReason	searchText	source
2024-03-20T11:39:36+0000	Message Tracking Search	example@test.com		eNo1jrs12345	archive

mimecast-get-search-logs

Retrieves the search logs.

Required Permissions

Base Command

mimecast-get-search-logs

Input

Context Output

Command example

!mimecast-get-search-logs start="1 year" limit=1 end=now query="Message Tracking Search"

Context Example

{
    "Mimecast": {
        "SearchLog": {
            "createTime": "2024-03-20T11:39:36+0000",
            "description": "Message Tracking Search",
            "emailAddr": "integration.com",
            "searchReason": "",
            "searchText": "eNo1jrs12345",
            "source": "archive"
        }
    }
}

Human Readable Output

Results

createTime	description	emailAddr	searchReason	searchText	source
2024-03-20T11:39:36+0000	Message Tracking Search	mime.integration.com		eNo1jrs12345	archive

mimecast-get-view-logs

Retrieves the email view logs.

Required Permissions

Base Command

mimecast-get-view-logs

Input

Context Output

Command example

!mimecast-get-view-logs limit=1 start="1 year" end=now

Context Example

{
    "Mimecast": {
        "ViewLog": [
            {
                "contentViewed": false,
                "discoveryCase": false,
                "from": "example@test.com",
                "messageDate": "2023-08-03T10:59:31+0000",
                "source": "Message Tracking",
                "subject": "Re",
                "to": ".integration.com",
                "viewed": "2023-08-03T12:06:01+0000",
                "viewer": "example@test.com"
            }
        ]
    }
}

Human Readable Output

Results

contentViewed	discoveryCase	from	messageDate	source	subject	to	viewed	viewer
false	false	example@test.com	2023-08-03T10:59:31+0000	Message Tracking	Re	example@test.com.mime.integration.com	2023-08-03T12:06:01+0000	example@test.com

mimecast-list-account

This endpoint returns the summary details for an account in Mimecast.

Required Permissions

Base Command

mimecast-list-account

Input

Context Output

Command example

!mimecast-list-account limit=1

Context Example

{
    "Mimecast": {
        "Account": [
            {
                "accountCode": "CUSA102A236",
                "accountName": "API Alliance - Palo Alto Networks",
                "adminEmail": "",
                "adminSessionTimeout": 60,
                "archive": false,
                "automatedSegmentPurge": true,
                "contactEmail": "example@test.com.com",
                "contactName": "Adam Testov",
                "contentAdministratorDefaultView": "Metadata",
                "cybergraphV2Enabled": false,
                "databaseCode": "usterm13",
                "domain": "",
                "exgestAllowExtraction": true,
                "exgestAllowQuery": false,
                "exportApi": false,
                "expressAccount": false,
                "gateway": true,
                "maxRetention": 30,
                "maxRetentionConfirmed": true,
                "mimecastId": "01-0102-00236",
                "minRetentionEnabled": false,
                "packages": [
                    "Attachment Management (Site) [1004]",
                    "Attachment Protection (Site) [1056]",
                    "Threat Remediation [1075]",
                    "Journal Services [1053]",
                    "Mimecast Platform [1033]",
                    "Internal Email Protect [1064]",
                    "Desktop Apps - Outlook (Pro) [1016]",
                    "Desktop Apps - Mac (Pro) [1051]",
                    "BYO: Threat Intelligence [1089]",
                    "Enhanced Logging [1061]",
                    "Message Recovery Service - User [1058]",
                    "Branding [1003]",
                    "Mobile Apps (Pro) [1036]",
                    "Content Control and Data Leak Prevention (Site) [1013]",
                    "Advanced MTA (Site) [1002]",
                    "Email Encryption and Privacy (Site) [1023]",
                    "Metadata Track and Trace (Site) [1032]",
                    "Configuration Backup & Restore [1106]",
                    "Attachment Protection (Pro) [1059]",
                    "Stationery 1.0 (Site) [1042]",
                    "URL Protection (Site) [1043]",
                    "Secure Email Gateway (Site) [1039]",
                    "Content Control and Data Leak Prevention (Pro) [1015]",
                    "Impersonation Protection [1060]",
                    "Auto Responders (Site) [1005]",
                    "Message Recovery Service (Site) [1031]",
                    "Mimecast Mobile Pro (Pro) [1055]",
                    "Analysis and Response [1110]"
                ],
                "passphrase": "",
                "policyInheritance": false,
                "region": "us",
                "searchReason": false,
                "supportCode": "D7F8",
                "telephone": "4088307584",
                "type": "full",
                "userCount": 10
            }
        ]
    }
}

Human Readable Output

Results

accountCode	accountName	adminEmail	adminSessionTimeout	archive	automatedSegmentPurge	contactEmail	contactName	contentAdministratorDefaultView	cybergraphV2Enabled	databaseCode	domain	exgestAllowExtraction	exgestAllowQuery	exportApi	expressAccount	gateway	maxRetention	maxRetentionConfirmed	mimecastId	minRetentionEnabled	packages	passphrase	policyInheritance	region	searchReason	supportCode	telephone	type	userCount
CUSA102A236	API Alliance - Palo Alto Networks		60	false	true	example@test.com.com	Adam Testov	Metadata	false	usterm13		true	false	false	false	true	30	true	01-0102-00236	false	Attachment Management (Site) [1004], Attachment Protection (Site) [1056], Threat Remediation [1075], Journal Services [1053], Mimecast Platform [1033], Internal Email Protect [1064], Desktop Apps - Outlook (Pro) [1016], Desktop Apps - Mac (Pro) [1051], BYO: Threat Intelligence [1089], Enhanced Logging [1061], Message Recovery Service - User [1058], Branding [1003], Mobile Apps (Pro) [1036], Content Control and Data Leak Prevention (Site) [1013], Advanced MTA (Site) [1002], Email Encryption and Privacy (Site) [1023], Metadata Track and Trace (Site) [1032], Configuration Backup & Restore [1106], Attachment Protection (Pro) [1059], Stationery 1.0 (Site) [1042], URL Protection (Site) [1043], Secure Email Gateway (Site) [1039], Content Control and Data Leak Prevention (Pro) [1015], Impersonation Protection [1060], Auto Responders (Site) [1005], Message Recovery Service (Site) [1031], Mimecast Mobile Pro (Pro) [1055], Analysis and Response [1110]		false	us	false	D7F8	4088307584	full	10

mimecast-list-policies

List all existing Mimecast blocked sender policies.

Base Command

mimecast-list-policies

Input

Context Output

Command example

!mimecast-list-policies policyType="address-alteration" limit=1

Context Example

{
    "Mimecast": {
        "AddressAlterationPolicy": {
            "addressAlterationSetId": "eNoVjr0OgjAYAN-lKw5QoAqJQ5H4AwZQUBM2hKJV5IutFcX47uJ8yd19kGSlEoxXyEXqLNMl8frQfnVci4Mrk8XFwunCq09G3h5MvVknETV4crYK_6htaTaZZw7gFXO4jTecxHcVBTYmmh4WqnprPQ1Fv4jpdkxMv4Z83wDsu3QGUzRCpZIPuDFRQsWG-myXUkPHFJtkgE8mJIcWucYI1dBUTPwXiWUN9u8P87s5UQ",
            "id": "eNo1jk0TgUAAQP_Lns3Y2l1hxsEo5CPCCuOSbWWptrbSxPjvcnB_b957g5yzUnERgD6gzsyI2crn1ITntnMIXTuLUOx6zCZ3o6IFWiti5gyuqbn3LPsiQzpPfNzVtUjFtxPyjyHfZXJKvEK4flr1Jii542WG8XWDSmf_EAfrFWzGC7UcgBZIZSRY_UtrGBPSAqzMCxlzxWTAm58R3Q41qA911GnoJ1e5kEkD_81dnXL7Z0Mdws8XmjlBYQ",
            "policy": {
                "bidirectional": true,
                "conditions": {
                    "sourceIPs": [
                        "8.8.8.8/24"
                    ]
                },
                "createTime": "2024-05-28T10:01:06+0000",
                "description": "test_update",
                "enabled": true,
                "enforced": false,
                "from": {
                    "emailDomain": "google.com",
                    "type": "email_domain"
                },
                "fromDate": "1900-01-01T00:00:00+0000",
                "fromEternal": true,
                "fromPart": "header_from",
                "fromType": "email_domain",
                "fromValue": "google.com",
                "lastUpdated": "2024-05-28T10:01:07+0000",
                "override": true,
                "to": {
                    "emailDomain": "google.com",
                    "type": "email_domain"
                },
                "toDate": "2100-01-01T23:59:59+0000",
                "toEternal": true,
                "toType": "email_domain",
                "toValue": "google.com"
            }
        }
    }
}

Human Readable Output

Mimecast list address-alteration policies

These are the existing address-alteration Policies:

Policy ID	Sender	Reciever	Bidirectional	Start	End
eNo1jk0TgUAAQP_Lns3Y2l1hxsEo5CPCCuOSbWWptrbSxPjvcnB_b957g5yzUnERgD6gzsyI2crn1ITntnMIXTuLUOx6zCZ3o6IFWiti5gyuqbn3LPsiQzpPfNzVtUjFtxPyjyHfZXJKvEK4flr1Jii542WG8XWDSmf_EAfrFWzGC7UcgBZIZSRY_UtrGBPSAqzMCxlzxWTAm58R3Q41qA911GnoJ1e5kEkD_81dnXL7Z0Mdws8XmjlBYQ	Group: null Email Address: null Domain: google.com Type: email_domain	Group: null Email Address: null Domain: google.com Type: email_domain	true	1900-01-01T00:00:00+0000	2100-01-01T23:59:59+0000

mimecast-create-block-sender-policy

Creates a blocked sender policy. This command does not set context outputs, use mimecast-get-policy to retrieve the full policy.

Prerequisite

Required Permissions

Base Command

mimecast-create-block-sender-policy

Input

Context Output

mimecast-update-block-sender-policy

Updates an existing blocked senders policy. Only the fields you explicitly provide are sent to the API and updated, while fields you omit are left unchanged on the server. This command does not set context outputs, use mimecast-get-policy to retrieve the updated policy.

Required Permissions

Base Command

mimecast-update-block-sender-policy

Input

Context Output

There is no context output for this command.

mimecast-create-antispoofing-bypass-policy

Create a new Anti-Spoofing SPF based Bypass policy.

Required Permissions

Base Command

mimecast-create-antispoofing-bypass-policy

Input

Context Output

Command example

!mimecast-create-antispoofing-bypass-policy description=test from_type=email_domain from_value=mail.google.com option=disable_bypass to_type=everyone spf_domain=google.com bidirectional=no comment=test

Context Example

{
    "Mimecast": {
        "AntispoofingBypassPolicy": {
            "id": "eNo1jjEOgjAAAP_1234",
            "option": "disable_bypass",
            "policy": {
                "bidirectional": false,
                "conditions": {
                    "spfDomains": [
                        "google.com"
                    ]
                },
                "createTime": "2024-05-29T11:07:20+0000",
                "description": "test",
                "enabled": true,
                "enforced": false,
                "from": {
                    "emailDomain": "mail.google.com",
                    "type": "email_domain"
                },
                "fromDate": "1900-01-01T00:00:00+0000",
                "fromEternal": true,
                "fromPart": "envelope_from",
                "fromType": "email_domain",
                "fromValue": "mail.google.com",
                "lastUpdated": "2024-05-29T11:07:20+0000",
                "override": false,
                "to": {
                    "type": "everyone"
                },
                "toDate": "2100-01-01T23:59:59+0000",
                "toEternal": true,
                "toType": "everyone"
            }
        }
    }
}

Human Readable Output

Anti-Spoofing Bypass policy eNo1jjEOgjAAAP_SVYa12345 was created successfully

mimecast-update-antispoofing-bypass-policy

Update an existing Anti-Spoofing SPF based Bypass policy.

Required Permissions

Base Command

mimecast-update-antispoofing-bypass-policy

Input

Context Output

Command example

!mimecast-update-antispoofing-bypass-policy option=disable_bypass policy_id=eNo1jrs12345 bidirectional=no description=test enabled=no from_date="3 year" from_eternal=no from_part=both to_date=now to_eternal=no

Context Example

{
    "Mimecast": {
        "AntispoofingBypassPolicy": {
            "id": "eNo1jrs12345",
            "option": "disable_bypass",
            "policy": {
                "bidirectional": false,
                "conditions": {
                    "spfDomains": [
                        "amazon.com"
                    ]
                },
                "createTime": "2024-05-20T09:11:54+0000",
                "description": "test",
                "enabled": false,
                "enforced": false,
                "from": {
                    "type": "everyone"
                },
                "fromDate": "2021-05-29T11:07:29+0000",
                "fromPart": "both",
                "fromType": "everyone",
                "lastUpdated": "2024-05-29T11:07:29+0000",
                "override": false,
                "to": {
                    "type": "everyone"
                },
                "toDate": "2024-05-29T11:07:29+0000",
                "toType": "everyone"
            }
        }
    }
}

Human Readable Output

Policy ID- eNo1jrs12345 has been updated successfully.

mimecast-create-address-alteration-policy

This API endpoint can be used to create a new Address Alteration policy to apply an alteration definition based on sender and recipient values.

Required Permissions

Base Command

mimecast-create-address-alteration-policy

Input

Context Output

Command example

!mimecast-create-address-alteration-policy folder_id=eNo1jrs12345 from_type=everyone to_type=everyone policy_description=test

Context Example

{
    "Mimecast": {
        "AddressAlterationPolicy": {
            "addressAlterationSetId": "eNo1jrs12345",
            "id": "1234",
            "policy": {
                "bidirectional": false,
                "conditions": {},
                "createTime": "2024-05-29T11:07:23+0000",
                "description": "test",
                "enabled": true,
                "enforced": false,
                "from": {
                    "type": "everyone"
                },
                "fromDate": "1900-01-01T00:00:00+0000",
                "fromEternal": true,
                "fromPart": "envelope_from",
                "fromType": "everyone",
                "lastUpdated": "2024-05-29T11:07:23+0000",
                "override": false,
                "to": {
                    "type": "everyone"
                },
                "toDate": "2100-01-01T23:59:59+0000",
                "toEternal": true,
                "toType": "everyone"
            }
        }
    }
}

Human Readable Output

Address Alteration policy was created successfully

mimecast-update-address-alteration-policy

Update an existing Address Alteration policy.

Required Permissions

Base Command

mimecast-update-address-alteration-policy

Input

Context Output

Command example

!mimecast-update-address-alteration-policy policy_id=eNo1jrs12345 bidirectional=no comment=test conditions=8.8.8.8/24 enabled=no enforced=no from_date="3 year" from_eternal=no from_part=both override=no policy_description=test to_date=now to_eternal=no

Context Example

{
    "Mimecast": {
        "AddressAlterationPolicy": {
            "id": "eNo1jrs12345",
            "policy": {
                "bidirectional": false,
                "conditions": {
                    "sourceIPs": [
                        "8.8.8.8/24"
                    ]
                },
                "createTime": "2024-05-26T06:38:11+0000",
                "description": "test",
                "enabled": false,
                "enforced": false,
                "from": {
                    "type": "everyone"
                },
                "fromDate": "2021-05-29T11:07:32+0000",
                "fromPart": "both",
                "fromType": "everyone",
                "lastUpdated": "2024-05-29T11:07:32+0000",
                "override": false,
                "to": {
                    "type": "everyone"
                },
                "toDate": "2024-05-29T11:07:32+0000",
                "toType": "everyone"
            }
        }
    }
}

Human Readable Output

eNo1jrs12345 has been updated successfully