changedInput schema / properties / full / description
Previous value: -"Return the stored record, with the HTML body, quoted history and signing details, instead of the compact view for reading."New value: +"Return the stored record, with the HTML body and quoted history, instead of the compact view for reading."
addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"One sent email."
addedOutput schema / properties / attachments
Added value: +{
+ "description": "Files sent with it; read one with getEmailAttachment and source sent.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "content_type": {
+ "description": "Media type, such as application/pdf.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "filename": {
+ "description": "File name; null when the email gave none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "part_index": {
+ "description": "Pass to getEmailAttachment to read it.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "size_bytes": {
+ "description": "Size in bytes.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "filename",
+ "content_type",
+ "size_bytes",
+ "part_index"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / attachments_complete
Added value: +{
+ "description": "False when some attachments may be missing from the list.",
+ "type": "boolean"
+}
addedOutput schema / properties / bcc
Added value: +{
+ "description": "Blind-copied addresses, when there were any.",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / body_html
Added value: +{
+ "description": "full only: the HTML body.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / body_source
Added value: +{
+ "description": "text, html or none: what body_text was made from. Not with full.",
+ "type": "string"
+}
addedOutput schema / properties / body_text
Added value: +{
+ "description": "The body as text, quoted history left out unless full; null when there is none.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / canceled_at
Added value: +{
+ "description": "When a scheduled send was canceled.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / cc
Added value: +{
+ "description": "Copied addresses, when there were any.",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / created_at
Added value: +{
+ "description": "When it was sent or queued.",
+ "type": "string"
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "One sent email.",
- "properties": {
- "attachments": {
- "description": "Each: filename, content_type, size_bytes, part_index.",
- "type": "array"
- },
- "attachments_complete": {
- "description": "False if some may be missing.",
- "type": "boolean"
- },
- "bcc": {
- "description": "Blind-copied addresses.",
- "type": [
- "array",
- "null"
- ]
- },
- "body_html": {
- "description": "HTML body, full only.",
- "type": [
- "string",
- "null"
- ]
- },
- "body_source": {
- "description": "Body the text came from.",
- "type": "string"
- },
- "body_text": {
- "description": "No quoted history unless full.",
- "type": [
- "string",
- "null"
- ]
- },
- "canceled_at": {
- "description": "When canceled.",
- "type": [
- "string",
- "null"
- ]
- },
- "cc": {
- "description": "Copied addresses.",
- "type": [
- "array",
- "null"
- ]
- },
- "created_at": {
- "description": "When it was sent or queued.",
- "type": "string"
- },
- "error_code": {
- "description": "Why not delivered.",
- "type": [
- "string",
- "null"
- ]
- },
- "error_message": {
- "description": "Detail of the error.",
- "type": [
- "string",
- "null"
- ]
- },
- "from": {
- "description": "Sender.",
- "type": "string"
- },
- "from_address": {
- "description": "Envelope sender.",
- "type": "string"
- },
- "gates": {
- "description": "Rules that refused it: name, reason.",
- "type": [
- "array",
- "null"
- ]
- },
- "id": {
- "description": "Sent email id, for getSentEmail.",
- "type": "string"
- },
- "in_reply_to_email_id": {
- "description": "Inbound email it answers.",
- "type": [
- "string",
- "null"
- ]
- },
- "quoted_chars_removed": {
- "description": "Quoted text left out.",
- "type": [
- "number",
- "string"
- ]
- },
- "reply_to": {
- "description": "Reply-To addresses.",
- "type": [
- "array",
- "null"
- ]
- },
- "request_id": {
- "description": "For support.",
- "type": [
- "string",
- "null"
- ]
- },
- "scheduled_at": {
- "description": "When it goes out.",
- "type": [
- "string",
- "null"
- ]
- },
- "smtp_response_code": {
- "description": "Remote server code.",
- "type": [
- "number",
- "string",
- "null"
- ]
- },
- "smtp_response_text": {
- "description": "Remote server reply.",
- "type": [
- "string",
- "null"
- ]
- },
- "snippet": {
- "description": "Start of the body.",
- "type": [
- "string",
- "null"
- ]
- },
- "status": {
- "description": "Delivery state, such as delivered or bounced.",
- "type": "string"
- },
- "subject": {
- "description": "Subject line.",
- "type": [
- "string",
- "null"
- ]
- },
- "tags": {
- "description": "Your labels: name, value.",
- "type": [
- "array",
- "null"
- ]
- },
- "thread_id": {
- "description": "Conversation it belongs to.",
- "type": [
- "string",
- "null"
- ]
- },
- "to": {
- "description": "Recipients.",
- "type": "string"
- },
- "to_address": {
- "description": "Envelope recipient.",
- "type": "string"
- }
- },
- "type": [
- "object",
- "null"
- ]
- },
- "error": {
- "description": "Why the call was refused; absent on success.",
- "properties": {
- "code": {
- "description": "Error code to branch on.",
- "type": "string"
- },
- "message": {
- "description": "What went wrong, in words.",
- "type": "string"
- }
- },
- "type": [
- "object",
- "null"
- ]
- },
- "success": {
- "description": "True when data holds the result.",
- "type": "boolean"
- }
- },
- "type": "object"
-}
addedOutput schema / properties / error_code
Added value: +{
+ "description": "Set when it was not delivered: why, as a code.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / error_message
Added value: +{
+ "description": "Set when it was not delivered: why, in words.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / from
Added value: +{
+ "description": "Sender, as the From header shows it.",
+ "type": "string"
+}
addedOutput schema / properties / from_address
Added value: +{
+ "description": "full only: envelope sender address.",
+ "type": "string"
+}
addedOutput schema / properties / gates
Added value: +{
+ "description": "Set when rules refused it: which ones.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "description": "Why, in words, when given.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Rule that refused it, such as send_to_known_addresses.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why, as a code, when given.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / id
Added value: +{
+ "description": "Sent email id, for getSentEmail.",
+ "type": "string"
+}
addedOutput schema / properties / in_reply_to_email_id
Added value: +{
+ "description": "Set when it answers an inbound email: its id, for getEmail.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / quoted_chars_removed
Added value: +{
+ "description": "Characters of quoted history left out. Not with full.",
+ "type": "integer"
+}
addedOutput schema / properties / reply_to
Added value: +{
+ "description": "Reply-To addresses, when there were any.",
+ "items": {
+ "type": "string"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / request_id
Added value: +{
+ "description": "full only: id of the send request, for support.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / scheduled_at
Added value: +{
+ "description": "When a scheduled send goes out.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / smtp_response_code
Added value: +{
+ "description": "Remote server reply code, such as 550. Compact rows leave it out once delivered.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / smtp_response_text
Added value: +{
+ "description": "Remote server reply text. Compact rows leave it out once delivered.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
changedOutput schema / properties / status / description
Previous value: -"HTTP status; 2xx on success."New value: +"queued, submitted_to_agent, delivered, bounced, deferred, wait_timeout, gate_denied, agent_failed, scheduled, canceled or unknown."
changedOutput schema / properties / status / type
Previous value: -"number"New value: +"string"
addedOutput schema / properties / subject
Added value: +{
+ "description": "Subject line.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / tags
Added value: +{
+ "description": "Your labels on the send, when it has any.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "Label name.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Label value.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+}
addedOutput schema / properties / thread_id
Added value: +{
+ "description": "Conversation id; null when it is in none.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / to
Added value: +{
+ "description": "Recipients, as the To header shows them.",
+ "type": "string"
+}
addedOutput schema / properties / to_address
Added value: +{
+ "description": "full only: envelope recipient address.",
+ "type": "string"
+}
removedOutput schema / properties / tool
Removed value: -{
- "description": "Tool that answered.",
- "type": "string"
-}
changedOutput schema / required
Previous value: -[
- "tool",
- "status",
- "data"
-]New value: +[
+ "id",
+ "thread_id",
+ "created_at",
+ "status",
+ "from",
+ "to",
+ "subject",
+ "body_text",
+ "attachments"
+]