Class: dak

dak

new dak(opts)

邮件对象
Name Type Description
opts Object 配置属性 格式:{uri:'网络地址'}

Methods

del(opts, cb)

删除邮件
Name Type Default Description
opts Object {} optional 参数
cb callback function(err,result){} optional 回调
Examples
id,all,read必填之一
opts参数:{
  type: 邮件类型(可选,0:系统,1:用户)
  id: 邮件id(可选,值可为数组或以','间隔的字符串),
  read: 是否只删除已读的(可选)
  all: 是否全部(可选)
  check: 是否检查附件未领(可选,默认false)
}
cb参数格式:
result参数:
{
}
err参数:{
 err: 错误码,
 msg: 错误信息
}

getDak(opts, cb)

获取邮件信息
Name Type Default Description
opts Object {} optional 参数
cb callback function(err,result){} optional 回调
Examples
opts参数:{
  id: 邮件ID
}
cb参数格式:
result参数:{
 }
err参数:{
 err: 错误码,
 msg: 错误信息
}

listDaks(opts, cb)

邮件列表
Name Type Default Description
opts Object {} optional 参数
cb callback function(err,result){} optional 回调
Examples
opts参数:{
  page: 第几页(可选),
  rows: 一页几行(可选,默认10),
  fields: {status:1},//筛选字段(可选)
  appid: 应用id(可选),
  type: 邮件类型(可选,默认全部,0:系统,1:用户),
  userId: 指定用户id(可选,需要权限,值可为数组或以','间隔的字符串).
}
cb参数格式:
result参数:{
 }
err参数:{
 err: 错误码,
 msg: 错误信息
}

send(opts, cb)

发送邮件
Name Type Default Description
opts Object {} optional 参数
cb callback function(err,result){} optional 回调
Examples
opts参数:{
  appid: 应用id(必填),
  userId: 指定用户id(可选,需要权限,值可为数组或以','间隔的字符串).
  title: 邮件标题(必填),
  content: 邮件内容(必填),
  attach: [{     //附件(可选)
     id: '唯一ID',//该项为用户背包中道具的唯一ID
     prop:'道具ID',//该项只允许具有权限的用户操作
     expire:'过期时间',
     amount:'数量',
  }],
  isSys: 是否系统邮件(可选,默认否)
}
cb参数格式:
result参数:
{
}
err参数:{
 err: 错误码,
 msg: 错误信息
}

take(opts, cb)

领取附件
Name Type Default Description
opts Object {} optional 参数
cb callback function(err,result){} optional 回调
Examples
opts参数:{
  type: 邮件类型(可选,0:系统,1:用户)
  id: 邮件id(可选,值可为数组或以','间隔的字符串),
  all: 是否全部(可选,id和all必填之一)
}
cb参数格式:
result参数:
{
  rows:[{
    prop:{ _id: 57e5f68aaec31c1ecc1d6336, code: 'paodan', name: '炮弹' },
    expire:'过期时间戳',
    amount:'数量'
  }]
}
err参数:{
 err: 错误码,
 msg: 错误信息
}

unread(opts, cb)

获取未读邮件
Name Type Default Description
opts Object {} optional 参数
cb callback function(err,result){} optional 回调
Examples
opts参数:{
  type: 邮件类型(可选,0:系统,1:用户)
  appid: 应用id(可选)
}
cb参数格式:
result参数:{
  rows:['id']  //未读的邮件id
 }
err参数:{
 err: 错误码,
 msg: 错误信息
}