Exchange
This document provides guidance on how to integrate Exchange with Google Security Operations SOAR.
Integration version: 102.0
This integration uses one or more open source components. You can download a zipped copy of the full source code of this integration from the Cloud Storage bucket .
Configure Exchange Online
The prerequisites and configuration steps differ depending on whether you configure the integration for the Exchange Online or Exchange Server.
-
To configure Exchange Online, proceed to the following section.
-
To configure Exchange Server, see Configure Exchange Server .
The integration for Exchange Online only supports OAuth delegated authentication with delegated tokens which requires additional configuration.
Changes made to permissions in the Azure environment can take up to 24 hours to take effect.
Before integrating Exchange Online with Google SecOps, complete the following steps:
- Set up OAuth delegated authentication .
- Create Microsoft Entra application .
- Configure API permissions for the application .
- Create a client secret .
Set up OAuth delegated authentication
-
Verify that Exchange Online is accessible from the Google SecOps server and meets the following requirements:
-
Exchange Online DNS name is resolving.
-
The integration uses the Exchange Web Services (EWS) hosted on port 443. Make sure that EWS is enabled and hosted on a port accessible to the Google SecOps server.
If Exchange Online is not accessible from the Google SecOps server, consider using a Google SecOps remote agent.
-
-
Provide the integration with a valid username (user email account). Choose a user to use in the integration. To impersonate the user, create a Microsoft Entra application .
-
Assign a Microsoft 365 license to the user (mailbox), such as the Microsoft 365 E5 license.
-
For actions that use delegated or impersonated permissions, complete the following steps:
-
To allow the integration to access multiple Exchange Online mailboxes, use the role based access control for applications in Exchange Online .
-
To access other mailboxes, assign the following Exchange roles to the user (mailbox) configured for the integration:
-
Discovery Management
role group in the Microsoft product documentation. -
ApplicationImpersonation
role in the Microsoft product documentation.
-
Compliance Management
role in the Microsoft product documentation. -
Organization Management
role in the Microsoft product documentation.
-
Create Microsoft Entra application
To create an application and impersonate the chosen user, follow these steps:
-
Sign in to the Azure portal as a user administrator or a password administrator.
-
Select Microsoft Entra ID.
-
Go to App registrations > New registration.
-
Enter the name of the app.
-
Select suitable Supported account types.
-
For the Redirect URIprovide the following values:
-
Platform: Web
-
Redirect URL:
http://localhost
-
-
Click Register.
-
Save the Application (client) IDand Directory (tenant) IDvalues for later use when you configure the integration.
Configure API permissions
To configure the API permissions for your application, follow these steps:
-
Go to API permissions > Add a permission.
-
Select Microsoft Graph > Delegated permissions.
-
In the Select permissionssections, select EWS.
-
Select the
Ews.AccessAsUser.All
permission. -
Click Add permissions.
-
Click Grant admin consent for
YOUR_ORGANIZATION_NAME
.When the Grant admin consent confirmationdialog appears, click Yes.
Create a client secret
-
Navigate to Certificates and secrets > New client secret.
-
Provide a description for a client secret and set its expiration deadline.
-
Click Add.
-
Save the value of the client secret (not the secret ID) to use it as the
Client Secret
parameter value when you configure the integration . The client secret value is only displayed once.
Use the created Microsoft Entra application to generate a refresh token that is required for configuring the integration in the Google SecOps platform.
Assign the ApplicationImpersonation role
To assign the ApplicationImpersonation
role, complete the following steps:
- In Exchange , go to Roles > Admin Roles > Discovery Management > Permissions.
- On the Permissionspage, confirm that the
ApplicationImpersonation
role is selected. - Select the Assignedtab.
- In the Assignedtab, add the user that you configured for the Exchange integration.
- Click Save.
The settings can take up to 24 hours to take effect.
Integrate Exchange Online with Google SecOps
For instructions about how to install and configure the integration on Google SecOps, see Configure Integrations .
Integrating Exchange Online with the Google SecOps platform requires you to complete the following steps in Google SecOps:
-
Configure the initial parameters and save them.
-
Generate a refresh token:
-
Simulate a case in Google SecOps.
-
Run the Get Authorizationaction.
-
Run the Generate Tokenaction.
-
-
Input the obtained refresh token as the
Refresh Token
parameter value and save the configuration.
Configure initial parameters
The Exchange Online integration requires the following initial parameters:
Parameter | Description |
---|---|
Mail Server Address
|
Required
A mail server address (hostname or IP address) to connect to. |
Mail address
|
Required
A mail address to use in the integration to work with the sent and received emails in the mailbox. |
Client ID
|
Required
An application (client) ID of the Microsoft Entra application that is used for the integration. This is the Application (client) ID value that you saved when creating the Microsoft Entra application . |
Client Secret
|
Required
A client secret value of the Microsoft Entra application that is used for the integration. This is the client secret value that you saved when creating a client secret . |
Tenant (Directory) ID
|
Required
A directory (tenant) ID of the Microsoft Entra ID application that is used for the integration. This is the directory (tenant) ID value that you saved when creating the Microsoft Entra application . |
Redirect URL
|
Required
A redirect URI that is configured in the Microsoft Entra application. Keep the value default to |
After you have configured the parameters, click Save.
Generate a refresh token
Generating a refresh token requires you to run manual actions on an existing case. If your Google SecOps instance is new and has no existing cases, simulate one.
Simulate a case
To simulate a case in Google SecOps, follow these steps:
-
In the left navigation, select Cases.
-
On the Cases page, click add > Simulate Cases.
-
Select any of the default cases and click Create. It doesn't matter what case you choose to simulate.
-
Click Simulate.
If you have an environment other than default and would like to use it, select the correct environment and click Simulate.
-
In the Casestab, click Refresh. The case you have simulated appears in the case list.
Run the Get Authorization action
Use the Google SecOps case which you simulated to run the Get Authorization action manually.
-
In the Casestab, select your simulated case to open a Case View.
-
Click Manual Action.
-
In the Manual Action Searchfield, enter
Exchange
. -
In the results under the Exchange integration, select Get Authorization. This action returns an authorization link that is used to interactively sign in to the Microsoft Entra app.
-
Click Execute.
-
After the action is executed, navigate to the Case Wall of your simulated case. In the Exchange_Get Authorizationaction record, click View More. Copy the authorization link.
-
Open a new browser window in incognito mode and paste the generated authorization URL. The Azure sign-in page opens.
-
Sign in with the user credentials you selected for the integration. After signing in, your browser redirects you to an address with a code in the address bar.
It is expected for the browser to display an error as the app redirects you to
http://localhost
. -
Copy the whole URL with the access code from the address bar.
Run the Generate Token action
Use the Google SecOps case you've simulated to run the Generate Token action manually.
-
In the Casestab, select your simulated case to open a Case View.
-
Click Manual Action.
-
In the Manual Action Searchfield, enter
Exchange
. -
In the results under the Exchange integration, select Generate Token.
-
In the
Authorization URL
field, paste the whole URL with the access code copied after running the Get Authenticationaction. -
Click Execute.
-
After the action is executed, navigate to the Case Wall of your simulated case. In the Exchange_Generate Tokenaction record, click View More.
-
Copy the entire value of the generated refresh token.
Configure the Refresh Token parameter
-
Navigate to the configuration dialog for the Exchange integration.
-
Enter the refresh token value that you obtained when running the Generate Tokenaction into the Refresh Tokenfield.
-
Click Save.
-
Click Testto test if the configuration is correct and the integration works as expected.
You can make changes at a later stage if needed. Once configured, the instances can be used in playbooks. For detailed information on configuring and supporting multiple instances, see Supporting multiple instances .
Configure Exchange Server
Before integrating Exchange Server with Google SecOps, set up the basic authentication for Exchange Server.
To authenticate with the Exchange Server, use a username and a password.
Set up basic authentication
To set up the basic authentication, complete the following steps:
-
Verify that the Exchange Server (one of the servers in the cluster) is accessible from the Google SecOps server and meets the following requirements:
-
The Exchange Server DNS name is resolving.
-
The Exchange Server IP address is accessible.
-
Exchange Web Services (EWS) is enabled and hosted on a port accessible to the Google SecOps server.
If the Exchange Server is not accessible from the Google SecOps SOAR server, consider using a Google SecOps remote agent.
-
-
Provide the integration with a username (user email account) and a password. Choose the user for the integration.
-
For actions that use delegated or impersonated permissions, complete the following steps:
-
Grant a delegated or impersonated access to the required mailboxes to an email account that you use in the integration.
We recommend you to configure access with impersonated permissions. For more information, see Impersonation and EWS in Exchange in Microsoft product documentation.
-
To access other mailboxes, assign the following Exchange roles to the user (mailbox) configured for the integration:
-
Discovery Management
role group in Microsoft product documentation. -
ApplicationImpersonation
role in Microsoft product documentation. -
Compliance Management
role in Microsoft product documentation. -
Organization Management
role in Microsoft product documentation.
-
-
Integrate Exchange Server with Google SecOps
For instructions about how to install and configure the integration on Google SecOps, see Configure integrations .
Integration inputs
The Exchange Server integration requires the following parameters:
Parameter | Description |
---|---|
Mail Server Address
|
Required
A mail server address (hostname or IP address) to connect to. |
Mail address
|
Required
A mail address used in the integration to work with the sent and received emails in the mailbox. |
Username
|
Required
A username to authenticate with on the mail
server, such as |
Password
|
Required
A password to authenticate with on the mail server. |
Actions
The actions listed in this section fall under two categories:
-
The common Exchange integration actions.
-
Actions that are specific to the Exchange Block Sender and Domain functionality .
Required permissions
For the minimal permissions that are required to run common actions, refer to the following table:
Action | Required permissions |
---|---|
Delete Mail | |
Download Attachment | |
Search Mails | |
For the minimal permissions required to run actions from the Block Sender and Domain functionality , refer to the following table:
Action | Required permissions |
---|---|
Add Senders to Exchange-Siemplify Inbox Rule | EDiscovery Group
Author
|
Add Senders to Exchange-Siemplify Inbox Rule | EDiscovery Group
Author
|
Delete Exchange-Siemplify Inbox Rules | EDiscovery Group
Author
|
List Exchange-Siemplify Inbox Rules | EDiscovery Group
Author
|
Remove Domains from Exchange-Siemplify Inbox Rules | EDiscovery Group
Author
|
Remove Senders from Exchange-Siemplify Inbox Rules | EDiscovery Group
Author
|
Delete Mail
Use the Delete Mailaction to delete one or multiple emails that match the search criteria from a mailbox.
Deleting emails can apply to the first email that matches the search criteria or all matching emails.
For the permissions required to run this action, refer to the action permissions section of this document.
If the user is offline, the action may not delete the message from their Outlook client until the user reconnects and synchronizes their mailbox.
This action doesn't run on Google SecOps entities.
Action inputs
The Delete Mailaction requires the following parameters:
Parameter | Description |
---|---|
Folder Name
|
Optional
A mailbox folder to search an email in. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Message IDs
|
Optional
A filter condition to search for emails with specific email IDs. This parameter accepts a comma-separated list of message IDs to search for. If you provide the message ID, the action ignores the |
Subject Filter
|
Optional
A filter condition that specifies the email subject to search for. |
Sender Filter
|
Optional
A filter condition that specifies the sender of requested emails. |
Recipient Filter
|
Optional
A filter condition that specifies the recipient of requested emails. |
Delete All Matching Emails
|
Optional
If selected, the action deletes all emails that match the criteria. If not selected, the action deletes only the first matching email. Not selected by default. |
Delete from all mailboxes
|
Optional
If selected, the action deletes emails in all mailboxes that are accessible using the current impersonation settings. |
How many mailboxes to process in a single batch
|
Required
The number of mailboxes to process in a single batch (single connection to the mail server). If you selected the The default value is 25. |
Time Frame (minutes)
|
Optional
The period in minutes to search for emails. |
Action outputs
The Delete Mailaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Delete Mailaction can return the following output messages:
Output message | Message description |
---|---|
NUMBER_OF_EMAILS
email(s)
were deleted successfully.
|
Action succeeded. |
Error deleting emails.
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Delete Mailaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Download Attachments
Use the Download Attachmentsaction to download email attachments from an email to a specific path on the Google SecOps server. The action automatically replaces the backslash or space characters in the names of downloaded attachments with the underscore character.
This action doesn't run on Google SecOps entities.
Action inputs
The Download Attachmentsaction requires the following parameters:
Parameter | Description |
---|---|
Folder Name
|
Optional
A mailbox folder to search an email in. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Download Path
|
Required
A path on the Google SecOps server to download email attachments. |
Message IDs
|
Optional
A filter condition to search for emails with specific email IDs. This parameter accepts a comma-separated list of message IDs to search for. If you provide the message ID, the action ignores the |
Subject Filter
|
Optional
A filter condition that specifies the email subject to search for. |
Sender Filter
|
Optional
A filter condition that specifies the email sender to search for. |
Only Unread
|
Optional
If selected, the action downloads attachments only from unread emails. Not selected by default. |
Download Attachments from EML
|
Optional
If selected, the action downloads attachments from attached EML files. Not selected by default. |
Download Attachments to unique path?
|
Optional
If selected, the action downloads attachments to a unique path under the
value provided in the Not selected by default. |
Search in all mailboxes
|
Optional
If selected, the action runs a search in all mailboxes accessible using the current impersonation settings. Not selected by default. |
How many mailboxes to process in a single batch
|
Required
The number of mailboxes to process in a single batch (single connection to the mail server). If you selected the The default value is 25. |
Mailboxes
|
Optional
A comma-separated list of mailboxes to run a search through. This
parameter has a priority over the |
Action outputs
The Download Attachmentsaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Available |
Output messages | Available |
Script result | Available |
JSON result
The following example shows the JSON result output received when using the Download Attachmentsaction:
[
{
"attachment_name"
:
" ATTACHMENT_NAME
"
,
"downloaded_path"
:
" reado
nl
y
" translate="
n
o
">FULL_PATH"
},
{
"attachment_name"
:
" ATTACHMENT_NAME
"
,
"downloaded_path"
:
" reado
nl
y
" translate="
n
o
">FULL_PATH"
}
]
Output messages
The Download Attachmentsaction can return the following output messages:
Output message | Message description |
---|---|
Downloaded NUMBER_OF_ATTACHMENTS
attachments. Files: LIST_OF_LOCAL_PATHS_FOR_ATTACHMENTS
|
Action succeeded. |
Failed to download email attachments, the error is: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Download Attachmentsaction:
Script result name | Value |
---|---|
file_paths
|
A string of comma-separated full paths to the saved attachments. |
Extract EML Data
Use the Extract EML Dataaction to extract data from the email EML attachments.
This action runs on all Google SecOps entities.
Action inputs
The Extract EML Dataaction requires the following parameters:
Parameter | Description |
---|---|
Folder Name
|
Optional
Folder to fetch an email from. Default value is The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Message ID
|
Required
Message ID, such as |
Regex Map JSON
|
Optional
Regular expression to select emails based on matching the email body part,
for example, |
Action outputs
The Extract EML Dataaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Available |
Script result | Available |
JSON result
The following example shows the JSON result output received when using the Extract EML Dataaction:
[
{
"count"
:
3
,
"files"
:
{
"mxtoolbox_test_case.case"
:
"090a131a0726dea8f5b0c2205ffc9527"
},
"from"
:
"Exam <user1@example.com>"
,
"text"
:
"hello eml test"
,
"regex"
:
{
},
"to"
:
"Test Test <user2@example.com>"
,
"html"
:
"<html><div></div></html>"
,
"date"
:
"Wed, 12 Sep 2018 12:36:17 +0300"
,
"subject"
:
"eml test"
}
]
Script result
The following table lists the value for the script result output when using the Extract EML Dataaction:
Script result name | Value |
---|---|
eml_data
|
EML_DATA
|
Generate Token
Use the Generate Tokenaction to get a refresh token for the integration configuration with OAuth authentication. Use the authorization URL that you received in the Get Authorization action.
This action doesn't run on Google SecOps entities.
Action inputs
The Generate Tokenaction requires the following parameters:
Parameter | Description |
---|---|
Authorization URL
|
Required
Authorization URL received in the Get Authorization action to request a refresh token. |
Action outputs
The Generate Tokenaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Generate Tokenaction can return the following output messages:
Output message | Message description |
---|---|
Successfully fetched the refresh token: REFRESH_TOKEN_VALUE
. Copy this
refresh token to the Integration Configuration. Note: This Token is valid
for 90 days only.
|
Action succeeded. |
Failed to get the refresh token! The Error is ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Generate Tokenaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Get Account Out Of Facility Settings
Use the Get Account Out Of Facility Settingsaction to get the account out
of facility (OOF) settings for the provided Google SecOps User
entity.
If the target user entity is a username and not an email, run the Active Directory Enrich Entitiesaction to retrieve an information about the user email that is stored in Active Directory.
This action runs on the Google SecOps User
entity.
Action inputs
None.
Action outputs
The Get Account Out Of Facility Settingsaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Available |
Entity enrichment table | Available |
JSON result | Available |
Output messages | Available |
Script result | Available |
Case wall table
The Get Account Out Of Facility Settingsaction returns the following table on a Case Wall in Google SecOps:
Table name: Out of Facility Settings
Table columns:
- Parameter
- Value
Entity enrichment
The Get Account Out Of Facility Settingsaction supports the following entity enrichment:
Enrichment field | Source (JSON key) | Logic |
---|---|---|
Exchange.oof_settings
|
OofSettings
|
The action returns the disabled or enabled state based on the API response. |
JSON result
The following example shows the JSON result output received when using the Get Account Out Of Facility Settingsaction:
Oo
f
Se
tt
i
n
gs(s
tate
='Disabled'
,
ex
ternal
_audie
n
ce='All'
,
s
tart
=EWSDa
te
Time(
2020
,
10
,
1
,
3
,
0
,
t
zi
nf
o=<UTC>)
,
e
n
d=EWSDa
te
Time(
2020
,
10
,
2
,
3
,
0
,
t
zi
nf
o=<UTC>))
Output messages
The Get Account Out Of Facility Settingsaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Error executing action "Get Account Out Of Facility Settings".
Reason: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Get Authorization
Use the Get Authorizationaction to obtaining a link with the access code for the integration configuration with OAuth authentication. Copy the link and use it in the Generate Token action to get the refresh token.
This action doesn't run on Google SecOps entities.
Action inputs
None.
Action outputs
The Get Authorizationaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Case wall link
This Get Authorizationaction returns the following link:
Name: Browse to this authorization link
Link: AUTHORIZATION_LINK
Output messages
This Get Authorizationaction can return the following output messages:
Output message | Message description |
---|---|
Authorization URL generated successfully. Please navigate to the
link below as the user that you want to run integration with, to get a URL
with access code. The URL with access code should be provided next in the
Generate Token action.
|
Action succeeded. |
Failed to generate authorization URL! The Error is ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Get Authorizationaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Get Mail EML File
Use the Get Mail EML Fileaction to retrieve a message EML file.
This action runs on all Google SecOps entities.
Action inputs
The Get Mail EML Fileaction requires the following parameters:
Parameter | Description |
---|---|
Folder Name
|
Optional
A folder to fetch an email from. The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Message ID
|
Required
The message ID, such as |
Base64 Encode
|
Optional
If selected, the action encodes the mail file with in a base64 format. Not selected by default. |
Action outputs
The Get Mail EML Fileaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Script result | Available |
Script result
The following table lists the value for the script result output when using the Get Mail EML Fileaction:
Script result name | Value |
---|---|
eml_info | EML_INFORMATION
|
Move Mail to Folder
Use the Move Mail to Folderaction to move one or multiple emails from the source email folder to the other folder in a mailbox.
Depending on the use case, the action returns a different amount of information about processed emails in the JSON result.
If you select the Limit the amount of information in the JSON resultparameter, the JSON result contains only the following email fields: datetime_received
, message_id
, sender
, subject
, to_recipients
.
Otherwise, the JSON result contains all available information about the
processed email.
If you select the Disable the Action JSON Resultparameter, the action doesn't return the JSON result at all.
The Move Mail to Folderaction doesn't run on Google SecOps entities.
Action inputs
The Move Mail to Folderaction requires the following parameters:
Parameter | Description |
---|---|
Source Folder Name
|
Required
A source folder to move emails from. |
Destination Folder Name
|
Required
A destination folder to move emails to. |
Subject Filter
|
Optional
A filter condition to search emails by specific subject. |
Message IDs
|
Optional
A filter condition to search for emails with specific email IDs. This parameter also accepts a comma-separated list of message IDs to search for. If you provide the message ID, the action ignores the |
Only Unread
|
Optional
A filter condition to search only for unread emails. Not selected by default. |
Move In All Mailboxes
|
Optional
If selected, the action searches and moves emails in all mailboxes accessible through current impersonalization settings. Not selected by default. |
How many mailboxes to process in a single batch
|
Required
The number of mailboxes to process in a single batch (single connection to the mail server). If you select the The default value is 25. |
Time Frame (minutes)
|
Optional
A period in minutes to search for emails. |
Limit the Amount of Information Returned in the JSON Result
|
Optional
If selected, the action returns information only about the key email fields. If not selected, the action returns information about all email fields. Selected by default. |
Disable the Action JSON Result
|
Optional
If selected, the action doesn't return the JSON result. Not selected by default. |
Action outputs
The Move Mail to Folderaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Move Mail to Folderaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Error search emails: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Move Mail to Folderaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Ping
Use the Pingaction to test a connection to the Microsoft Exchange instance.
You can execute this action can be manually and not as a part of the playbook flow.
This action doesn't run on Google SecOps entities.
Action inputs
N/A
Action outputs
The Pingaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Pingaction can return the following output messages:
Output message | Message description |
---|---|
Successfully connected to the Microsoft Exchange server with the
provided connection parameters!
|
Action succeeded. |
Failed to connect to the Microsoft Exchange server! Error is ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Pingaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Save Mail Attachments To The Case
Use the Save Mail Attachments To The Caseaction to save email attachments from an email stored in the monitored mailbox to the Case Wall in Google SecOps.
This action doesn't run on Google SecOps entities.
Action inputs
The Save Mail Attachments To The Caseaction requires the following parameters:
Parameter | Description |
---|---|
Folder Name
|
Required
A mailbox folder to search an email in. This parameter also accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Message IDs
|
Required
The message ID to find a specific email and download attachments from it. |
Attachment To Save
|
Optional
If you don't configure this parameter, the action saves all email attachments to the Case Wall by default. Otherwise, the action saves only the attachment which you specified to the Case Wall. |
Action outputs
The Save Mail Attachments To The Caseaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Save Mail Attachments To The Caseaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Failed to save the email attachments to the case, the error is: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Save Mail Attachments To The Caseaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Search Mails
Use the Search Mailsaction to search for specific emails in a configured mailbox using multiple search criteria. This action returns information about emails that were found in a mailbox in the JSON format.
This action doesn't run on Google SecOps entities.
Action inputs
The Search Mailsaction requires the following parameters:
Parameter | Description |
---|---|
Folder Name
|
Optional
A mailbox folder to search an email in. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Subject Filter
|
Optional
A filter condition which specifies the email subject to search for. |
Sender Filter
|
Optional
A filter condition to specify the sender of requested emails. |
Recipient Filter
|
Optional
A filter condition to specify the recipient of requested emails. |
Time Frame (minutes)
|
Optional
A period in minutes to search for emails. |
Only Unread
|
Optional
If selected, the action searches only for unread emails. Not selected by default. |
Max Emails To Return
|
Optional
The maximum number of emails to return in the action result. |
Search in all mailboxes
|
Optional
If selected, the action runs a search in all mailboxes that are accessible using current impersonation settings. Not selected by default. |
How many mailboxes to process in a single batch
|
Required
The number of mailboxes to process in a single batch (single connection to the mail server). If you select the The default value is 25. |
Start Time
|
Optional
The start time for running the email search. The format to use is ISO 8601. This parameter has a priority over the |
End Time
|
Optional
The end time for running the email search. The format to use is ISO 8601. If you don't set a value and the |
Mailboxes
|
Optional
A comma-separated list of mailboxes to run a search through. This
parameter has priority over the |
Message IDs
|
Optional
A comma-separated list of message IDs to search for. This filter has priority over other filter conditions. |
Body Regex Filter
|
Optional
A regular expression pattern to search for in the email body. |
Action outputs
The Search Mailsaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Available |
Enrichment table | Not available |
JSON result | Available |
Output messages | Available |
Script result | Available |
Case wall table
The Search Mailsaction returns the following table on a Case Wall in Google SecOps:
Table title: Matching Mails
Table columns:
- Message_id
- Received Date
- Sender
- Recipients
- Subject
- Email body
- Attachment names(as a comma-separated list of attachment names)
If you select the Search in all mailboxes
parameter, the action adds the Found in mailboxcolumn to the table to indicate which mailbox the email
was found in.
JSON result
The following example shows the JSON result output received when using the Search Mailsaction:
[
{
"body"
:
"Mail Body"
,
"subject"
:
"Mail Subject"
,
"author"
:
"user_1@example.com"
},
{
"body"
:
" "
,
"subject"
:
"Mail Subject"
,
"author"
:
"user_2@example.com"
}
]
Output messages
The Search Mailsaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Search Mailsaction:
Script result name | Value |
---|---|
mails_json | Not available |
Send Email and Wait - Deprecated
Send email and wait action. Thr Send to field is comma-separated. Sender's display name can be configured in the client under the account settings.
Action inputs
Parameter Display Name | Type | Default Value | Is Mandatory | Description |
---|---|---|---|---|
Subject
|
String | N/A | Yes | The subject of the email. |
Send to
|
String | user@example.com | Yes | Recipient email address. Multiple addresses can be separated by commas. |
CC
|
String | user@example.com | No | CC email address. Multiple addresses can be separated by commas. |
BCC
|
String | N/A | No | BCC email address. Multiple addresses can be separated by commas. |
Mail content
|
String | N/A | Yes | Email body. |
Fetch Response Attachments
|
Checkbox | Unchecked | No | Allows attachment of files from response mail. |
Folder to Check for Reply
|
String | Inbox | No | Parameter can be used to specify the mailbox email folder (mailbox that was used to send the email with question) to search for the user reply in this folder. The parameter also accepts a comma-separated list of folders to check the user response in multiple folders. Parameter is case-sensitive. |
Run On
This action runs on all entities.
Action Results
Script Result
Script Result Name | Value Options | Example |
---|---|---|
Mail_body
|
N/A | N/A |
JSON Result
[
{
"EntityResult"
:
{
"attachments"
:
[],
"sensitivity"
:
"Normal"
,
"effective_rights"
:
" test"
,
"has_attachments"
:
"false"
,
"last_modified_name"
:
"mail"
,
"is_submitted"
:
"false"
},
"Entity"
:
"example@example.com"
}
]
Send Mail
Use the Send Mailaction to send an email from a specific mailbox to a list of recipients. You can use this action to inform users about the following:
- Specific alerts created in Google SecOps.
- Results of the specific alerts processing.
This action doesn't run on Google SecOps entities.
Action inputs
The Send Mailaction requires the following parameters:
Parameter | Description |
---|---|
Subject
|
Required
The email subject. |
Send to
|
Required
A comma-separated list of email addresses for the email
recipients, such as |
CC
|
Optional
A comma-separated list of email addresses for the email CC field, such as |
BCC
|
Optional
A comma-separated list of email addresses for the email BCC field, such as |
Attachments Paths
|
Optional
A comma-separated list of paths for file attachments stored on the server,
such as |
Mail content
|
Required
The email body. |
Reply-To Recipients
|
Optional
A comma-separated list of recipients used in the Reply-To header. The action adds the Reply-To header to send email replies to specific email addresses instead of the email sender address that is stated in the From field. |
Base64 Encoded Certificate
|
Optional
A base64-encoded certificate used to encrypt an email. To encrypt
the email, this parameter is enough. To sign the email, also provide the |
Base64 Encoded Signature
|
Optional
A base64 encoded certificate used to sign an email. For the
signature to work and contain a signing certificate, provide both |
Action outputs
The Send Mailaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
JSON result
The following example shows the JSON result output received when using the Send Mailaction:
{
"mime_content"
:
"b'From: exchange_online_test\\r\\n\\t<test_user@example.com>\\r\\nTo: =?iso-8859-8-i?B?4ifp6e7xIOHl8OM=?=\\r\\n\\t<example@example.com>\\r\\nSubject: test email\\r\\nThread-Topic: test email\\r\\nThread-Index: AQHZI2sS6qOMRJL5hkWATMpRN9fv4Q==\\r\\nDate: Sun, 8 Jan 2023 14:11:15 +0000\\r\\nMessage-ID: <message_id@example>\\r\\nAccept-Language: en-US\\r\\nContent-Language: en-US\\r\\nX-MS-Has-Attach:\\r\\nContent-Type: multipart/alternative;\\r\\n\\tboundary=\"_000_1673187082551404817642532883270906446a69558cb5108_\"\\r\\nMIME-Version: 1.0\\r\\n\\r\\n--_000_1673187082551404817642532883270906446a69558cb5108_\\r\\nContent-Type: text/plain; charset=\"iso-8859-8-i\"\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\ntest content\\r\\n\\r\\n--_000_1673187082551404817642532883270906446a69558cb5108_\\r\\nContent-Type: text/html; charset=\"iso-8859-8-i\"\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\n<html>\\r\\n<head>\\r\\n<meta http-equiv=3D\"Content-Type\" content=3D\"text/html; charset=3Diso-8859-=\\r\\n8-i\">\\r\\n</head>\\r\\n<body>\\r\\n<p>test content </p>\\r\\n</body>\\r\\n</html>\\r\\n\\r\\n--_000_1673187082551404817642532883270906446a69558cb5108_--\\r\\n'"
,
"_id"
:
"ItemId(id='AAMkAGMwYTc3NmZmLTM4YjYtNGJmMC1hNTllLWJmNDdlZTE0YTg4ZQBGAAAAAABZKh7ro7RoSpjbI663J/SqBwDjM1k0xgBMR6sDaC+Azo7rAAAAAAEJAADjM1k0xgBMR6sDaC+Azo7rAAAAEth6AAA=', changekey='CQAAABYAAADjM1k0xgBMR6sDaC+Azo7rAAAAEm3h')"
,
"parent_folder_id"
:
"ParentFolderId(id='AAMkAGMwYTc3NmZmLTM4YjYtNGJmMC1hNTllLWJmNDdlZTE0YTg4ZQAuAAAAAABZKh7ro7RoSpjbI663J/SqAQDjM1k0xgBMR6sDaC+Azo7rAAAAAAEJAAA=', changekey='AQAAAA==')"
,
"item_class"
:
"IPM.Note"
,
"subject"
:
"test email"
,
"sensitivity"
:
"Normal"
,
"text_body"
:
"test content\r\n"
,
"body"
:
"<html><head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"></head><body><p>test content </p></body></html>"
,
"attachments"
:
[],
"datetime_received"
:
"2023-01-08 14:11:15+00:00"
,
"size"
:
2928
,
"categories"
:
null
,
"importance"
:
"Normal"
,
"in_reply_to"
:
null
,
"is_submitted"
:
true
,
"is_draft"
:
true
,
"is_from_me"
:
false
,
"is_resend"
:
false
,
"is_unmodified"
:
false
,
"headers"
:
null
,
"datetime_sent"
:
"2023-01-08 14:11:15+00:00"
,
"datetime_created"
:
"2023-01-08 14:11:15+00:00"
,
"reminder_due_by"
:
null
,
"reminder_is_set"
:
false
,
"reminder_minutes_before_start"
:
0
,
"display_cc"
:
null
,
"display_to"
:
"\u05d2'\u05d9\u05d9\u05de\u05e1 \u05d1\u05d5\u05e0\u05d3"
,
"has_attachments"
:
false
,
"vote_request"
:
null
,
"culture"
:
"en-US"
,
"effective_rights"
:
"EffectiveRights(create_associated=False, create_contents=False, create_hierarchy=False, delete=True, modify=True, read=True, view_private_items=True)"
,
"last_modified_name"
:
"exchange_online_test"
,
"last_modified_time"
:
"2023-01-08 14:11:15+00:00"
,
"is_associated"
:
false
,
"web_client_read_form_query_string"
:
"https://example.com/&exvsurl=1&viewmodel=ReadMessageItem"
,
"web_client_edit_form_query_string"
:
null
,
"conversation_id"
:
"ConversationId(id='AAQkAGMwYTc3NmZmLTM4YjYtNGJmMC1hNTllLWJmNDdlZTE0YTg4ZQAQAOqjjESS+YZFgEzKUTfX7+E=')"
,
"unique_body"
:
"<html><body><div>\r\n<div>\r\n<p>test content </p></div></div>\r\n</body></html>"
,
"sender"
:
"Mailbox(name='exchange_online_test', email_address='test_user@example.com', routing_type='SMTP', mailbox_type='Mailbox')"
,
"to_recipients"
:
[
"Mailbox(name=\"\u05d2'\u05d9\u05d9\u05de\u05e1 \u05d1\u05d5\u05e0\u05d3\", email_address='example@example.com', routing_type='SMTP', mailbox_type='Mailbox')"
],
"cc_recipients"
:
null
,
"bcc_recipients"
:
null
,
"is_read_receipt_requested"
:
false
,
"is_delivery_receipt_requested"
:
false
,
"conversation_index"
:
"b'\\x01\\x01\\xd9#k\\x12\\xea\\xa3\\x8cD\\x92\\xf9\\x86E\\x80L\\xcaQ7\\xd7\\xef\\xe1'"
,
"conversation_topic"
:
"test email"
,
"author"
:
"Mailbox(name='exchange_online_test', email_address='test_user@example.com', routing_type='SMTP', mailbox_type='Mailbox')"
,
"message_id"
:
"<167318708255.14048.17642532883270906446@a69558cb5108>"
,
"is_read"
:
true
,
"is_response_requested"
:
false
,
"references"
:
null
,
"reply_to"
:
null
,
"received_by"
:
null
,
"received_representing"
:
null
,
"vote_response"
:
null
,
"email_date"
:
1673187075
}
In addition to the mail object JSON technical result, the action also returns the message ID and the date when an email was sent. The additional data is used in the Wait for Mailaction, if needed:
{
…
"message_id"
:
"<message_id@example.com>"
,
"email_date"
:
"1583916838"
...
}
Output messages
The Send Mailaction can return the following output messages:
Output message | Message description |
---|---|
Mail sent successfully.
|
Action succeeded. |
Failed to send email! The Error is ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Send Mailaction:
Script result name | Value |
---|---|
Success_Inidicator
|
Not available |
Send Mail HTML
Use the Send Mail HTMLaction to send an email with the HTML template
content. The Send to
field is comma-separated.
You can configure the sender name in the email client under the account settings.
This action runs on all Google SecOps entities.
Action inputs
The Send Mail HTMLaction requires the following parameters:
Parameter | Description |
---|---|
Subject
|
Required
The email subject. |
Send to
|
Required
A comma-separated list of email addresses for the email recipients. |
CC
|
Optional
A comma-separated list of email addresses for the email CC field. |
BCC
|
Optional
A comma-separated list of email addresses for the email BCC field. |
Attachments Paths
|
Optional
A comma-separated list of paths for file attachments stored on the server,
for example, |
Mail content
|
Required
The email body. |
Action outputs
The Send Mail HTMLaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Script result
The following table lists the value for the script result output when using the Pingaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Send Thread Reply
Use the Send Thread Replyaction to send a message as a reply to the email thread.
This action doesn't run on Google SecOps entities.
Action inputs
The Send Thread Replyaction requires the following parameters:
Parameter | Description |
---|---|
Message ID
|
Required
The ID of the message to send a reply to. |
Folder Name
|
Required
A comma-separated list of mailbox folders in which to run a search for an email. You can set mail-specific folders, for example, Gmail/All Mail to run a search in all of the Gmail mailbox folders. Additionally, the folder name must match the IMAP folder. If the folder name contains spaces, wrap spaces in double quotes. The Exchange integration uses
backslashes as separators to specify subfolders, such as |
Content
|
Required
A content of the reply. |
Attachment Paths
|
Optional
A comma-separated list of paths to file attachments stored on the server. |
Reply All
|
Optional
If selected, the action sends a reply to all recipients related to the
original email and the ignores the Selected by default. |
Reply To
|
Required
A comma-separated list of emails to send the reply to. If you don't set a value and don't select the If you select the |
Action output
The Send Thread Replyaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Send Thread Replyaction can return the following output messages:
Output message | Message description |
---|---|
Successfully sent reply to the message with ID MESSAGE_ID
in Exchange.
|
Action succeeded. |
Error executing action "Send Thread Reply". Reason: if you want
to send a reply only to your own email address, you need to work with
"Reply To" parameter.
|
Action failed. Check the |
Error executing action "Send Thread Reply". Reason: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Send Thread Replyaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Send Vote Mail
Use the Send Vote Mailaction to send emails with preconfigured answer options to include users who don't have access to the Google SecOps UI in automated processes.
This action supports the vote feature only if the recipients use Exchange to properly view and select the vote options.
This action doesn't run on Google SecOps entities.
Action inputs
The Send Vote Mailaction requires the following parameters:
Subject
The email subject.
Send to
A comma-separated list of email addresses for the email
recipients, such as user1@example.com, user2@example.com
.
CC
A comma-separated list of email addresses for the email CC field, such as user1@example.com, user2@example.com
.
BCC
A comma-separated list of email addresses for the email BCC field, such
as user1@example.com, user2@example.com
.
Attachments Paths
A comma-separated list of paths for file attachments stored on the server,
for example, C:\ FILE_DIRECTORY
\file.pdf,
C:\ FILE_DIRECTORY
\image.jpg
.
Question or Decision Description
The question to ask recipients or the decision for the recipients to respond to.
Structure of voting options
A structure of the vote to sent to recipients.
The possible values are as follows:
-
Yes/No
-
Approve/Reject
The default value is Yes/No
.
Action outputs
The Send Vote Mailaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Available |
Output messages | Available |
Script result | Available |
JSON result
The following example shows the JSON result output received when using the Send Vote Mailaction:
{
…
"message_id"
:
"example@example.com>"
,
"email_date"
:
"1583916838"
...
}
Output messages
The Send Vote Mailaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Could not send vote mail to any of the provided mailboxes.
Please check the action parameters and try again.
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Send Vote Mailaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Wait for Mail From User
Use the Wait for Mail From Useraction to wait for the user response based on an email sent with the Send Mail action.
This action works asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
This action doesn't run on Google SecOps entities.
Action inputs
The Wait for Mail From Useraction requires the following parameters:
Parameter | Description |
---|---|
Mail message_id
|
Required
The message ID of the email. If the message is sent using the |
Mail Date
|
Required
A timestamp of the sent email which the current action awaits for. If a message is sent using the Send Mail
action, select the |
Mail Recipients
|
Required
A comma-separated list of email recipients which the current action awaits the response from. If a message is sent using the Send
Mail
action, select the |
How long to wait for recipient reply (minutes)
|
Required
A period for the action to wait for the user reply before marking it timed out. The default value is 1440 minutes. |
Wait for All Recipients to Reply?
|
Optional
If selected, the action waits for responses from all recipients until either reaching a timeout or proceeding with the first reply. Selected by default. |
Wait Stage Exclude pattern
|
Optional
A regular expression to exclude specific replies from the wait stage. This parameter works with the email body. For example, you can configure the action to not consider automatic out-of-office messages as recipient replies and instead wait for an actual user reply. |
Folder to Check for Reply
|
Optional
A mailbox email folder to search for the user reply in. The action runs a search in the mailbox which the email containing a question was sent from. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as This parameter is case-sensitive. The default value is |
Fetch Response Attachments
|
Optional
If selected and the recipient reply contains attachments, the action retrieves the reply and adds it as an attachment for the action result. Not selected by default. |
Action outputs
The Wait for Mail From Useraction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Available |
Script result | Available |
Case wall attachment
The Wait for Mail From Useraction returns the following attachment on a Case wall in Google SecOps:
Attachment field | Description |
---|---|
title
|
Attachment from the recipient |
filename
|
|
fileContent
|
|
The attachment type is Entityis mapped to the recipient who replied to the message_id
that the Google SecOps server tracks the responses
for.
JSON result
As a JSON result, the action returns a combination of the two following outputs:
-
A mail object JSON output for the email with a tracked response.
The action tracks the email response using
message_id
. -
A JSON output for the process of tracking responses from users.
The method to merge the output data is defined at the implementation stage.
The flow for the mail object JSON output is as follows:
-
the action waits for at least one user response to proceed.
-
After receiving the response from the first user, the action updates the JSON result and proceeds with action results.
{ "Responses" : {[ "user1@example.com" : "Approved" , "user2@example.com" : "" , "user3@example.com" : "" ]} }
The flow for the tracking response process output is as follows:
-
The action waits for all user responses to proceed.
-
After receiving replies from users or reaching timeout, the action updates the JSON result.
In this case, if the action is waiting for responses from all recipients and the timeout is reached while waiting for user responses, the action returns the
handled_timeout
error.{ "Responses" : {[ "user1@example.com" : "Approved" , "user2@example.com" : "Approved" , "user3@example.com" : "Timeout" ]} }
Output messages
The Wait for Mail From Useraction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Wait for Vote Mail Results
Use the Wait for Vote Mail Resultsaction to wait for and retrieve the responses of a vote mail that was sent using the Send Vote Mailaction. The Wait for Vote Mail Resultsaction forwards the retrieved responses to Google SecOps.
To properly track and retrieve the vote results, track the vote email. For more information, see the Send Vote Mail action.
This action doesn't run on Google SecOps entities.
Action inputs
The Wait for Vote Mail Resultsaction requires the following parameters:
Parameter | Description |
---|---|
Vote Mail message_id
|
Required
The message ID of the vote email. If the message is sent using the |
Mail Recipients
|
Required
A comma-separated list of recipient emails the current action awaits the response from. Select the |
Folder to Check for Reply
|
Required
A mailbox folder to search for the user reply in. The action runs a search in the mailbox which the email containing a question was sent from. This parameter also accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as This parameter is case-sensitive. The default value is |
Folder to Check for Sent Mail
|
Required
A mailbox folder to search for the sent mail in. The action runs a search in the mailbox which the email containing a question was sent from. This parameter also accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as This parameter is case-sensitive. The default value is |
How long to wait for recipient reply (minutes)
|
Required
A period for the action to wait for the user reply before marking it as timed out. The default value is 1440 minutes. |
Wait for All Recipients to Reply?
|
Optional
If selected, the action waits for responses from all recipients until reaching a timeout or proceeding with the first reply. Selected by default. |
Action outputs
The Wait for Vote Mail Resultsaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Available |
Output messages | Available |
Script result | Available |
JSON result
The following example shows the JSON result output received when using the Wait for Vote Mail Resultsaction:
{
"Responses"
:
[{
"recipient"
:
"user@example.com"
,
"content"
:
"Approve"
}]
}
Output messages
The Wait for Vote Mail Resultsaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Wait for Vote Mail Resultsaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
The Block Sender and Domain functionality
One of the most common use cases for email management and security is to contain existing threats, like phishing emails, that are already in the organization inbox, and then block a suspicious sender or a domain to protect your organization from future attacks and prevent possible security breaches.
In Google SecOps, the Exchange integration provides you with the Block Sender and Domainfunctionality comprising of the following sequential stages:
-
Protection within the organization.
Use the Block Sender by Message IDaction to add the sender to the blocklist using the Mark as Junk EWS service.
-
Protection outside of the organization with inbox rules.
Create inbox rules to add them on the client level and automatically prevent harmful emails from reaching your organization mailboxes.
-
Protection outside of the organization with server inbox rules.
Create server inbox rules to prevent suspicious emails from even reaching the organization.
You can learn more about these stages in the following section.
Use case
The following use case shows an example of a security breach that is a suspicious and potentially harmful email.
After discovering that a suspicious and harmful email has compromised several mailboxes of your organization, the routine for handling this kind of threat is as follows:
- Remediate the threat with the Block Sender by Message IDaction.
- Handle compromised mailboxes.
- Add a protection against the received suspicious email in other mailboxes as well.
Remediate threat
To remediate the threat, run the Block Sender by Message IDaction to obtain the parameters for investigation and more information about the suspicious email. The action also lets you examine only the compromised mailboxes and handle the threat contained in them.
The Block Sender by Message IDaction triggers the Exchange EWS Mark as Junk service to do the following:
- Move the suspicious email to the Junkfolder.
- Add the email sender to the Blocked Sender Listof the investigated mailbox.
For more information about using the Mark as Junk service, see Add and remove email addresses from the Blocked Sender Listby using EWS in Exchange in Microsoft product documentation.
On one hand, remediating a threat with the Block Sender by Message IDaction targets only compromised mailboxes and can be automatic. On the other hand, the action can neither block a sender in the uncompromised mailboxes nor add domains using API to the Blocked Sender List.
Handle compromised mailboxes
After remediating a threat, the next steps are to handle compromised mailboxes and protect every mailbox in the organization from any malicious senders, even the potential ones.
To handle compromised mailboxes, execute the inbox rules action set that consists of the following actions:
- Add Domains to Exchange-Siemplify Inbox Rules
- Add Senders to Exchange-Siemplify Inbox Rule
- Delete Exchange-Siemplify Inbox Rules
- List Exchange-Siemplify Inbox Rules
- Remove Domains from Exchange-Siemplify Inbox Rules
- Remove Senders from Exchange-Siemplify Inbox Rules
To learn more about the service used in the actions, see Manage inbox rules in Exchange in Microsoft product documentation.
The Exchange integration lets you use a set of the following predefined rules for the most common operations:
- Siemplify – Senders List – Move To Junk
- Siemplify – Senders List – Delete
- Siemplify – Senders List – Permanently Delete
- Siemplify – Domains List – Move To Junk
- Siemplify – Domains List – Delete
- Siemplify – Domains List – Permanently Delete
Permanently delete the malicious sender emails
To maintain the same list of rules in all mailboxes, add the rules for the administrator user. To apply the administrator rules to other users, run the operation on all mailboxes.
To permanently delete the malicious sender emails, complete the following steps:
-
In Google SecOps, from the administrator account, run the Add Senders to Exchange-Siemplify Inbox Ruleaction. Enter the malicious sender email.
-
Choose the appropriate rule from the list to define how to manage a suspicious email. To permanently delete malicious emails, select the Siemplify – Senders List – Permanently Deleterule.
The action updates the inbox rule with the new malicious sender.
-
Select the
Perform action in all mailboxes
parameter to apply the rule to all mailboxes.If the rule doesn't exist in a mailbox, the action creates it. If the rule already exists in a mailbox, the action updates it with the new parameter values.
-
To add a protection against the received suspicious email in other mailboxes and block the malicious sender domain, select the
Should add senders' domain to the corresponding Domains List rule as well?
parameter. -
Review other parameters in the action and adjust them if necessary.
The Add Senders to Exchange-Siemplify Inbox Ruleaction updates multiple
rules at a time according to the Mailboxes to process in one batch
parameter.
The Add Senders to Exchange-Siemplify Inbox Ruleaction works on both senders
and domains, applies to all mailboxes regardless of whether there's a suspicious
email received, and can be automatic.
The end user can delete the applied rules for their mailbox. Applying administrator rules to other mailboxes automatically removes disabled private inbox rules.
The Block Sender and Domain actions
Before running the actions for the Block Sender and Domain functionality, configure the minimal required permissions .
Add Domains to Exchange-Siemplify Inbox Rules
Use the Add Domains to Exchange-Siemplify Inbox Rulesaction to get a list of domains as a parameter or work with the Google SecOps Domainentity if the parameters are empty. This action is available only for Google SecOps version 5.6 and later.
Before running this action, configure the required action permissions .
You can create or update a rule by filtering the domains from
your mailboxes. You can modify this action using the Rule to add Domains to
parameter.
The Add Domains to Exchange-Siemplify Inbox Rulesaction modifies the current inbox rules of your users with EWS.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
If you don't set any parameters and your Google SecOps version is 5.6 and later, this action runs on the Domainentity.
Action inputs
The Add Domains to Exchange-Siemplify Inbox Rulesaction requires the following parameters:
Domains
A comma-separated list of domains to add to the rule.
Rule to add Domains to
A rule to add domains to.
If there is no rule, the action creates it.
The possible values are as follows:
-
Siemplify - Domains List - Move To Junk
-
Siemplify - Domains List - Delete
-
Siemplify - Domains List - Permanently Delete
The default value is Siemplify - Domains List - Move To Junk
.
Perform action in all mailboxes
If selected, the action applies to all mailboxes accessible through the current impersonation settings.
Not selected by default.
How many mailboxes to process in a single batch
If you select the Perform action in all mailboxes
parameter,
the action works in batches.
This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server).
The default value is 50.
Action outputs
The Add Domains to Exchange-Siemplify Inbox Rulesaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Add Domains to Exchange-Siemplify Inbox Rulesaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Add Domains to Exchange-Siemplify Inbox Rulesaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Add Senders to Exchange-Siemplify Inbox Rule
Use the Add Senders to Exchange-Siemplify Inbox Ruleaction to obtain a list of email addresses as a or work with the Google SecOps Userentity if the parameters are empty. You can use regular expressions for this action.
You can create a new rule by filtering the senders from your mailboxes. You can
modify this action using the Rule to add senders to
parameter.
Before running this action, make sure to configure the required action permissions .
The Add Senders to Exchange-Siemplify Inbox Ruleaction modifies the current inbox rules of your users using EWS.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
If the email regular expression is valid and you don't configure any parameters, this action runs on the Userentity.
Action inputs
The Add Senders to Exchange-Siemplify Inbox Ruleaction requires the following parameters:
Senders
A comma-separated list of email addresses to add to the rule.
If you don't set a value, the action works with the User entity.
Rule to add senders to
A rule to add the sender to.
If there is no rule, the action creates it.
The possible values are as follows:
-
Siemplify - Senders List - Move To Junk
-
Siemplify - Senders List - Delete
-
Siemplify - Senders List - Permanently Delete
The default value is Siemplify - Senders List - Move To Junk
.
Should add senders' domain to the corresponding Domains List rule
as well?
If selected, the action automatically adds the domains of the provided email addresses to the corresponding domain rules.
Not selected by default.
Perform action in all mailboxes
If selected, the action applies to all mailboxes accessible through the current impersonalization settings.
Not selected by default.
How many mailboxes to process in a single batch
If you select the Perform action in all mailboxes
parameter,
the action works in batches.
This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server).
The default value is 50.
Action outputs
The Add Senders to Exchange-Siemplify Inbox Ruleaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Add Senders to Exchange-Siemplify Inbox Ruleaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Add Senders to Exchange-Siemplify Inbox Ruleaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Block Sender by Message ID
Use the Block Sender by Message IDaction to obtain a list of message IDs as a parameter and mark the list as junk.
In this action, marking an item as junk adds the email sender address to the Blocked Senders Listand moves the item to the Junk folder.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
The Block Sender by Message IDaction supports only Exchange Server version 2013 and later. If you use an earlier version, the action fails with the corresponding message.
A message from the suspicious email address must exist in the user mailbox before you add the email address to or remove it from the Blocked Senders List.
The Block Sender by Message IDaction doesn't run on Google SecOps entities.
Action inputs
The Block Sender by Message IDaction requires the following parameters:
Parameter | Description |
---|---|
Move item to Junk folder?
|
Required
If selected, the action moves the specified messages to the junk folder. Selected by default. |
Message IDs
|
Optional
A filter condition to find emails with specific email IDs. This parameter accepts a comma-separated list of message IDs to mark as junk. If you provide the message ID, the action ignores the |
Mailboxes list to perform on
|
Optional
A filter condition to execute the operation on a specific list of mailboxes for better timing. To mark messages from multiple email addresses as junk, provide a comma-separated list of email addresses. If you provide a mailbox list, the action ignores the |
Folder Name
|
Optional
A mailbox folder to search for an email in. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as The default value is |
Subject Filter
|
Optional
A filter condition which specifies the email subject to search for. |
Sender Filter
|
Optional
A filter condition which specifies the sender of requested emails. |
Recipient Filter
|
Optional
A filter condition which specifies the recipient of requested emails. |
Mark All Matching Emails
|
Optional
If selected, the action marks all emails from the mailbox that match the criteria. If not selected, the action marks only the first matching email. Not selected by default. |
Perform action in all mailboxes
|
Optional
If selected, the action moves to junk and blocks sender emails in all mailboxes accessible through the current impersonation settings. Not selected by default. |
How many mailboxes to process in a single batch
|
Optional
If you select the This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server). The default value is 25. |
Time Frame (minutes)
|
Optional
The period in minutes to search for emails. |
Action outputs
The Block Sender by Message IDaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Block Sender by Message IDaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Failed to execute action - Action is fully supported only from
Exchange Server version 2013 and above, Please make sure you have the
appropriate version configured in Chronicle SOAR.
|
Action failed. The Exchange Server version that you're using isn't supported. |
Error performing "Mark as junk and Block Sender" action: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Block Sender by Message IDaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Delete Exchange-Siemplify Inbox Rules
Use the Delete Exchange-Siemplify Inbox Rulesaction to get a rule name as a parameter and delete it from all specified mailboxes.
Before running this action, configure the required action permissions .
The Delete Exchange-Siemplify Inbox Rulesaction modifies the current inbox rules of your users with EWS.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
This action doesn't run on Google SecOps entities.
Action inputs
The Delete Exchange-Siemplify Inbox Rulesaction requires the following parameters:
Rule Name To Delete
A rule name to completely delete from the relevant mailboxes.
The possible values are as follows:
-
Siemplify – Senders List – Move To Junk
-
Siemplify – Senders List – Delete
-
Siemplify – Senders List – Permanently Delete
-
Siemplify – Domains List – Move To Junk
-
Siemplify – Domains List – Delete
-
Siemplify – Domains List – Permanently Delete
-
All available Exchange-Siemplify Senders Rules
-
All available Exchange-Siemplify Domains Rules
-
All available Exchange-Siemplify Rules
Perform action in all mailboxes
If selected, the action applies to all mailboxes accessible through the current impersonation settings.
Not selected by default.
How many mailboxes to process in a single batch
If you select the Perform action in all mailboxes
parameter, the action works in batches.
This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server).
The default value is 50.
Action outputs
The Delete Exchange-Siemplify Inbox Rulesaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Delete Exchange-Siemplify Inbox Rulesaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Error performing "Delete Siemplify Inbox Rules" action: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Delete Exchange-Siemplify Inbox Rulesaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
List Exchange-Siemplify Inbox Rules
Use the List Exchange-Siemplify Inbox Rulesaction to get a rule name from the Exchange-Siemplify Inbox rules as a parameter and list it. If there are no mailboxes to list, the action lists the rules for the logged in user.
Before running this action, configure the required action permissions .
The List Exchange-Siemplify Inbox Rulesaction modifies the current inbox rules of your users with EWS.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
This action doesn't run on Google SecOps entities.
Action inputs
The List Exchange-Siemplify Inbox Rulesaction requires the following parameters:
Rule Name To List
A rule name to list from the relevant mailboxes.
The possible values are as follows:
-
Siemplify – Senders List – Move To Junk
-
Siemplify – Senders List – Delete
-
Siemplify – Senders List – Permanently Delete
-
Siemplify – Domains List – Move To Junk
-
Siemplify – Domains List – Delete
-
Siemplify – Domains List – Permanently Delete
-
All available Exchange-Siemplify Senders Rules
-
All available Exchange-Siemplify Domains Rules
-
All available Exchange-Siemplify Rules
Mailboxes list to perform on
A filter condition which specifies the list of mailboxes to execute the operation on, for better timing.
This parameter accepts a comma-separated list of mail addresses to unmark the messages as junk.
If a mailbox list is provided, the action ignores the Perform
action in all mailboxes
parameter.
Perform action in all mailboxes
If selected, the action applies to all mailboxes accessible through the current impersonation settings.
Not selected by default.
How many mailboxes to process in a single batch
If you select the Perform action in all mailboxes
parameter,
the action works in batches.
This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server).
The default value is 50.
Action outputs
The List Exchange-Siemplify Inbox Rulesaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Available |
Output messages | Available |
Script result | Available |
JSON result
The following example shows the JSON result output received when using the List Exchange-Siemplify Inbox Rulesaction:
{
{
"id"
:
"example_id"
,
"name"
:
"Siemplify - Domains List - Delete"
,
"priority"
:
1
,
"is_enabled"
:
True
,
"conditions"
:
{
"domains"
:
[
"EXAMPLE.COM"
,
"EXAMPLE.CO"
],
"addresses"
:
[]
},
"actions"
:
"move_to_folder"
}
}
Output messages
The List Exchange-Siemplify Inbox Rulesaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Error performing "List Exchange-Siemplify Inbox Rules" action: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the List Exchange-Siemplify Inbox Rulesaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Remove Domains from Exchange-Siemplify Inbox Rules
Use the Remove Domains from Exchange-Siemplify Inbox Rulesto get a list of domains as a parameter or work on the Domainentity if the parameters are not provided. This action is available only for Google SecOps version 5.6 and later. You can remove the provided domains from the existing rules.
Before running this action, configure the required action permissions .
The Remove Domains from Exchange-Siemplify Inbox Rulesaction modifies the current inbox rules of your users with EWS.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
If you don't configure any parameters, this action runs on the Google SecOps Domainentity.
Action inputs
The Remove Domains from Exchange-Siemplify Inbox Rulesaction requires the following parameters:
Domains
A comma-separated list of domains to remove from the rule.
If you don't set a value, the action works with entities.
Rule to remove Domains from
A rule to remove domains from.
If you don't set a rule, the action fails.
The possible values are as follows:
-
Siemplify – Domains List – Move To Junk
-
Siemplify – Domains List – Delete
-
Siemplify – Domains List – Permanently Delete
The default value is Siemplify – Domains List – Move To
Junk
.
Remove Domains from all available Rules
If selected, the action searches for the provided domains in all Google SecOps inbox rules.
Not selected by default.
Mailboxes list to perform on
A filter condition which specifies the list of mailboxes to execute the operation on, for better timing.
This parameter accepts a comma-separated list of mail addresses to unmark the messages as junk.
If you provide a mailbox list, the action ignores the Perform
action in all mailboxes
parameter.
Perform action in all mailboxes
If selected, the action applies to all mailboxes accessible through the current impersonation settings.
Not selected by default.
How many mailboxes to process in a single batch
If you select the Perform action in all mailboxes
parameter,
the action works in batches.
This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server).
The default value is 50.
Action outputs
The Remove Domains from Exchange-Siemplify Inbox Rulesaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Remove Domains from Exchange-Siemplify Inbox Rulesaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Remove Domains from Exchange-Siemplify Inbox Rulesaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Remove Senders from Exchange-Siemplify Inbox Rules
Use the Remove Senders from Exchange-Siemplify Inbox Rulesget a list of email senders as a parameter or work with the Userentity if the parameters are not provided.
You can remove the provided senders from the existing rules.
Before running this action, configure the required action permissions .
The Remove Senders from Exchange-Siemplify Inbox Rulesaction modifies the current inbox rules of your users with EWS.
This action runs asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
If no parameters are provided, this action runs on the Google SecOps Userentity.
Action inputs
The Remove Senders from Exchange-Siemplify Inbox Rulesaction requires the following parameters:
Senders
A comma-separated list of email addresses to remove from the rule.
If you don't set a value, the action works with the User entity.
Rule to remove senders from
A rule to remove the senders from.
If you don't set a rule, the action fails.
The possible values are as follows:
-
Siemplify – Senders List – Move To Junk
-
Siemplify – Senders List – Delete
-
Siemplify – Senders List – Permanently Delete
The default value is Siemplify – Senders List – Move To
Junk
.
Remove senders from all available rules
If selected, the action searches for the provided senders in all Google SecOps inbox rules.
Not selected by default.
Should remove senders' domain from the corresponding Domains List
rule as well?
If selected, the action automatically removes the domains of the provided email addresses from the corresponding domain rules.
Not selected by default.
Perform action in all mailboxes
If selected, the action applies to all mailboxes accessible through the current impersonalization settings.
Not selected by default.
How many mailboxes to process in a single batch
If you select the Perform action in all mailboxes
parameter,
the action works in batches.
This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server).
The default value is 50.
Action outputs
The Remove Senders from Exchange-Siemplify Inbox Rulesaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Remove Senders from Exchange-Siemplify Inbox Rulesaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Remove Senders from Exchange-Siemplify Inbox Rulesaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Unblock Sender by Message ID
Use the Unblock Sender by Message IDaction to obtain a list of message IDs as a parameter and unmark it as junk.
In this action, unmarking an item as junk removes the sender email address from
the Blocked Senders List. To move an item back to the inbox folder,
select the Move items back to Inbox?
parameter in the action parameters.
The Unblock Sender by Message IDruns asynchronously. Adjust the script timeout value in the Google SecOps IDE for the action as needed.
This action supports only Exchange Server version 2013 and later. If you use an earlier version, the action fails with the corresponding message.
A message from the suspicious email address must exist in the user mailbox before you add the email address to or remove it from the Blocked Senders List.
This action doesn't run on Google SecOps entities.
Action inputs
The Unblock Sender by Message IDaction requires the following parameters:
Parameter | Description |
---|---|
Move items back to Inbox?
|
Required
If selected, the action moves the specified messages back to the inbox folder. Selected by default. |
Message IDs
|
Optional
A filter condition to unmark emails with specific email IDs. This parameter also accepts a comma-separated list of message IDs to unmark emails as junk. If you provide the message ID, the action ignores the |
Mailboxes list to perform on
|
Optional
A filter condition to execute the operation on a specific list of mailboxes for better timing. To mark messages from multiple email addresses as junk, provide a comma-separated list of email addresses. If you provide a mailbox list, the action ignores the |
Folder Name
|
Optional
A mailbox folder to search an email in. This parameter accepts a comma-separated list of folders to move the item from. The Exchange integration uses
backslashes as separators to specify subfolders, such as The default
value is |
Subject Filter
|
Optional
A filter condition which specifies the email subject to search for. |
Sender Filter
|
Optional
A filter condition which specifies the sender of requested emails. |
Recipient Filter
|
Optional
A filter condition which specifies the recipient of requested emails. |
Unmark All Matching Emails
|
Optional
If selected, the action unmarks all emails from the mailbox that match the criteria. If not selected, the action unmarks only the first matching email. Not selected by default. |
Perform action in all mailboxes
|
Optional
If selected, the action applies to all mailboxes accessible through the current impersonation settings. Not selected by default. |
How many mailboxes to process in a single batch
|
Optional
If you select the This parameter defines the number of mailboxes to process in a single batch (single connection to the mail server). The default value is 25. |
Time Frame (minutes)
|
Optional
A period in minutes to search for emails. |
Action outputs
The Unblock Sender by Message IDaction provides the following outputs:
Action output type | Availability |
---|---|
Case wall attachment | Not available |
Case wall link | Not available |
Case wall table | Not available |
Enrichment table | Not available |
JSON result | Not available |
Output messages | Available |
Script result | Available |
Output messages
The Unblock Sender by Message IDaction can return the following output messages:
Output message | Message description |
---|---|
|
Action succeeded. |
Failed to execute action - Action is fully supported only from
Exchange Server version 2013 and above, Please make sure you have the
appropriate version configured in Chronicle SOAR.
|
Action failed. The Exchange Server version that you're using isn't supported. |
Error performing action: ERROR_REASON
|
Action failed. Check the connection to the server, input parameters, or credentials. |
Script result
The following table lists the value for the script result output when using the Unblock Sender by Message IDaction:
Script result name | Value |
---|---|
is_success
|
True
or False
|
Connectors
For detailed instructions on how to configure a connector in Google SecOps, see Ingest your data (connectors) .
When configuring connectors and actions, pay attention to spaces and special symbols in your credentials. If the integration rejects your credentials, check the spelling.
To configure the selected connector use the connector-specific parameters listed in the following tables:
- Exchange EML Connector configuration parameters
- Exchange Mail Connector configuration parameters
- Exchange Mail Connector V2 configuration parameters
- Exchange Mail Connector v2 with OAuth Authentication configuration parameters
Exchange EML Connector
The Exchange EML Connectorretrieves emails from the Exchange server and parses them. If there are attached EML files, the connector attaches them to the case as events. If there are multiple EML attachments in the email, the connector creates multiple cases and ingests every attachment as one event for each case.
Known restrictions
-
Microsoft 365 and basic authentication.
- The Exchange EML Connectordoesn't support basic authentication anymore and cannot be used with Microsoft 365. For Microsoft 365, use the Exchange Mail Connector v2 with OAuth.
-
The Exchange EML Connectorspecifics are as follows:
-
The connector creates Google SecOps alerts only from emails that contain EML or MSG file attachments.
-
The connector ignores emails that don't contain mail attachments.
-
Connector inputs
The Exchange EML Connectorrequires the following parameters:
Parameter | Description |
---|---|
Product Field Name
|
Required
The name of the field where the product name is stored. The default value is |
EventClassId
|
Required
A field name that is used to determine the event name (subtype). The default value is |
Server IP
|
Required
An IP address of the server to connect to. |
Domain
|
Required
A domain value to use for authentication. |
Username
|
Required
A username for the mailbox to pull emails from,
like |
Password
|
Required
A password for the email mailbox to pull emails from. |
Mail Address
|
Required
An email address for the mailbox to monitor. The default value is |
Verify SSL
|
Optional
If selected, the integration verifies that the SSL certificate for connecting to the Exchange server is valid. Not selected by default. |
Use Domain for Authentication
|
Optional
If selected, the integration uses domain as a part of the authentication
credentials, such as Selected by default. |
Unread Emails Only
|
Optional
If selected, cases are created only from unread emails. Not selected by default. |
Mark Emails as Read
|
Optional
If selected, emails are marked as read after ingesting. Not selected by default. |
Max Days Backwards
|
Optional
The number of days before the first connector iteration to retrieve the emails from. This parameter applies only once to the initial connector iteration after you enable the connector for the first time. |
PythonProcessTimeout
|
Required
The timeout limit in seconds for the Python process running current script. The default value is 30 seconds. |
Folder Name
|
Optional
A folder name to run a search through. The Exchange integration uses
backslashes as separators to specify subfolders, such as The default value is |
Environment Field Name
|
Optional
The name of the field where the environment name is stored. If the
environment field isn't found, the environment is set to |
Environment Regex Pattern
|
Optional
A regular expression pattern to run on the value found in the Use the default value If the regular expression pattern is null or empty, or the environment value is null, the final environment result is the default environment. |
Encode Data as UTF-8
|
Optional
If selected, the integration encodes the email data with UTF-8. It is recommended to select this parameter. Selected by default. |
Attach EML or MSG File to the Case Wall
|
Optional
If selected, the integration attaches the forwarded EML or MSG file to the Case wall in Google SecOps. Not selected by default. |
Exclusion Body Regex
|
Optional
A regular expression to exclude emails whose body matches the provided value. For example, the |
Proxy Server Address
|
Optional
The address of the proxy server to use. |
Proxy Username
|
Optional
The proxy username to authenticate with. |
Proxy Password
|
Optional
The proxy password to authenticate with. |
Extract urls from HTML email part?
|
Optional
If selected, the connector attempts to extract URLs from the HTML part of the email. This parameter also allows connector to extract complex URLs, but not the URLs from the plain text part of email. Extracted URLs are
available in the Not selected by default. |
Connector rules
-
The Exchange EML Connectordoesn't support blocklist and dynamic list rules.
-
The Exchange EML Connectorsupports proxies.
Exchange Mail Connector
Use the Exchange Mail Connectorto communicate with the Exchange server and search for emails in near real time and forward them for translating and contextualizing as alerts in Google SecOps cases.
This section refers to communicating with a Microsoft Exchange 2007-2019 Server or Microsoft 365 using Exchange Web Services (EWS) and explains how Google SecOps interacts with the Exchange Mail interface and the assisted workflows and activities within the application.
The Exchange Mail Connectorenables retrieving emails from the configured Exchange server that scans each server and subsequently creates new cases. At least one initial email occurrence is included in each scenario. The main difference is that Exchange Mail connectorremoves emails and generates events that parse the EML or MSG data in the Exchange server's original emails.
Known restrictions
-
Microsoft 365 and basic authentication.
- The Exchange Mail Connectordoesn't support basic authentication anymore and cannot be used with Microsoft 365. For Microsoft 365, use the Exchange Mail Connector v2 with OAuth.
-
The Exchange Mail Connectorspecifics are as follows:
-
The connector creates Google SecOps alerts only from original received emails that are contained in the mailbox.
-
The connector ignores attached EML and MSG files.
-
Connector inputs
The Exchange Mail Connectorrequires the following parameters:
Parameter | Description |
---|---|
Product Field Name
|
Required
The name of the field where the product name is stored. The default value is |
Event Field Name
|
Required
The field name used to determine the event name (subtype). the default value is |
Server IP
|
Required
An IP address of the server to connect to. |
Domain
|
Required
A domain value to use for authentication. |
Username
|
Required
A username for the mailbox to pull emails from, like |
Password
|
Required
A password for the email mailbox to pull emails from. |
Mail Address
|
Required
An email address for the mailbox to monitor. The default value is |
Verify SSL
|
Optional
If selected, the integration verifies that the SSL certificate for connecting to the Exchange server is valid. Not selected by default. |
Use Domain for Authentication
|
Optional
If selected, the domain is used as a part of the authentication
credentials, such as Selected by default. |
Unread Emails Only
|
Optional
If selected, the integration creates cases only from unread emails. Selected by default. |
Mark Emails as Read
|
Optional
If selected, the integration marks all ingested emails as read. Not selected by default. |
Max Days Backwards
|
Optional
The number of days before the first connector iteration to retrieve the emails from. This parameter applies only once to the initial connector iteration after you enable the connector for the first time. |
PythonProcessTimeout
|
Required
The timeout limit in seconds for the Python process running current script. the default value is 30 seconds. |
Attach Original EML
|
Optional
If selected, the original email is attached to the case as an EML file. Not selected by default. |
Folder Name
|
Optional
A folder name to run a search through. The Exchange integration uses
backslashes as separators to specify subfolders, such as The default value is |
Environment Field Name
|
Optional
A name of the field where the environment name is stored. If the
environment field isn't found, the environment is set to |
Environment Regex Pattern
|
Optional
A regular expression pattern to run on the value found in the Use the default value If the regular expression pattern is null or empty, or the environment value is null, the final environment result is the default environment. |
Exclusion Subject Regex
|
Optional
A regular expression to exclude emails with a subject matching the provided value. For example, the |
Exclusion Body Regex
|
Optional
A regular expression to exclude emails with a body matching the provided value. For example, the |
Proxy Server Address
|
Optional
An address of the proxy server to use. |
Proxy Username
|
Optional
A proxy username to authenticate with. |
Proxy Password
|
Optional
A proxy password to authenticate with. |
Extract urls from HTML email part?
|
Optional
If selected, the connector attempts to extract URLs from the HTML part of the email. This parameter lets the connector extract complex URLs, but not the URLs from the plain text part of email. Extracted URLs are
available in the Not selected by default. |
Configure dynamic list rules
In the dynamic list section, to extract specific values from emails using regular expressions, add a rule in the following format:
'<var>FIELD_NAME</var>': '<var>REGULAR_EXPRESSION</var>'
For example, to extract the message ID from email, enter the following rule:
message-id: (?<=Message-ID: ).*
Connector rules
-
The Exchange Mail Connectorsupports proxies.
-
The Exchange Mail Connectordoesn't support the blocklist rule.
-
The Exchange integration uses the dynamic list section to define regular expressions and enable the following:
- Parse email content.
- Add specific fields based on the regular expression that match the email event.
Exchange Mail Connector v2
Use the Exchange Mail Connector v2to connect to the mail server and check for new emails in a specific mailbox.
If a new email appears, it triggers the connector to create and ingest in Google SecOps a new alert that contains information from the new email.
If there are no new emails, the Exchange Mail Connector v2completes the current iteration and stands by for a defined period before the upcoming iteration run.
Connector iteration flow
After each run, the Exchange Mail Connector v2updates the timestamp file with the date and time of the last run. The Exchange Mail Connector v2extracts actionable information for a case from the email as a mail object technical result, such as, but not limited to:
- Email sender and recipient.
- Email subject.
- Email body.
- URLs in the email.
- Attachments, if any.
After the Exchange Mail Connector v2creates the alerts (cases) to ingest into Google SecOps, the connector iteration completes.
Based on the case data provided by the Exchange Mail Connector v2, the Google SecOps server runs ETL procedures to ingest new alerts and create or update cases. If there are related playbooks defined, Google SecOps executes playbooks to enrich the case, generate insights, and perform automatic actions.
Work with Alert Name Template and Case Name Template
The Alert Name Template
and Case Name Template
parameters let you
overwrite the way alert and case name are created. Only the first alert sets the
case or alert name, all other subsequent alerts don't affect the name.
The example of a Google SecOps event is as follows:
{
"event"
:
{
"type"
:
"Phishing"
"name"
:
"Example Event"
,
"id"
:
"1"
}
}
To create a custom name for a Google SecOps alert, use the following template:
[
EVENT_TYPE
]
-
[
EVENT_NAME
]
For example, to create a Google SecOps alert named Phishing – Example Event, the template is as follows:
[
Phishi
n
g
]
-
[
Example
Eve
nt
]
Connector inputs
In Exchange Mail Connector v2, the following parameters can affect email processing:
-
Original Received Mail Prefix
-
Attached Mail File Prefixes
-
Create a Separate Siemplify Alert per Attached Mail File?
To map the to
and from
fields of the processed emails,
the connector creates the following sets of fields:
-
Regular
to
andfrom
fields that contain email addresses in the following format:email@example
. -
to_raw
andfrom_raw
fields that contain only email address as a value in the following format:email@example
.
The Exchange Mail Connector v2requires the following parameters:
Parameter | Description |
---|---|
Product Field Name
|
Required
the name of the field where the product name is stored. The default value is |
Event Field Name
|
Required
The field name used to determine the event name (subtype). the default value is |
Mail Server Address
|
Required
A mail server IP address to connect to. When
connecting to Microsoft 365, set the server address to |
Verify SSL
|
Optional
If selected, the integration verifies that the SSL certificate for connecting to the Exchange server is valid. Not selected by default. |
Mail Address
|
Required
An email address for the mailbox to monitor. The default value is |
Use Domain for Authentication
|
Optional
If selected, the domain is used as a part of the authentication
credentials, such as Selected by default. |
Domain
|
Required
A domain value to use for authentication. |
Username
|
Required
The username for the mailbox to pull emails from,
like |
Password
|
Required
The password for the email mailbox to pull emails from. |
Unread Emails Only
|
Optional
If selected, cases are created only from unread emails. Selected by default. |
Mark Emails as Read
|
Optional
If selected, emails are marked as read after ingesting. Not selected by default. |
Offset Time In Days
|
Required
The number of days before the first connector iteration to retrieve the emails from. This parameter applies only once to the initial connector iteration after you enable the connector for the first time. The default value is 5. |
Max Emails Per Cycle
|
Required
The number of emails to retrieve in a single connector iteration. the default value is 10. |
Environment Field Name
|
Optional
The name of the field where the environment name is stored. If the
environment field isn't found, the environment is set to |
Environment Regex Pattern
|
Optional
A regular expression pattern to run on the value found in the Use the default value If the regular expression pattern is null or empty, or the environment
value is null, the final environment result is |
Headers to add to events
|
Optional
A comma-separated string that specifies which email headers to add to events. You can provided values as exact matches or set as a regular expression. |
Email Exclude Pattern
|
Optional
A regular expression to exclude specific emails from ingesting. This parameter works with both subject and body part of email. You can use this parameter to exclude mass broadcasted emails like news from ingesting. |
PythonProcessTimeout
|
Required
The timeout limit in seconds for the Python process running current script. The default value is 60 seconds. |
Folder to check for emails
|
Required
An email folder to search for the emails. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as This parameter is case-sensitive. The default value is |
Attach Original EML
|
Optional
If selected, the integration attaches the original email to the case as an EML file. Not selected by default. |
Fetch Backwards Time Interval (minutes)
|
Optional
An interval that the connector uses to retrieve events from the configured period in minutes before now. This parameter value is a timestamp of the last connector iteration. Adjust this value accordingly to the environment, for example, 60 minutes or less. The default value is 0. |
Proxy Server Address
|
Optional
An address of the proxy server to use. |
Proxy Username
|
Optional
A proxy username to authenticate with. |
Proxy Password
|
Optional
A proxy password to authenticate with. |
Extract urls from HTML email part?
|
Optional
If selected, the connector attempts to extract URLs from the HTML part of the email. This parameter lets connector extract complex URLs, but not the URLs from the plain text part of email. Extracted URLs are
available in the Not selected by default. |
Disable Overflow
|
Optional
If selected, the connector ignores the overflow mechanism. Not selected by default. |
Original Received Mail Prefix
|
Optional
A prefix to add to the extracted event keys, for example, to , from , or subject from the original email received in the monitored mailbox. The default value is |
Attached Mail File Prefix
|
Optional
A prefix to add to the extracted event keys, for example, to , from , or subject from the attached email file received in the monitored mailbox. The default
value is |
Create a Separate Siemplify Alert per Attached Mail File?
|
Optional
If selected, the connector creates multiple alerts, with one alert for every attached email file. If you select this parameter, Google SecOps processes emails with multiple attached files and creates entities from attached files. Not selected by default. |
Case Name Template
|
Optional
A custom case name. When you configure this parameter, the connector adds a new key called custom_case_name to the Google SecOps event. You can provide placeholders in the following format: Example: For placeholders, the connector uses the first Google SecOps event. The connector processes only keys that contain the string value. |
Alert Name Template
|
Optional
A custom alert name. You can provide placeholders in the following format: Example: For placeholders, the connector uses the first Google SecOps event. Only keys containing the string value are handled. If you provide no value or an invalid template, the connector uses the default alert name. |
Email Padding Period (minutes)
|
Optional
A period for the connector to retrieve emails before the latest timestamp. |
URL Regex
|
Required
The regular expression connector used to parse URLs from the processed emails. |
Connector rules
-
The Exchange Mail Connector v2supports proxy.
-
The Exchange Mail Connector v2doesn't support the blocklist rule.
-
The Exchange integration uses the dynamic list section for defining regular expressions to enable the following:
- Parse email content.
- Add specific fields based on the regular expression matches to the email event.
Exchange Mail Connector v2 with OAuth Authentication
Use the Exchange Mail Connector v2 with OAuthto monitor specific mailboxes on Microsoft 365 mail servers that require OAuth authentication. You can use the Get Authorization and Generate Token actions to obtain refresh token required for the connector configuration.
To run the Exchange Mail Connector v2 with OAuth, configure the integration to support OAuth authentication.
Work with Alert Name Template and Case Name Template
The Alert Name Template
and Case Name Template
parameters enable you to
overwrite the way alert and case name is created.
The example of a Google SecOps event is as follows:
{
"event"
:
{
"type"
:
"Phishing"
"name"
:
"Example Event"
,
"id"
:
"1"
}
}
To create a custom name for a Google SecOps alert, use the following template:
[
EVENT_TYPE
]
-
[
EVENT_NAME
]
For example, to create a Google SecOps alert named Phishing – Example Event, the template is as follows:
[
Phishi
n
g
]
-
[
Example
Eve
nt
]
Connector inputs
In Exchange Mail Connector v2 with OAuth, the following parameters can affect email processing:
-
Original Received Mail Prefix
-
Attached Mail File Prefixes
-
Create a Separate Siemplify Alert per Attached Mail File?
To map the to
and from
fields of the processed emails,
the connector creates two following sets of fields:
-
Regular
to
andfrom
fields that contain email addresses, such asemail@example
. -
to_raw
andfrom_raw
fields that contain only email address as a value, such asemail@example
.
The Exchange Mail Connector v2 with OAuthrequires the following parameters:
Parameter | Description |
---|---|
Product Field Name
|
Required
The name of the field where the product name is stored. The default value is |
Event Field Name
|
Required
The field name used to determine the event name (subtype). The default value is |
Mail Server Address
|
Required
A mail server IP address to connect to. When
connecting to Microsoft 365, set the server address to |
Mail Address
|
Required
A mail address to use for the connector. |
Client ID
|
Required
For Microsoft 365 OAuth authentication, an application (client) ID of the Microsoft Entra application that you used for the integration. |
Client Secret
|
Required
For Microsoft 365 OAuth authentication, the client secret that you provided for the authentication flow. |
Tenant (Directory) ID
|
Required
For Microsoft 365 OAuth authentication, the tenant (directory) ID of the Microsoft Entra application that you used for the integration. |
Refresh Token
|
Required
For Microsoft 365 OAuth authentication, the refresh token obtained after generating a token . |
Verify SSL
|
Optional
If selected, the integration verifies that the SSL certificate for connecting to the Exchange server is valid. Not selected by default. |
Unread Emails Only
|
Optional
If selected, the integration creates cases only from unread emails. Not selected by default. |
Mark Emails as Read
|
Optional
If selected, the connector marks ingested emails as read. Not selected by default. |
Offset Time In Days
|
Required
The number of days before the first connector iteration to retrieve the emails from. This parameter applies only once to the initial connector iteration after you enable the connector for the first time. The default value is 5 days. |
Max Emails Per Cycle
|
Required
The number of emails to retrieve in a single connector iteration. The default value is 10 emails. |
Environment Field Name
|
Optional
The name of the field where the environment name is stored. If the
environment field isn't found, the environment is set to |
Environment Regex Pattern
|
Optional
A regular expression pattern to run on the value found in the Use the default value If the regular expression pattern is null or empty, or the environment
value is null, the final environment result is |
Headers to add to events
|
Optional
A comma-separated string that specifies which email headers to add to events. You can provided values as exact matches or set as a regular expression. |
Email Exclude Pattern
|
Optional
A regular expression to exclude specific emails from ingesting. This parameter works with both subject and body part of email. You can use this parameter to exclude mass broadcasted emails like news from ingesting. |
PythonProcessTimeout
|
Required
The timeout limit in seconds for the Python process running current script. The default value is 60. |
Folder to check for emails
|
Required
An email folder to search for the emails. This parameter accepts a comma-separated list of folders. The Exchange integration uses
backslashes as separators to specify subfolders, such as This parameter is case-sensitive. The default value is |
Attach Original EML
|
Optional
If selected, the original email is attached to the case as an EML file. Not selected by default. |
Fetch Backwards Time Interval (minutes)
|
Optional
An interval that the connector uses to retrieve events from the configured period in minutes before now. This parameter value is a timestamp of the last connector iteration. Adjust this value accordingly to the environment, for example, 60 minutes or less. The default value is 0. |
Proxy Server Address
|
Optional
An address of the proxy server to use. |
Proxy Username
|
Optional
A proxy username to authenticate with. |
Proxy Password
|
Optional
A proxy password to authenticate with. |
Extract urls from HTML email part?
|
Optional
If selected, the connector attempts to extract URLs from the HTML part of the email. This parameter lets connector extract complex URLs, but not the URLs from the plain text part of email. Extracted URLs are
available in the Not selected by default. |
Disable Overflow
|
Optional
If selected, the connector ignores the overflow mechanism. Not selected by default. |
Original Received Mail Prefix
|
Optional
A prefix to add to the extracted event keys, for example, to , from , or subject from the original email received in the monitored mailbox. The default value is |
Attached Mail File Prefix
|
Optional
A prefix to add to the extracted event keys, for example, to , from , or subject from the attached email file received in the monitored mailbox. The default
value is |
Create a Separate Siemplify Alert per Attached Mail File?
|
Optional
If selected, the connector creates multiple alerts, with one alert for every attached email file. If you select this parameter, Google SecOps processes emails with multiple attached files and creates entities from attached files. Not selected by default. |
Case Name Template
|
Optional
A custom case name. When you configure this parameter, the connector adds a new key called custom_case_name to the Google SecOps event. You can provide placeholders in the following format: Example: For placeholders, the connector uses the first Google SecOps event. The connector processes only keys that contain the string value. |
Alert Name Template
|
Optional
Parameter to set a custom alert name. A custom alert name. You can provide placeholders in the following format: Example: For placeholders, the connector uses the first Google SecOps event. Only keys containing the string value are handled. If you provide no value or an invalid template, the connector uses the default alert name. |
Email Padding Period (minutes)
|
Optional
A period for the connector to retrieve emails before the latest timestamp. |
Jobs
Before configuring jobs for the Exchange integration, make sure that your Google SecOps platform version supports them.
Refresh Token Renewal Job
The goal of the Refresh Token Renewal Jobis to periodically update the refresh token used in the integration.
By default, the refresh token expires every 90 days. It is recommended to run this job every 7 or 14 days to make sure that the refresh token is up to date.
Job inputs
The Refresh Token Renewal Jobrequires the following parameters:
Parameter | Description |
---|---|
Integration Environments
|
Optional
The integration environments which the job updates the refresh tokens for. This parameter accepts multiple values as a comma-separated
string. Enclose individual values in quotation marks ( |
Connector Names
|
Optional
The connector names which the job updates the refresh tokens for. This parameter accepts multiple values as a comma-separated
string. Enclose individual values in quotation marks ( |
Need more help? Get answers from Community members and Google SecOps professionals.