reliable-mail

mail sender for reliable.

Install

npm install reliable-mail

Usage

Mail

first step: modify lib/config.js or create instance of Mail with config:

const Mail = require('reliable-mail');
const mail = new Mail({
  locale: 'zh-CN' // or `en-US`,
  mail: {
    name: 'reliable test',
    port: 465,
    host: 'smtp.reliable-test.com',
    secure: true,
    ignoreTLS: true,
    auth: {
      user: '[e-mail]',
      pass: 'reliable'
    },
    sloganImage: 'https://avatars0.githubusercontent.com/u/9263042?v=3&s=200'
  },
  site: {
    title: 'Reliable',
    baseurl: 'http://reliable-test.com',
    docurl: 'https://macacajs.github.io/macaca',
    issueurl: 'https://github.com/reliablejs/reliable-master',
    login: true
  }
})

default config in /lib/config.js

mail.sendResetPasswordMail

/**
 * send reset password mail
 * @param  {String}   to       recipient
 * @param  {String}   token    reset token
 * @param  {Function} callback 
 */
mail.sendResetPasswordMail('your.email@address', '11111', info => {
  console.log('info: ', info);
});

mail.sendTaskEndMail

/**
 * send email when task end
 * @param  {String}   to       recipient
 * @param  {Object}   data 
 * @param  {Function} callback 
 */
mail.sendTaskEndMail('your.email@address', {
  duration: '1s',
  status_name: 'failed',
  start_date: '1100',
  extra: JSON.stringify({
    passing: 'no',
    failing: 'en',
    description: {
      commitId: 'xxxx',
      subject: '我就是我',
      author: 'bruno',
      branch: 'branch'
    }
  }),
  title: 'jiang',
  taskId: 'xxxxxxx',
  subject: 'hahahaha'
}, info => {
  console.log('info: ', info);
});

mail.sendNoticeMail

/**
 * send notice mail
 * @param  {String}   to       recipient
 * @param  {String}   subject  email subject
 * @param  {String}   content  content of notice
 * @param  {Function} callback 
 */
mail.sendNoticeMail('your.email@address', 'done', 'hahaha', info => {
  console.log('info: ', info);
});