/sendmail

Sends an email through the fylr server's mail infrastructure, composed as a multipart message with separate HTML and text bodies and optional attachments. Each send writes an EMAIL_SENT or EMAIL_SENT_FAILED event. Requires system.sendmail (or system.root).

POST /system/sendmail — This endpoint sends an mail using the fylr server infrastructure. The mail is composed as multipart mail with separate HTML and text bodies. The user needs the system.sendmail or system.root system right. After sending an email EMAIL_SENT or EMAIL_SENT_FAILED event is written.

This endpoint sends an mail using the fylr server infrastructure. The mail is composed as multipart mail with separate HTML and text bodies. The user needs the `system.sendmail` or `system.root` system right. After sending an email `EMAIL_SENT` or `EMAIL_SENT_FAILED` event is written.

post

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Body

application/json

fromstringOptional

The From address to use in the mail header.

tostring[]Optional

The To address to use in the mail header.

ccstring[]Optional

The Cc addresses to use in the mail header.

bccstring[]Optional

The Bcc addresses to use in the mail header.

subjectstringOptional

The Subject to use in the mail header.

htmlstringOptional

The body of the mail in HTML format. You can reference attachements using the cid: semantic. Use the cid:<URL> as source for images. If the cid: is followed by an URL, the data is requested and attached. The cid:<URL> is then replaced with a filename referencing the attachment. If the URL begins with fylr.externalURL, the current access token is appended to the URL. With this, local file previews can be accessed and embedded in the email.

textstringOptional

The body of the mail in TEXT format.

Responses

200

The mail has been handed over successfully to the MTA (mail transfer agent)

application/json

statusstring · enumRequiredPossible values:

400

Sending the mail failed. This also writes an EMAIL_SENT_FAILED event. See the code and parameters.msg for the underlying reason.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user holds neither system.sendmail nor system.root.

application/json

{
  "status": "ok"
}