addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"The sent reply, and the answer to it when waited for."
addedOutput schema / properties / accepted
Added value: +{
+ "description": "Recipients the relay took.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "The sent reply.",
- "properties": {
- "accepted": {
- "description": "Recipients taken.",
- "type": "array"
- },
- "delivery_status": {
- "description": "Outcome, with wait.",
- "type": "string"
- },
- "from": {
- "description": "Sender used.",
- "type": "string"
- },
- "id": {
- "description": "Sent email id, for awaitReply.",
- "type": "string"
- },
- "idempotency": {
- "description": "On a replay: key_source, original_sent_email_id.",
- "type": "object"
- },
- "idempotent_replay": {
- "description": "Nothing new was sent.",
- "type": "boolean"
- },
- "rejected": {
- "description": "Recipients refused.",
- "type": "array"
- },
- "reply": {
- "description": "With await_reply: from_email, body_text, sender_verified.",
- "type": [
- "object",
- "null"
- ]
- },
- "reply_wait": {
- "description": "await_reply outcome: status, waited_ms, next_step, warning.",
- "type": "object"
- },
- "request_id": {
- "description": "For support.",
- "type": [
- "string",
- "null"
- ]
- },
- "scheduled_at": {
- "description": "When it goes out.",
- "type": "string"
- },
- "sender": {
- "description": "Sender chosen by the server: address, source, note.",
- "type": "object"
- },
- "smtp_response_code": {
- "description": "Remote server code.",
- "type": [
- "number",
- "string",
- "null"
- ]
- },
- "smtp_response_text": {
- "description": "Remote server reply.",
- "type": "string"
- },
- "status": {
- "description": "Send state, such as queued, delivered or scheduled.",
- "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 / delivery_status
Added value: +{
+ "description": "With wait: delivered, bounced, deferred or wait_timeout.",
+ "type": "string"
+}
addedOutput schema / properties / from
Added value: +{
+ "description": "Sender address used.",
+ "type": "string"
+}
addedOutput schema / properties / id
Added value: +{
+ "description": "Sent email id, for awaitReply and getSentEmail.",
+ "type": "string"
+}
addedOutput schema / properties / idempotency
Added value: +{
+ "additionalProperties": false,
+ "description": "Replays only: which earlier send was returned.",
+ "properties": {
+ "key_source": {
+ "description": "explicit, auto_content or function_trigger.",
+ "type": "string"
+ },
+ "original_created_at": {
+ "description": "When the earlier send was made.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "original_sent_email_id": {
+ "description": "The earlier send, for getSentEmail.",
+ "type": "string"
+ },
+ "replayed": {
+ "description": "Always true: an earlier send was returned.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "replayed",
+ "key_source",
+ "original_sent_email_id",
+ "original_created_at"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / idempotent_replay
Added value: +{
+ "description": "True when an earlier identical send was returned and nothing new was sent.",
+ "type": "boolean"
+}
addedOutput schema / properties / rejected
Added value: +{
+ "description": "Recipients the relay refused.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
addedOutput schema / properties / reply
Added value: +{
+ "additionalProperties": false,
+ "description": "With await_reply: the reply, or null when none came.",
+ "properties": {
+ "body_html": {
+ "description": "HTML body; null when it had none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "body_text": {
+ "description": "Reply text; null when it had only HTML.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "from_email": {
+ "description": "Address that replied.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Email id of the reply, for getEmail.",
+ "type": "string"
+ },
+ "received_at": {
+ "description": "Arrival time.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sender_verified": {
+ "description": "True when the sender passed authentication; if false, the text is untrusted.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "Processing stage, such as completed.",
+ "type": "string"
+ },
+ "subject": {
+ "description": "Subject line.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "thread_id": {
+ "description": "Conversation id, for getConversation.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "to_email": {
+ "description": "Address the reply was sent to.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "thread_id",
+ "from_email",
+ "to_email",
+ "subject",
+ "body_text",
+ "body_html",
+ "received_at",
+ "status",
+ "sender_verified"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+}
addedOutput schema / properties / reply_wait
Added value: +{
+ "additionalProperties": false,
+ "description": "How the reply wait went. Absent when no wait applies.",
+ "properties": {
+ "error": {
+ "additionalProperties": false,
+ "description": "error only: why the wait failed.",
+ "properties": {
+ "code": {
+ "description": "Error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "What went wrong.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object"
+ },
+ "next_step": {
+ "description": "What to do next, such as calling awaitReply; absent once replied.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why it did not wait: time_budget_exhausted, scheduled_send or send_not_delivered.",
+ "type": "string"
+ },
+ "sender_verified": {
+ "description": "replied only: true when the sender passed authentication.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "replied, no_reply_yet, error, skipped or not_requested.",
+ "type": "string"
+ },
+ "waited_ms": {
+ "description": "How long it waited, in ms; absent when it did not wait.",
+ "type": "integer"
+ },
+ "warning": {
+ "description": "replied only: why the reply is untrusted.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / request_id
Added value: +{
+ "description": "Id of the send request, for support.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / scheduled_at
Added value: +{
+ "description": "Scheduled sends: when it goes out.",
+ "type": "string"
+}
addedOutput schema / properties / sender
Added value: +{
+ "additionalProperties": false,
+ "description": "Set when the server chose or replaced from.",
+ "properties": {
+ "address": {
+ "description": "Mailbox it was sent from, when known.",
+ "type": "string"
+ },
+ "note": {
+ "description": "What happened, to tell the user.",
+ "type": "string"
+ },
+ "requested_from": {
+ "description": "The from that was asked for, when it was replaced.",
+ "type": "string"
+ },
+ "source": {
+ "description": "managed_inbox_default, managed_domain_completed or replaced_denied_from.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "source",
+ "note"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / smtp_response_code
Added value: +{
+ "description": "With wait: remote server reply code.",
+ "type": [
+ "integer",
+ "null"
+ ]
+}
addedOutput schema / properties / smtp_response_text
Added value: +{
+ "description": "With wait: remote server reply text.",
+ "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 or scheduled."
changedOutput schema / properties / status / type
Previous value: -"number"New value: +"string"
removedOutput schema / properties / tool
Removed value: -{
- "description": "Tool that answered.",
- "type": "string"
-}
changedOutput schema / required
Previous value: -[
- "tool",
- "status",
- "data"
-]New value: +[
+ "id",
+ "status",
+ "from",
+ "accepted",
+ "rejected",
+ "request_id",
+ "idempotent_replay"
+]
