changedInput schema / properties / cursor / description
Previous value: -"Where the next page starts: the meta.cursor of the page before."New value: +"Where the next page starts: the cursor of the page before."
changedInput schema / properties / full / description
Previous value: -"Return the stored record, with delivery, webhook and classification state, instead of the compact view for reading."New value: +"Return the stored record, with envelope addresses, message id and spam score, instead of the compact view for reading."
changedInput schema / properties / limit / description
Previous value: -"How many matches this call returns; follow meta.cursor for more."New value: +"How many matches this call returns; follow cursor for more."
addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"Inbound emails matching the search, and the cursor for the next page."
addedOutput schema / properties / cursor
Added value: +{
+ "description": "Pass as cursor for the next page; null at the end.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "Inbound emails matching the search.",
- "items": {
- "description": "One match; full adds stored fields.",
- "properties": {
- "attachment_count": {
- "description": "Attachments; left out when none.",
- "type": [
- "number",
- "string"
- ]
- },
- "automated": {
- "description": "Sent by a machine.",
- "type": "boolean"
- },
- "awaiting": {
- "description": "Whose turn: you or them.",
- "type": "string"
- },
- "created_at": {
- "description": "Stored time.",
- "type": "string"
- },
- "direction": {
- "description": "Always inbound.",
- "type": "string"
- },
- "from": {
- "description": "From header.",
- "type": "string"
- },
- "from_email": {
- "description": "Sender address.",
- "type": "string"
- },
- "highlights": {
- "description": "Matched fragments: subject, body.",
- "type": "object"
- },
- "id": {
- "description": "Email id, for getEmail.",
- "type": "string"
- },
- "received_at": {
- "description": "Arrival time.",
- "type": "string"
- },
- "recipient": {
- "description": "Envelope recipient.",
- "type": "string"
- },
- "reply_count": {
- "description": "Replies you sent to it.",
- "type": [
- "number",
- "string"
- ]
- },
- "score": {
- "description": "Relevance; full only.",
- "type": [
- "number",
- "string"
- ]
- },
- "sender": {
- "description": "Envelope sender.",
- "type": "string"
- },
- "snippet": {
- "description": "Start of the body.",
- "type": [
- "string",
- "null"
- ]
- },
- "spam_score": {
- "description": "Higher is spammier.",
- "type": [
- "number",
- "string",
- "null"
- ]
- },
- "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"
- },
- "type": [
- "array",
- "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"
- ]
- },
- "facets": {
- "description": "With include_facets: by_sender, by_domain, by_status.",
- "type": [
- "object",
- "null"
- ]
- },
- "meta": {
- "description": "cursor for the next page, total, sort; partial if cut short.",
- "type": [
- "object",
- "null"
- ]
- },
- "success": {
- "description": "True when data holds the result.",
- "type": "boolean"
- }
- },
- "type": "object"
-}
addedOutput schema / properties / emails
Added value: +{
+ "description": "The matching emails, in sort order.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_count": {
+ "description": "Attachments. Compact rows leave it out when 0.",
+ "type": "integer"
+ },
+ "automated": {
+ "description": "Sent by a machine. Compact rows set it only when true.",
+ "type": "boolean"
+ },
+ "awaiting": {
+ "description": "Whose turn, when known: you (not yet answered) or them.",
+ "type": "string"
+ },
+ "created_at": {
+ "description": "full only: when it was stored.",
+ "type": "string"
+ },
+ "direction": {
+ "description": "inbound, when given: every row here is a received email.",
+ "type": "string"
+ },
+ "from": {
+ "description": "Sender, as the From header shows it.",
+ "type": "string"
+ },
+ "from_email": {
+ "description": "full only: sender address.",
+ "type": "string"
+ },
+ "highlights": {
+ "additionalProperties": false,
+ "description": "full only, with q: matched fragments.",
+ "properties": {
+ "body": {
+ "description": "Fragments of the body.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "subject": {
+ "description": "Fragments of the subject.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "subject",
+ "body"
+ ],
+ "type": "object"
+ },
+ "id": {
+ "description": "Email id, for getEmail and getConversation.",
+ "type": "string"
+ },
+ "message_id": {
+ "description": "full only: Message-ID header.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "received_at": {
+ "description": "Arrival time.",
+ "type": "string"
+ },
+ "recipient": {
+ "description": "full only: envelope recipient.",
+ "type": "string"
+ },
+ "reply_count": {
+ "description": "Replies you sent to it. Compact rows leave it out when 0.",
+ "type": "integer"
+ },
+ "score": {
+ "description": "full only: relevance score.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "sender": {
+ "description": "full only: envelope sender.",
+ "type": "string"
+ },
+ "snippet": {
+ "description": "Start of the body; null when there is none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "spam_score": {
+ "description": "full only: spam score; higher is spammier.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "status": {
+ "description": "Processing stage: pending, accepted, completed or rejected.",
+ "type": "string"
+ },
+ "subject": {
+ "description": "Subject line.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "thread_id": {
+ "description": "Conversation id; null when it is in none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "to": {
+ "description": "Recipient address.",
+ "type": "string"
+ },
+ "to_email": {
+ "description": "full only: recipient address.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "thread_id",
+ "received_at",
+ "from",
+ "to",
+ "subject",
+ "status",
+ "snippet"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / facets
Added value: +{
+ "additionalProperties": false,
+ "description": "With include_facets: counts over the matches; see facets_capped.",
+ "properties": {
+ "by_domain": {
+ "description": "Matches per sender domain, most first.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "count": {
+ "description": "Matches with it.",
+ "type": "integer"
+ },
+ "value": {
+ "description": "The sender domain.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "value",
+ "count"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "by_sender": {
+ "description": "Matches per sender, most first.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "count": {
+ "description": "Matches with it.",
+ "type": "integer"
+ },
+ "value": {
+ "description": "The sender.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "value",
+ "count"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "by_status": {
+ "description": "Matches per processing stage, most first.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "count": {
+ "description": "Matches with it.",
+ "type": "integer"
+ },
+ "value": {
+ "description": "The processing stage.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "value",
+ "count"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "has_attachment": {
+ "additionalProperties": false,
+ "description": "Matches with and without attachments.",
+ "properties": {
+ "false": {
+ "description": "Without attachments.",
+ "type": "integer"
+ },
+ "true": {
+ "description": "With attachments.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "true",
+ "false"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "by_sender",
+ "by_domain",
+ "by_status",
+ "has_attachment"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / facets_capped
Added value: +{
+ "description": "Set, true, when facets count only the first matches up to the cap.",
+ "type": "boolean"
+}
addedOutput schema / properties / facets_unavailable
Added value: +{
+ "description": "Set, true, when facets were asked for but did not fit the time budget.",
+ "type": "boolean"
+}
addedOutput schema / properties / partial
Added value: +{
+ "description": "True when the page stopped at its time limit before it filled; cursor continues the search.",
+ "type": "boolean"
+}
addedOutput schema / properties / sort
Added value: +{
+ "description": "How the rows are ordered, when given: relevance or received_at.",
+ "type": "string"
+}
removedOutput schema / properties / status
Removed value: -{
- "description": "HTTP status; 2xx on success.",
- "type": "number"
-}
removedOutput schema / properties / tool
Removed value: -{
- "description": "Tool that answered.",
- "type": "string"
-}
addedOutput schema / properties / total
Added value: +{
+ "description": "Matches, when counted; absent when the count was skipped or ran out of time.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / total_capped
Added value: +{
+ "description": "True when total stopped at its cap and is a lower bound.",
+ "type": "boolean"
+}
addedOutput schema / properties / total_unavailable
Added value: +{
+ "description": "Set, true, when the count did not fit its time budget, so total is absent.",
+ "type": "boolean"
+}
changedOutput schema / required
Previous value: -[
- "tool",
- "status",
- "data"
-]New value: +[
+ "emails",
+ "cursor"
+]