preview_send
Show the resolved sender, recipients, subject and attachments without sending mail.
Show the resolved sender, recipients, subject and attachments without sending mail.
Permissions
Required capabilities: mail.send.
Inputs
| Name | Required | Type | Details |
|---|---|---|---|
draftId | No | string or null | Minimum length: 1. Maximum length: 512. |
accountId | No | string or null | Account to operate on. Optional when exactly one account is connected. Minimum length: 1. Maximum length: 512. |
from | No | string or null | Connected address or an available send-as address Format: email. |
to | No | array of string or null | Recipients, each "Name a@x.com" or "a@x.com" |
cc | No | array of string or null | Recipients, each "Name a@x.com" or "a@x.com" |
bcc | No | array of string or null | Recipients, each "Name a@x.com" or "a@x.com" |
subject | No | string or null | Defaults to "Re: ..." when replying Maximum length: 998. |
bodyText | No | string or null | Plain-text body. Line breaks appear in the sent email. Keep each prose paragraph on one continuous line and separate paragraphs with blank lines. |
bodyHtml | No | string or null | HTML body |
replyToMessageId | No | string or null | Message being replied to; threads correctly, quotes it below the body and computes recipients if "to" is omitted. To continue a conversation, reply to the first message get_thread returns with order newest Minimum length: 1. Maximum length: 512. |
replyAll | No | boolean or null | With replyToMessageId: reply to all original recipients |
timeZone | No | string or null | With replyToMessageId: IANA time zone, such as America/New_York, for the date above the quoted message. Defaults to the time zone setting. Minimum length: 1. Maximum length: 100. |
quoteOriginal | No | boolean or null | With replyToMessageId: set to false to leave the original message out of the reply. Defaults to true. |
attachments | No | array of object or null | None |
{
"type": "object",
"properties": {
"draftId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"accountId": {
"description": "Account to operate on. Optional when exactly one account is connected.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"from": {
"description": "Connected address or an available send-as address",
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
]
},
"to": {
"description": "Recipients, each \"Name <a@x.com>\" or \"a@x.com\"",
"anyOf": [
{
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"description": "Recipients, each \"Name <a@x.com>\" or \"a@x.com\""
},
{
"type": "null"
}
]
},
"cc": {
"description": "Recipients, each \"Name <a@x.com>\" or \"a@x.com\"",
"anyOf": [
{
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"description": "Recipients, each \"Name <a@x.com>\" or \"a@x.com\""
},
{
"type": "null"
}
]
},
"bcc": {
"description": "Recipients, each \"Name <a@x.com>\" or \"a@x.com\"",
"anyOf": [
{
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"description": "Recipients, each \"Name <a@x.com>\" or \"a@x.com\""
},
{
"type": "null"
}
]
},
"subject": {
"description": "Defaults to \"Re: ...\" when replying",
"anyOf": [
{
"type": "string",
"maxLength": 998
},
{
"type": "null"
}
]
},
"bodyText": {
"description": "Plain-text body. Line breaks appear in the sent email. Keep each prose paragraph on one continuous line and separate paragraphs with blank lines.",
"type": [
"string",
"null"
]
},
"bodyHtml": {
"description": "HTML body",
"type": [
"string",
"null"
]
},
"replyToMessageId": {
"description": "Message being replied to; threads correctly, quotes it below the body and computes recipients if \"to\" is omitted. To continue a conversation, reply to the first message get_thread returns with order newest",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"replyAll": {
"description": "With replyToMessageId: reply to all original recipients",
"type": [
"boolean",
"null"
]
},
"timeZone": {
"description": "With replyToMessageId: IANA time zone, such as America/New_York, for the date above the quoted message. Defaults to the time zone setting.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"quoteOriginal": {
"description": "With replyToMessageId: set to false to leave the original message out of the reply. Defaults to true.",
"type": [
"boolean",
"null"
]
},
"attachments": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"mimeType": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"content": {
"type": "string",
"description": "base64"
},
"contentId": {
"description": "Content-ID for an inline image, referenced from bodyHtml as cid:<contentId>",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"disposition": {
"description": "Defaults to attachment",
"type": "string",
"enum": [
"inline",
"attachment"
]
}
},
"required": [
"filename",
"mimeType",
"content"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Last updated