Mailboxes

Set the auto-reply

Replaces the auto-reply. While it is on (and within fromDate/toDate when set), the mail server answers each sender once with subject and textBody/htmlBody, from the mailbox's own address; mailing-list and automated mail gets no reply. A field left out is cleared, so send the whole state; { "enabled": false } switches it off. Refused with 409 when the mailbox runs its own mail filter script, since the server runs one script per mailbox. Requires scope mail:write.

put/mailboxes/{address}/auto-reply

Request

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

Path parameters

addressstring required

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

Request body

enabledboolean required
subjectstring nullable

Default: the server replies with "Re:" and the original subject

textBodystring nullable
htmlBodystring nullable
fromDatestring date-time nullable

ISO 8601 with a timezone

toDatestring date-time nullable

ISO 8601 with a timezone; must be after fromDate

Example request

{
  "enabled": true,
  "subject": "Out of office",
  "textBody": "I am away until 2 November and will answer then.",
  "fromDate": "2026-10-26T00:00:00Z",
  "toDate": "2026-11-02T00:00:00Z"
}

Response

The auto-reply as it stands now

successboolean

Example response

{
  "success": true,
  "data": {
    "enabled": true,
    "subject": "Out of office",
    "textBody": "I am away until 2 November and will answer then."
  }
}

Changes

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