Drafts

Replace a draft

Replaces the whole draft with the request body. A stored message cannot be edited in place, so the draft comes back under a new uid and the old one stops existing. Requires scope mail:write.

put/mailboxes/{address}/drafts/{uid}

Request

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

Path parameters

addressstring required

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

uidinteger required

The draft's UID in the Drafts folder, as returned when it was created or listed.

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 replaced

successboolean

Example response

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

Changes

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