suqin-exmail v0.0.2

suqin-exmail

suqin的一款插件, 使其支持腾讯企业邮箱(Exmail)账号体系的通讯录操作.

主要功能

• 对department的增删改查操作, 该资源在API中使用group进行描述
• 对user的增删改查操作, 该资源在API中使用member进行描述

API列表

read API

• 查询成员列表readMembers
• 查询成员详情readMember
• 查询群组列表readGroups
• 查询群组详情readGroup

write API

• 创建成员createMember
• 删除成员deleteMember
• 修改成员updateMember
• 创建群组createGroup
• 删除群组deleteGroup
• 修改群组updateGroup

使用方法

const Suqin = require('suqin');
const Exmail = require('suqin-exmail');

const directories = new Suqin();

const opts = {
  // 必选
  corpId: 'your corpId',
  corpSecret: 'your addressListSecret',
  // 可选
  baseUrl: 'https://api.exmail.qq.com',
  name: 'Exmail',
};

const ex = new Exmail(opts);

directories.use(ex);

// member为您要创建的成员, 其数据结构请参考腾讯企业邮箱平台文档
directories.createMember('Exmail', member)
  .then(res => res.data, err => err.data);

directories.readMembers('Exmail')
  .then(res => res.data, err => err.data);

注意事项

• 全部代码使用ES6进行编写, 您可能需要babel或--harmony模式的协助
• 执行测试时请先行配置以下环境变量
  • EXMAIL_CORP_ID 腾讯企业邮箱授予的组织ID
  • EXMAIL_ADDRESS_LIST_SECRET 腾讯企业邮箱授予的组织秘钥

参考资料

• 腾讯企业邮箱 - 接口文档