addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"One inbound email."
addedOutput schema / properties / attachments
Added value: +{
+ "description": "Files on the email; read one with getEmailAttachment.",
+ "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 / auth
Added value: +{
+ "description": "full only: SPF, DKIM and DMARC results; their keys vary by message.",
+ "type": "object"
+}
addedOutput schema / properties / body_chars
Added value: +{
+ "description": "Length of the whole body, in characters. Not with full.",
+ "type": "integer"
+}
addedOutput schema / properties / body_html
Added value: +{
+ "description": "full only: the HTML body.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / body_incomplete
Added value: +{
+ "description": "True when the HTML was too deep to read in full. Not with full.",
+ "type": "boolean"
+}
addedOutput schema / properties / body_next_offset
Added value: +{
+ "description": "Pass as offset to read on; null at the end. Not with full.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / body_offset
Added value: +{
+ "description": "Where this part of the body starts. Not with full.",
+ "type": "integer"
+}
addedOutput schema / properties / body_source
Added value: +{
+ "description": "html, text 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 is left out and links are [n] markers, unless full. Null when there is none.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "One inbound email.",
- "properties": {
- "attachments": {
- "description": "Read one with getEmailAttachment.",
- "items": {
- "properties": {
- "content_type": {
- "type": [
- "string",
- "null"
- ]
- },
- "filename": {
- "type": [
- "string",
- "null"
- ]
- },
- "part_index": {
- "description": "Pass to getEmailAttachment.",
- "type": [
- "number",
- "string",
- "null"
- ]
- },
- "size_bytes": {
- "type": [
- "number",
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "auth": {
- "description": "Full only: SPF, DKIM, DMARC results.",
- "type": "object"
- },
- "body_chars": {
- "description": "Whole body length.",
- "type": [
- "number",
- "string"
- ]
- },
- "body_html": {
- "description": "HTML body, full only.",
- "type": [
- "string",
- "null"
- ]
- },
- "body_incomplete": {
- "description": "HTML too deep to read in full.",
- "type": "boolean"
- },
- "body_next_offset": {
- "description": "Next offset; null at the end.",
- "type": [
- "number",
- "string",
- "null"
- ]
- },
- "body_offset": {
- "description": "Where this page starts.",
- "type": [
- "number",
- "string"
- ]
- },
- "body_source": {
- "description": "html, text or none: what body_text came from.",
- "type": "string"
- },
- "body_text": {
- "description": "No quoted history unless full.",
- "type": [
- "string",
- "null"
- ]
- },
- "from": {
- "description": "From header.",
- "type": "string"
- },
- "from_email": {
- "description": "Sender address.",
- "type": "string"
- },
- "id": {
- "description": "Email id.",
- "type": "string"
- },
- "image_count": {
- "description": "Images in the body.",
- "type": [
- "number",
- "string"
- ]
- },
- "link_count": {
- "description": "Links in the body.",
- "type": [
- "number",
- "string"
- ]
- },
- "links": {
- "description": "Targets the links argument asked for.",
- "items": {
- "properties": {
- "n": {
- "description": "The [n] marker in body_text.",
- "type": [
- "number",
- "string"
- ]
- },
- "url": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "parse_status": {
- "description": "pending or processing: read again shortly.",
- "type": [
- "string",
- "null"
- ]
- },
- "parsed": {
- "description": "Full only: the parsed message.",
- "type": "object"
- },
- "preheader": {
- "description": "Preview text; not with full.",
- "type": [
- "string",
- "null"
- ]
- },
- "quoted_chars_removed": {
- "description": "Quoted text left out.",
- "type": [
- "number",
- "string"
- ]
- },
- "received_at": {
- "description": "Arrival time.",
- "type": "string"
- },
- "replies": {
- "description": "Full only: your replies.",
- "items": {
- "properties": {
- "created_at": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "subject": {
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "status": {
- "description": "Processing stage.",
- "type": "string"
- },
- "subject": {
- "description": "Subject line.",
- "type": [
- "string",
- "null"
- ]
- },
- "thread_id": {
- "description": "Conversation it belongs to.",
- "type": [
- "string",
- "null"
- ]
- },
- "to": {
- "description": "Recipient.",
- "type": "string"
- },
- "to_email": {
- "description": "Recipient address.",
- "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 / from
Added value: +{
+ "description": "Sender, as the From header shows it.",
+ "type": "string"
+}
addedOutput schema / properties / from_email
Added value: +{
+ "description": "full only: sender address.",
+ "type": "string"
+}
addedOutput schema / properties / id
Added value: +{
+ "description": "Email id.",
+ "type": "string"
+}
addedOutput schema / properties / image_count
Added value: +{
+ "description": "Images in the body. Not with full.",
+ "type": "integer"
+}
addedOutput schema / properties / link_count
Added value: +{
+ "description": "Links in the body. Not with full.",
+ "type": "integer"
+}
addedOutput schema / properties / links
Added value: +{
+ "description": "With the links argument: the link targets asked for.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "n": {
+ "description": "The [n] marker in body_text.",
+ "type": "integer"
+ },
+ "url": {
+ "description": "Where the link goes.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "n",
+ "url"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / parse_status
Added value: +{
+ "description": "Parse stage, when known. pending or processing: read again shortly; failed: the body may be incomplete.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / parsed
Added value: +{
+ "description": "full only: the parsed message as stored; its keys vary by message.",
+ "type": "object"
+}
addedOutput schema / properties / preheader
Added value: +{
+ "description": "Inbox preview text. Not with full.",
+ "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 / received_at
Added value: +{
+ "description": "Arrival time.",
+ "type": "string"
+}
addedOutput schema / properties / replies
Added value: +{
+ "description": "full only: replies you sent to it.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "created_at": {
+ "description": "When it was sent.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Sent email id, for getSentEmail.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Delivery state.",
+ "type": "string"
+ },
+ "subject": {
+ "description": "Subject line.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "to_address": {
+ "description": "Recipient address.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "status",
+ "to_address",
+ "subject",
+ "created_at"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
changedOutput schema / properties / status / description
Previous value: -"HTTP status; 2xx on success."New value: +"full only: processing stage."
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 / thread_id
Added value: +{
+ "description": "Conversation id, for getConversation; null when it is in none.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / to
Added value: +{
+ "description": "Recipient address.",
+ "type": "string"
+}
addedOutput schema / properties / to_email
Added value: +{
+ "description": "full only: 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",
+ "received_at",
+ "from",
+ "to",
+ "subject",
+ "body_text",
+ "attachments"
+]