apxtri/adminapi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation apidoc

Browse Source
This commit is contained in:
philc 2025-02-10 16:36:08 +01:00
parent 50b5203b6a
commit 7612eefef8
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
apxtri/routes/notifications.js
View File

@ -42,9 +42,9 @@ router.get("/messages/:alias/:tribeId", (req, res) => {
});
/**
* @api {POST} adminapi/notifications/sendmail/:tribe/:template -Send personnalize emails
* @api {POST} adminapi/notifications/sendmail/:tribe/:template - Send personnalize emails
* @apiName Sendmail
* @apiDescription Send personnalize email with data from template store in ../../{tribe}/template/{template}.json and smtp in conf global or in /itm/{tribe}.json that must have valid parameter emailcontact must be authorized by the smtp
* @apiDescription Send campain personnalized email by rendering a template store in ../../{tribe}/template/{template}.js containing email key like html, subject, text, cc,.. as mustache templatewith blank test replaced by data.<br> It use a smtp in conf global or in /itm/{tribe}.json that must have valid parameter emailcontact must be authorized by the smtp <br>
* "emailcontact": "noreply@smatchit.io",
* "smtp": {
* "host": "smtp-relay.brevo.com",
@ -60,8 +60,7 @@ router.get("/messages/:alias/:tribeId", (req, res) => {
*
* @apiParam {string} template that must exist in {tribe}/template/{template}_{lg}.js that contain all email component (html, text, attachement...)
* @apiParam {string} tribe
* @apiBody {object} emailstosend {emailsto:[{to:[emailslist], cc:[],bcc:[],attachments:[] and any key:value specific for this email}], key:value common to all email that will be include in each email} each item af emailsto is a mail that will be send. If one email of emailsto[].to is not valid then it will be store in result.fail:[{to:emailerror,err:["errorformat"]}], then for well formùated email, the result of an email will be store in results.success:[{to:emailsto[].to.emailslist.join(","),status:smtp status}]
*
* @apiBody {object} emailstosend {emailsto:[{to:[emailslist], cc:[],bcc:[],attachments:[] and any key:value specific for this email}], key:value commonto all email that will be include in each email} each item af emailsto is a mail that will be send. If one email of emailsto[].to is not valid then it will be store in result.fail:[{to:emailerror,err:["errorformat"]}], then for well formated email, the result of an email will be store in results.success:[{to:emailsto[].to.emailslist.join(","),status:smtp status}]
*
* @apiSuccess {object} notif content
* @apiSuccessExample {json} Success-Response: