Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Email ask user add using argument #27401

Merged
merged 5 commits into from
Jun 14, 2023
Merged

Email ask user add using argument #27401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
664faea
Added the usingSender argument to enable using only one instance to s…
amshamah419 Jun 13, 2023
3128d36
Release Notes, Metadata
amshamah419 Jun 13, 2023
01ca75f
Merge branch 'master' into email-ask-user-using
amshamah419 Jun 13, 2023
68ada91
RM param, add generic fix
amshamah419 Jun 13, 2023
7a00e8d
Merge remote-tracking branch 'origin/email-ask-user-using' into email…
amshamah419 Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions Packs/CommonScripts/ReleaseNotes/1_11_86.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

#### Scripts

##### EmailAskUser

- Fixed an issue where additional arguments were not passed on to the *send-mail* command.
9 changes: 8 additions & 1 deletion Packs/CommonScripts/Scripts/EmailAskUser/EmailAskUser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,14 @@ if (addresses.length > 0) {
emailArgs.bcc = args.bcc;
}

return executeCommand('send-mail', emailArgs);
// Add additional fields from args to emailArgs
for (const key in args) {
if (args.hasOwnProperty(key) && !emailArgs.hasOwnProperty(key)) {
emailArgs[key] = args[key];
}
}

return executeCommand('send-mail', emailArgs);

} else {
return {Type: entryTypes.error, ContentsFormat: formats.text, Contents: 'No email address found'};
Expand Down
52 changes: 26 additions & 26 deletions Packs/CommonScripts/Scripts/EmailAskUser/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Asks a user a question via email and process the reply directly into the investi

Cortex XSOAR can use email responses within the system, e.g. when an external user's approval is required. To do this, you will create an email template with multiple choice options (e.g. Reply "Yes" if you approve and "No" if you do not).

**Before starting you will need to configure an integration capable for sending and receiving emails, such as: Mail Listener v2 and Mail Sender (New), GMail, EWS O365, O365 Outlook Mail Single User. The instance that will receive the response must be set to fetch incidents.**
**Before starting, you will need to configure an integration capable for sending and receiving emails, such as: Mail Listener v2 and Mail Sender (New), GMail, EWS O365, O365 Outlook Mail Single User. The instance that will receive the response must be set to fetch incidents.**

The user who receives the mail will respond accordingly and when an answer is received, it will trigger a task to handle the response.
This is a two step task. The first, is to send an email asking the user for information. The second step, is to receive the answer and trigger a process of handling it in Cortex XSOAR.
This is a two-step task. The first, is to send an email asking the user for information. The second step, is to receive the answer and trigger a process of handling it in Cortex XSOAR.

The outgoing email contains a token that will be used when the user responds to the email. According to the token, the response will be directed to the relevant incident.

Expand Down Expand Up @@ -52,34 +52,34 @@ The tag you choose (in this case "Await") can be used in lieu of the task id in
## Script Data
---

| **Name** | **Description** |
| --- | --- |
| Script Type | javascript |
| Tags | email |
| Cortex XSOAR Version | 4.0.0+ |
| **Name** | **Description** |
|----------------------|-----------------|
| Script Type | javascript |
| Tags | email |
| Cortex XSOAR Version | 4.0.0+ |

## Inputs
---

| **Argument Name** | **Description** |
| --- | --- |
| email | The email of the user to ask. |
| subject | The subject for the email. |
| message | The message sent to the user you are going to ask. |
| option1 | The first option for a user reply.The default is "yes". |
| option2 | The second option for the user reply. The default is "no". |
| additionalOptions | The comma delimited list of additional options if there are more than 2. |
| task | Which task the reply will close. If none, then no playbook tasks will be closed. |
| roles | Send mail to all users of these roles (a CSV list). |
| attachIds | The attachments. |
| bodyType | The type of email body to send. Can be, "text" or "HTML". |
| replyAddress | The reply address for the html links. |
| replyEntriesTag | The tag to add on email reply entries. |
| persistent | Whether to use one-time entitlement or a persistent one. |
| retries | How many times to try and create an entitlement in case of a failure. |
| cc | The CC email address. |
| bcc | The BCC email address. |
| playbookTaskID | The subplaybook ID, use `${currentPlaybookID}` to get from the context, `all` to complete all tasks from all plabooks |
| **Argument Name** | **Description** |
|-------------------|------------------------------------------------------------------------------------------------------------------------|
| email | The email of the user to ask. |
| subject | The subject for the email. |
| message | The message sent to the user you are going to ask. |
| option1 | The first option for a user reply.The default is "yes". |
| option2 | The second option for the user reply. The default is "no". |
| additionalOptions | The comma delimited list of additional options if there are more than 2. |
| task | Which task the reply will close. If none, then no playbook tasks will be closed. |
| roles | Send mail to all users of these roles (a CSV list). |
| attachIds | The attachments. |
| bodyType | The type of email body to send. Can be, "text" or "HTML". |
| replyAddress | The reply address for the html links. |
| replyEntriesTag | The tag to add on email reply entries. |
| persistent | Whether to use one-time entitlement or a persistent one. |
| retries | How many times to try and create an entitlement in case of a failure. |
| cc | The CC email address. |
| bcc | The BCC email address. |
| playbookTaskID | The subplaybook ID, use `${currentPlaybookID}` to get from the context, `all` to complete all tasks from all plabooks. |

## Outputs
---
Expand Down
2 changes: 1 addition & 1 deletion Packs/CommonScripts/pack_metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Common Scripts",
"description": "Frequently used scripts pack.",
"support": "xsoar",
"currentVersion": "1.11.85",
"currentVersion": "1.11.86",
"author": "Cortex XSOAR",
"url": "https://www.paloaltonetworks.com/cortex",
"email": "",
Expand Down