addedOutput schema / additionalProperties
Added value: +false
changedOutput schema / description
Previous value: -"Envelope; the result is in data.data."New value: +"Where you can send from, and to whom."
addedOutput schema / properties / can_send_to
Added value: +{
+ "additionalProperties": false,
+ "description": "Who this account may email.",
+ "properties": {
+ "address_rules_omitted": {
+ "description": "Address rules left out of rules; set when some were.",
+ "type": "integer"
+ },
+ "address_rules_partial": {
+ "description": "True when the address rules are a sample: an unlisted address may be allowed.",
+ "type": "boolean"
+ },
+ "any_recipient": {
+ "description": "True when any recipient is allowed. Set when known.",
+ "type": "boolean"
+ },
+ "known": {
+ "description": "False when the rules could not be read; then only summary is set.",
+ "type": "boolean"
+ },
+ "rules": {
+ "description": "Who you may email, one rule per kind of recipient. Set when known.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "address and org_member_email rules only: the address.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Who the rule allows, in words.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "your_domain rules only: the domain.",
+ "type": "string"
+ },
+ "last_received_at": {
+ "description": "address rules only: last mail from it.",
+ "type": "string"
+ },
+ "received_count": {
+ "description": "address rules only: emails received from it.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "any_recipient, primitive_managed_domain, managed_zone, your_domain, address, org_member_email or opted_in_domains.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "managed_zone rules only: the zone.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "description"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "summary": {
+ "description": "Who this account can reach, to tell the user.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "known",
+ "summary"
+ ],
+ "type": "object"
+}
removedOutput schema / properties / data
Removed value: -{
- "description": "API response: the result in data, or error.",
- "properties": {
- "data": {
- "description": "Where you can send from, and to whom.",
- "properties": {
- "can_send_to": {
- "description": "Who you may email.",
- "properties": {
- "any_recipient": {
- "description": "Any recipient is allowed.",
- "type": "boolean"
- },
- "rules": {
- "description": "Who is allowed: each has a type and a description.",
- "type": "array"
- },
- "summary": {
- "description": "What to tell the user.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "domains": {
- "description": "Your domains and what each still needs.",
- "items": {
- "properties": {
- "domain": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "outbound_verified": {
- "description": "SPF, DKIM and DMARC verified.",
- "type": "boolean"
- },
- "ownership_verified": {
- "type": "boolean"
- },
- "status": {
- "description": "sendable, pending_outbound_dns, pending_ownership, inactive.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "next_actions": {
- "description": "Steps left: kind, message, command.",
- "type": "array"
- },
- "ready": {
- "description": "Some domain can send.",
- "type": "boolean"
- },
- "sendable_domains": {
- "description": "Domains you can send from now.",
- "type": "array"
- },
- "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": "Your domains and what each still needs.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "domain": {
+ "description": "Domain name.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Domain id.",
+ "type": "string"
+ },
+ "outbound_verified": {
+ "description": "True when SPF, DKIM and DMARC are verified.",
+ "type": "boolean"
+ },
+ "ownership_verified": {
+ "description": "True when ownership is proven.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "sendable, pending_outbound_dns, pending_ownership or inactive.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "domain",
+ "status",
+ "ownership_verified",
+ "outbound_verified"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
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 / ready
Added value: +{
+ "description": "True when some domain can send now.",
+ "type": "boolean"
+}
addedOutput schema / properties / sendable_domains
Added value: +{
+ "description": "Domains you can send from now.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
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",
+ "summary",
+ "sendable_domains",
+ "domains",
+ "next_actions",
+ "can_send_to"
+]