Summary
Send email with cc, bcc, and attachment options
Description
Email a message with cc, bcc, and attachment options.
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| from |
string |
yes |
Email address of the sender. |
| to |
array |
yes |
List of email addresses (recipients). |
| subject |
string |
yes |
Subject of email. |
| body |
string |
yes |
Body of email. |
| displayName |
string |
no |
The display name of the sender; default value is 'IAP'. |
| cc |
array |
no |
List of email addresses (recipients) for the Cc: field. |
| bcc |
array |
no |
List of email addresses (recipients) for the Bcc: field. |
| attachments |
array |
no |
List of attachments. |
Copied to Clipboard
{
"from": "example@itential.com",
"to": [
"example@itential.com",
"secondRecipient@itential.com"
],
"subject": "Successful Device Deployment",
"body": "Your device successfully deployed with the following details...",
"displayName": "IAP",
"cc": [
"example@itential.com"
],
"bcc": [
"example@itential.com"
],
"attachments": [
{
"name": "Attachment.txt",
"content": "Text inside of attached file..."
},
{
"name": "Attachment.txt",
"content": "Text inside of attached file..."
},
{
"name": "Attachment.txt",
"content": "Text inside of attached file..."
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"from": {
"title": "from",
"type": "string",
"examples": [
"example@itential.com"
],
"minLength": 1
},
"to": {
"title": "to",
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"example@itential.com",
"secondRecipient@itential.com"
]
]
},
"subject": {
"title": "subject",
"type": "string",
"examples": [
"Successful Device Deployment"
]
},
"body": {
"title": "body",
"type": "string",
"examples": [
"Your device successfully deployed with the following details..."
]
},
"displayName": {
"title": "displayName",
"type": "string",
"examples": [
"IAP"
]
},
"cc": {
"title": "cc",
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"example@itential.com"
]
]
},
"bcc": {
"title": "bcc",
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"example@itential.com"
]
]
},
"attachments": {
"title": "attachments",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the attachment file.",
"examples": [
"Attachment.txt"
]
},
"content": {
"type": "string",
"description": "The contents of the attachment file.",
"examples": [
"Text inside of attached file..."
]
}
}
}
}
},
"required": [
"from",
"to",
"subject",
"body"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Response from email notify. |
Copied to Clipboard
{
"accepted": [
"example@itential.com",
"example@itential.com",
"example@itential.com",
"example@itential.com",
"example@itential.com"
],
"rejected": [
"example@itential.com",
"example@itential.com",
"example@itential.com",
"example@itential.com",
"example@itential.com"
]
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"accepted": {
"type": "array",
"items": {
"type": "string",
"examples": [
"example@itential.com"
]
}
},
"rejected": {
"type": "array",
"items": {
"type": "string",
"examples": [
"example@itential.com"
]
}
}
}
}
