Drafts

Create a draft

Saves a draft in the mailbox's Drafts folder without sending it. Every field is optional. The draft is a real message: a person can open it in webmail or any mail app, edit it and send it. Requires scope mail:write.

post/mailboxes/{address}/drafts

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/drafts
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

Headers

Idempotency-Keystring

A unique value you choose (a UUID works), up to 256 characters. Repeating a request with the same key within 24 hours returns the first result instead of doing the work twice. The same key with a different body is a 422; a repeat while the first request is still running is a 409.

Request body

tostring

Comma-separated recipients

ccstring
bccstring
subjectstring
textstring
htmlstring
replyTostring email
fromNamestring

From display name the draft is sent under; default: the mailbox's name

inReplyTostring

Message-ID being replied to, so the draft threads correctly

referencesstring

Example request

{
  "to": "alice@example.com",
  "subject": "Re: Your order",
  "attachments": [
    {
      "contentType": "application/pdf"
    }
  ]
}

Response

Draft saved

successboolean

Example response

{
  "success": true,
  "data": {
    "uid": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.