egg-cute-mailer

Mailer 插件是为 egg 提供 邮件发送功能

此插件参考 [nodemailer]

安装

$ npm i egg-cute-mailer --save

配置

通过 config/plugin.js 配置启动 Mailer 插件:

exports.mailer = {
  enable: true,
  package: 'egg-cute-mailer',
};

在 config/config.${env}.js 配置各个环境的信息：

单数据源

exports.mailer = {
  client: {
    host: "",
    port: 465,
    secure: true,
    auth: {
      user: '',
      pass: ''
    }
  },
  app: true,
  agent: false,
};

使用方式：

await app.mailer.send({
    from: '"Maddison Foo Koch" <[email protected]>',
    to: "[email protected], [email protected]",
    subject: "Hello ✔",
    text: "Hello world?",
    html: "<b>Hello world?</b>",
}); // 单实例可以直接通过 app.mailer 访问

多数据源

exports.mailer = {
  clients: {
    // clientId, 获取client实例，需要通过 app.mailer.get('clientId') 获取
    client1: {
      host: "",
      port: 465,
      secure: true, // true for 465, false for other ports
      auth: {
        user: '',
        pass: ''
      }
    },
    // ...
  },

  // 是否加载到 app 上，默认开启
  app: true,
  // 是否加载到 agent 上，默认关闭
  agent: false,
};

使用方式：

const client1 = app.mailer.get('client1');
client1.send({
    from: '"Maddison Foo Koch" <[email protected]>',
    to: "[email protected], [email protected]",
    subject: "Hello ✔",
    text: "Hello world?",
    html: "<b>Hello world?</b>",
});

const client2 = app.mailer.get('client2');
client2.send({
    to: "[email protected], [email protected]",
    subject: "Hello ✔",
    text: "Hello world?",
    html: "<b>Hello world?</b>",
});

Questions & Suggestions

Please open an issue here.

License

MIT