Send Email
LAST UPDATED: FEB 27, 2024
Sends out a system email with email recipients, subject and body.
Implementation | System |
Command Category | System Utility |
Tags | COMMUNICATION EMAIL |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
To Addresses | Optional | The email addresses of recipients, separated by “,”. |
|
Subject | Optional | Introductory line that contains a brief summary of the email's contents. |
|
Email Body | Optional | The main content of the email. |
|
Reply Mode | Optional | The mode to determine if this email requires a response or approval. |
|
Reply Due Time | Optional | The duration of time (in minutes) to wait for a reply. |
|
CC | Optional | cc, separated by “,”. |
|
BCC | Optional | bcc. |
|
File Source | Optional | Incident Attachment: Manually uploaded file from Incident Workspace | Playbook File: Output from another Task | Artifact File: Ingested Artifact in an Event |
|
File Id | Optional | Choose file path according to file source. |
|
Output
Remote Command API
The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.
Request
POST
https:/{base_url}/{api_namespace}/api/Command/SendEmail
Headers
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"Username": "<Username here>",
"Site": "<Site here>",
"CommandParams": {
"To Addresses": "<To Addresses here>",
"Subject": "<Subject here>",
"Email Body": "<Email Body here>",
"Reply Mode": "<Reply Mode here>",
"Reply Due Time": "<Reply Due Time here>",
"CC": "<CC here>",
"BCC": "<BCC here>",
"File Source": "<File Source here>",
"File Id": "<File Id here>"
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
To Addresses |
| Optional | The email addresses of recipients, separated by “,”. |
Subject |
| Optional | Introductory line that contains a brief summary of the email's contents. |
Email Body |
| Optional | The main content of the email. |
Reply Mode |
| Optional | The mode to determine if this email requires a response or approval. |
Reply Due Time |
| Optional | The duration of time (in minutes) to wait for a reply. |
CC |
| Optional | cc, separated by “,”. |
BCC |
| Optional | bcc. |
File Source |
| Optional | Incident Attachment: Manually uploaded file from Incident Workspace | Playbook File: Output from another Task | Artifact File: Ingested Artifact in an Event |
File Id |
| Optional | Choose file path according to file source. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"To Addresses": "user01@example.com, user02@example.com",
"Subject": "This is a test email",
"Email Body": "
Hi,
This is a test email
regards
",
"Reply Mode": "Require Approval",
"Reply Due Time": 100,
"CC": "lling@d3security.com",
"BCC": "mmeng@d3security.com",
"File Source": "IR Attachment",
"File Id": 1
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
keyFields |
| The key fields from the API request. |
returnData |
| The return data from the API request. |
contextData |
| The context data from the API request. |
Sample Response
{
"error": "",
"keyFields": {
"SentTime": "2020-05-27 20:16:01 UTC",
"DueTime": "2020-05-27 21:56:01 UTC",
"ReplyMode": "RequireApproval",
"SentCount": 2,
"State": "Sent",
"ToAddresses": [
"user01@example.com",
"user02@example.com"
]
},
"returnData": "Succeed",
"contextData": {
"sentTime": "2020-05-27 20:08:14 UTC",
"dueTime": "2020-05-27 21:48:14 UTC",
"replyMode": "RequireApproval",
"sent_count": 2,
"state": "Sent",
"to": [
{
"email": "user01@example.com",
"sent": true,
"error": ""
},
{
"email": "user02@example.com",
"sent": true,
"error": ""
}
]
}
}