One mailbox

Before you call

Credential

Authorization: Bearer $KEY

Credential

Authorization: Bearer $KEY

Parameters

• emailstring (email)required
  In the path

Responses

• 200application/json
  The mailbox.
  • emailstring (email)required
  • namestring or null
  • kindstringrequired
    What holds the address: a person, an agent, or a machine. One of: human, agent, machine. Default: human.
  • inboxbooleanrequired
    False for a send-only address.
• 401application/json
  Neither a service token nor a signed-in session was accepted.
  • errorstringrequired
    What went wrong, in a sentence.
  • detailstring
• 404application/json
  No such mailbox on this account.
  • errorstringrequired
    What went wrong, in a sentence.
  • detailstring
• 502application/json
  The mail service could not be reached, or refused.
  • errorstringrequired
    What went wrong, in a sentence.
  • detailstring
• 503application/json
  Mail is not configured on this deployment.
  • errorstringrequired
    What went wrong, in a sentence.
  • detailstring