Cyware Email Service
App Vendor: Cyware
Connector Category: Cyware Product | Messaging
Connector Version: 1.5.0
API Version: 1.0.0
The Cyware Email Service app allows security teams to use the email services deployed in the client's infrastructure. The Cyware Email service app in Orchestrate allows you to perform the following actions.
Action Name | Description |
|---|---|
Send Email | This action sends emails using the SMTP protocol. |
Send Email in Rich Text Format | This action sends emails in rich text format using the SMTP protocol. This action is supported in Orchestrate from the release version v3.5.0 and later. |
Configuration Parameters
The following configuration parameters are required for the Cyware Email Services app to communicate with the Cyware Email Services enterprise application.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
SMTP Domain | Specify the SMTP domain for the Cyware Email Services endpoint. Example: smtp.system.com | Text | Required | |
SMTP Port | Specify the port number for the Cyware Email Services. Example: 587 | Integer | Required | |
Email ID/Access ID | Specify the Email ID/access ID for your SMTP account. Example: exampleuser@abc.com | Text | Optional | |
Password/Secret Key | Specify the password/secret key for the SMTP account. | Password | Optional | |
Sender Email ID | Enter the sender email ID. Example: johndoe@orgname.com | Text | Optional | |
Verify TLS | Choose your preference to verify TLS while making requests. It is recommended to set this option to yes. If no is passed, it may result in an incorrect establishment of the connection, potentially causing it to become broken. | Boolean | Optional | By default, verification is not enabled. |
Email Connection Anonymous | Select if the email connection is anonymous | Boolean | Optional | Allowed value: true, false Default value: true |
TLS | Select an option to use TLS | Boolean | Optional | Allowed value: true, false Default value: false |
Content of Certificate File | Enter the content of the certificate of the file for authentication. | Text | Optional |
Action: Send Email
This action sends an email to intended recipients using Cyware Email Service.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Sender Email ID | Specify the sender's email ID. Example johndoe@orgname.com | Text | Optional | |
Sender Name | Specify the sender's name. Example: John Doe | Text | Required | |
Subject | Enter the subject for the email. Example: Phishing Incident | Text | Required | |
Message Body | Enter the message for the email body. Example: Details about a phishing incident | Text | Optional | |
Recipient ID | Specify the list of recipients. You can add multiple values as a comma-separated list. Example: $LIST[john.doe@orgname.com, jane.smith@orgname.com] | Text | Required | |
CC | Specify the list of recipients who need to be CC'd for the email. You can add multiple values as a comma-separated list. Example: $LIST[eric.doe@orgname.com, jack.doe@orgname.com] | Text | Optional | |
Reply-To | Specify the Reply-To emails for recipients. You can add multiple values as a comma-separated list. Example: $LIST[eric.doe@orgname.com, jack.doe@orgname.com] | List | Optional | |
Attachments | Specify the attachment path for your file. Example: $LIST[/tmp/0a612-0d0b-4261-9b5e-2f49/incidentfile01.txt] | List | Optional | |
BCC | Specify the list of emails to be BCC'd. You can add multiple values as a comma-separated list. Example: $LIST[lewis@orgname.com, daniel@orgname.com] | Text | Optional |
Example Request
[
{
"sender_name":"John Doe",
"sender_email":"johndoe@orgname.com",
"email_message": "Details about a phishing incident",
"email_subject": "phishing incident",
"recipient_list":["jack.doe@orgname.com", "rick.doe@orgname.com"],
"bcc_list":["lewis@orgname.com", "daniel@orgname.com"]
}
]Action Response Parameters
Parameter | Description |
|---|---|
default | Returns a confirmation message after the email is sent. Example: OK!, Email has been sent to user successfully |
Action: Send Email in Rich Text Format
This action sends emails in rich text format using the SMTP protocol. This action is supported in Orchestrate from the release version v3.5.0 and later.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Sender Email ID | Enter the sender's email ID. Example: johndoe@orgname.com | Text | Optional | |
Sender Name | Enter the sender's name. Example: John Doe | Text | Required | |
Subject | Enter the email subject. Example: Phishing Incident | Text | Required | |
Message Body | Enter the message body in rich text format. Example: Details about a phishing incident | Rich Text | Optional | You can use variables in the message body to fetch data dynamically from playbook execution results. See Use Email Template in Playbook. |
Recipient ID | Enter the recipient email IDs in a comma-separated list. Example: $LIST[jack.doe@orgname.com, rick.doe@orgname.com] | Text | Required | |
CC | Enter the email IDs to be included in CC in a comma-separated list. Example: $LIST[eric.doe@orgname.com, jack.doe@orgname.com] | Text | Optional | |
Reply-To | Enter the reply-to email IDs in a comma-separated list. Example: $LIST[eric.doe@orgname.com, jack.doe@orgname.com] | List | Optional | |
Attachments | Enter the file attachment path. Example: $LIST[/tmp/0a612-0d0b-4261-9b5e-2f49/incidentfile01.txt] | List | Optional | |
BCC | Enter the email IDs to be included in BCC in a comma-separated list. Example: $LIST[lewis@orgname.com, daniel@orgname.com] | Text | Optional |
Example Request
[
{
"sender_name":"John Doe",
"sender_email":"johndoe@orgname.com",
"email_message": "Details about a phishing incident",
"email_subject": "phishing incident",
"recipient_list":["jack.doe@orgname.com", "rick.doe@orgname.com"],
"bcc_list":["lewis@orgname.com", "daniel@orgname.com"]
}
]