core/email

邮箱模块

Source:

Methods

(async, inner) confirmEmail(params, global) → {Promise.<object>}

确认邮件链接，并执行对应的操作。通过以下两种方式暴露：

  • ajax: POST /api/email/:id
  • socket.io: confirm-email
Source:
Parameters:
Name Type Description
params object

请求数据

  • id {string} 回话的id，长度为40
  • data {object} 请求的token
    • action {string} create-user或reset-password
    • password {string} reset-password时，为新的密码，长度至少为8。否则不能存在
global object
Returns:
Type:
Promise.<object>

(async, inner) sendEmail(params, global) → {Promise.<object>}

发送邮件，用于创建用户或重置密码。通过以下两种方式暴露：

  • ajax: POST /api/email
  • socket.io: emit email:create
Source:
Parameters:
Name Type Description
params object

请求数据

  • data {object} 请求的data
    • action {string} create-user或reset-password
    • email {string} 发送验证邮件
    • to {string} 邮件跳转的地址，必须符合同源要求
    • username {string} 如果是create-user，则英文数字下线符，不能为空
    • password {string} 如果是create-user，则长度必须大于8
    • roles {string[]} 如果是create-user，则只能包含SUBSCRIBER或PUBLISHER
global object

全局数据
Returns:
Type:
Promise.<object>