/api/system
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_ERROR` event is written.
post
Body
ccstring[]Optional
The Cc addresses to use in the mail header.
fromstringOptional
The From address 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.
subjectstringOptional
The Subject to use in the mail header.
textstringOptional
The body of the mail in TEXT format.
tostring[]Optional
The To address to use in the mail header.
Responses
200
The mail has been handed over successfully to the MTA (mail transfer agent)
application/json
400
An error occurred, this triggers a `EMAIL_SENT_ERROR` event to be written.
{
"status": "ok"
}
This endpoint sends a test email to one mail address. The user needs the `system.sendmail` or `system.root` system right. After sending an email `EMAIL_SENT` or `EMAIL_SENT_ERROR` event is written.
post
Body
tostringOptional
The To address to use in the mail header.
Responses
200
The mail has been handed over successfully to the MTA (mail transfer agent)
application/json
400
An error occurred, this triggers a `EMAIL_SENT_ERROR` event to be written.
{
"status": "ok"
}
Last updated