From 3195ecbd4d2d5e9bf881d16d87e4fd51517ab82a Mon Sep 17 00:00:00 2001 From: philc Date: Mon, 10 Feb 2025 16:40:41 +0100 Subject: [PATCH] new doc --- apxtri/routes/notifications.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/apxtri/routes/notifications.js b/apxtri/routes/notifications.js index c4517e5..ee354b1 100644 --- a/apxtri/routes/notifications.js +++ b/apxtri/routes/notifications.js @@ -45,22 +45,22 @@ router.get("/messages/:alias/:tribeId", (req, res) => { * @api {POST} adminapi/notifications/sendmail/:tribe/:template - Send personnalize emails * @apiName Sendmail * @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.
It use a smtp in conf global or in /itm/{tribe}.json that must have valid parameter emailcontact must be authorized by the smtp
- * "emailcontact": "noreply@smatchit.io", - * "smtp": { - * "host": "smtp-relay.brevo.com", - * "port": 587, - * "secure": false, + * "emailcontact": "noreply@smatchit.io",
+ * "smtp": {
+ * "host": "smtp-relay.brevo.com",
+ * "port": 587,
+ * "secure": false,
* "auth": { * "user": "xx", * "pass": "yy" - * } + * }
* } * @apiGroup Notifications * * @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 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}] + * @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 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: