addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"Whether inbound mail is set up, and what is left to do."
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "Whether inbound mail is set up.",
- "properties": {
- "domains": {
- "description": "Domains that receive mail.",
- "items": {
- "properties": {
- "domain": {
- "type": "string"
- },
- "email_count": {
- "type": [
- "number",
- "string"
- ]
- },
- "id": {
- "description": "Domain id, for domain_id filters.",
- "type": "string"
- },
- "latest_email_received_at": {
- "type": [
- "string",
- "null"
- ]
- },
- "processing_ready": {
- "type": "boolean"
- },
- "receiving_ready": {
- "type": "boolean"
- },
- "status": {
- "description": "ready, stored_only, pending_dns or inactive.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "endpoints": {
- "description": "Webhook endpoints.",
- "properties": {
- "disabled": {
- "type": [
- "number",
- "string"
- ]
- },
- "enabled": {
- "type": [
- "number",
- "string"
- ]
- },
- "total": {
- "type": [
- "number",
- "string"
- ]
- }
- },
- "type": "object"
- },
- "functions": {
- "description": "Deployed Functions.",
- "properties": {
- "deployed": {
- "type": [
- "number",
- "string"
- ]
- },
- "failed": {
- "type": [
- "number",
- "string"
- ]
- },
- "pending": {
- "type": [
- "number",
- "string"
- ]
- },
- "total": {
- "type": [
- "number",
- "string"
- ]
- }
- },
- "type": "object"
- },
- "next_actions": {
- "description": "Steps left: kind, message, command.",
- "type": "array"
- },
- "processing_ready": {
- "description": "Mail is routed somewhere.",
- "type": "boolean"
- },
- "ready": {
- "description": "Mail is received and processed.",
- "type": "boolean"
- },
- "receiving_ready": {
- "description": "A domain receives mail.",
- "type": "boolean"
- },
- "recent_emails": {
- "description": "Inbound activity.",
- "properties": {
- "latest_received_at": {
- "type": [
- "string",
- "null"
- ]
- },
- "total": {
- "type": [
- "number",
- "string"
- ]
- }
- },
- "type": "object"
- },
- "summary": {
- "description": "Plain-language status.",
- "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 / domains
Added value: +{
+ "description": "Domains that receive mail.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "domain": {
+ "description": "Domain name.",
+ "type": "string"
+ },
+ "email_count": {
+ "description": "Emails received on it.",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Domain id, for domain_id filters.",
+ "type": "string"
+ },
+ "latest_email_received_at": {
+ "description": "Last arrival; null if none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "processing_ready": {
+ "description": "True when its mail reaches a webhook or Function.",
+ "type": "boolean"
+ },
+ "receiving_ready": {
+ "description": "True when it receives mail.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "ready, stored_only, pending_dns or inactive.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "domain",
+ "status",
+ "receiving_ready",
+ "processing_ready",
+ "email_count",
+ "latest_email_received_at"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / endpoints
Added value: +{
+ "additionalProperties": false,
+ "description": "Webhook endpoints, by state.",
+ "properties": {
+ "disabled": {
+ "description": "Endpoints turned off.",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "Endpoints receiving mail.",
+ "type": "integer"
+ },
+ "total": {
+ "description": "All endpoints.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "total",
+ "enabled",
+ "disabled"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / functions
Added value: +{
+ "additionalProperties": false,
+ "description": "Functions, by deploy state.",
+ "properties": {
+ "deployed": {
+ "description": "Running.",
+ "type": "integer"
+ },
+ "failed": {
+ "description": "Failed to deploy.",
+ "type": "integer"
+ },
+ "pending": {
+ "description": "Still deploying.",
+ "type": "integer"
+ },
+ "total": {
+ "description": "All Functions.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "total",
+ "deployed",
+ "pending",
+ "failed"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / next_actions
Added value: +{
+ "description": "Steps left, most important first; empty when ready.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "command": {
+ "description": "CLI command that does it; absent when there is none.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The step, such as add_domain or verify_domain.",
+ "type": "string"
+ },
+ "message": {
+ "description": "What to do, in words.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "kind",
+ "message"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / processing_ready
Added value: +{
+ "description": "True when received mail reaches a webhook or Function.",
+ "type": "boolean"
+}
addedOutput schema / properties / ready
Added value: +{
+ "description": "True when mail is received and processed.",
+ "type": "boolean"
+}
addedOutput schema / properties / receiving_ready
Added value: +{
+ "description": "True when some domain receives mail.",
+ "type": "boolean"
+}
addedOutput schema / properties / recent_emails
Added value: +{
+ "additionalProperties": false,
+ "description": "Inbound activity.",
+ "properties": {
+ "latest_received_at": {
+ "description": "Last arrival; null if none.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "total": {
+ "description": "Inbound emails stored.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "total",
+ "latest_received_at"
+ ],
+ "type": "object"
+}
removedOutput schema / properties / status
Removed value: -{
- "description": "HTTP status; 2xx on success.",
- "type": "number"
-}
addedOutput schema / properties / summary
Added value: +{
+ "description": "Plain-language status, to tell the user.",
+ "type": "string"
+}
removedOutput schema / properties / tool
Removed value: -{
- "description": "Tool that answered.",
- "type": "string"
-}
changedOutput schema / required
Previous value: -[
- "tool",
- "status",
- "data"
-]New value: +[
+ "ready",
+ "receiving_ready",
+ "processing_ready",
+ "summary",
+ "next_actions",
+ "domains",
+ "endpoints",
+ "functions",
+ "recent_emails"
+]