emailjs

介绍

emailjs是一个基于OpenHarmony系统适配开发的，提供一个向任何 SMTP 服务器发送 HTML 电子邮件和附件能力的组件。

下载

$ ohpm install @ohos/emailjs

OpenHarmony ohpm 环境配置等更多内容，请参考如何安装 OpenHarmony ohpm 包

导入

import { AUTH_METHODS, SMTPClient } from '@ohos/emailjs'

使用说明

参考该Demo工程

注意：全局搜索项目中的‘xxx’，需要替换修改为真实的邮箱，账号密码。如果需要测试附件，需要预先生成test.docx,test.xlsx文档放置于entry目录下的src/main/resources/rawfile文件夹中

接口说明

方法名	入参	接口描述
new SMTPClient({options})	options(参照如下 new SMTPClient 参数说明)	创建SMTP客户端
login(callBack: (err: Error, result: boolean)	(err: Error, result: boolean)	登录
SMTPClient#send(message, callback)	message, callback	发送信息及其回调callback
new Message(headers)	headers(参照如下 new Message 参数说明)	构建信息
Message#attach(options)	options(参照如下 attach 参数说明)	添加附件信息
Message#checkValidity()	无	验证消息格式是否正确
new SMTPConnection(options={})	options(参照如下 SMTPConnection 参数说明)	构建SMTPC链接

new SMTPClient 参数说明

  // options is an object with the following recognized schema:
const options = {
	user, // username for logging into smtp
	password, // password for logging into smtp
	host, // smtp host (defaults to 'localhost')
	port, // smtp port (defaults to 25 for unencrypted, 465 for `ssl`, and 587 for `tls`)
	ssl, // boolean or object (if true or object, ssl connection will be made)
	tls, // boolean or object (if true or object, starttls will be initiated)
	timeout, // max number of milliseconds to wait for smtp responses (defaults to 5000)
	domain, // domain to greet smtp with (defaults to os.hostname)
	authentication, // array of preferred authentication methods ('PLAIN', 'LOGIN', 'CRAM-MD5', 'XOAUTH2')
	logger, // override the built-in logger (useful for e.g. Azure Function Apps, where console.log doesn't work)
};

new Message 参数说明

const headers = {
	from, // sender of the format (address or name <address> or "name" <address>)
	to, // recipients (same format as above), multiple recipients are separated by a comma
	cc, // carbon copied recipients (same format as above)
	bcc, // blind carbon copied recipients (same format as above)
	text, // text of the email
	subject, // string subject of the email
	attachment, // one attachment or array of attachments
};

attach 参数说明

const options = {
	// one of these fields is required
	path, // string to where the file is located
	data, // string of the data you want to attach
	stream, // binary stream that will provide attachment data (make sure it is in the paused state)
	// better performance for binary streams is achieved if buffer.length % (76*6) == 0
	// current max size of buffer must be no larger than Message.BUFFERSIZE

	// optionally these fields are also accepted
	type, // string of the file mime type
	name, // name to give the file as perceived by the recipient
	charset, // charset to encode attatchment in
	method, // method to send attachment as (used by calendar invites)
	alternative, // if true, will be attached inline as an alternative (also defaults type='text/html')
	inline, // if true, will be attached inline
	encoded, // set this to true if the data is already base64 encoded, (avoid this if possible)
	headers, // object containing header=>value pairs for inclusion in this attachment's header
	related, // an array of attachments that you want to be related to the parent attachment
};

SMTPConnection 参数说明

const options = {
	user, // username for logging into smtp
	password, // password for logging into smtp
	host, // smtp host (defaults to 'localhost')
	port, // smtp port (defaults to 25 for unencrypted, 465 for `ssl`, and 587 for `tls`)
	ssl, // boolean or object (if true or object, ssl connection will be made)
	tls, // boolean or object (if true or object, starttls will be initiated)
	timeout, // max number of milliseconds to wait for smtp responses (defaults to 5000)
	domain, // domain to greet smtp with (defaults to os.hostname)
	authentication, // array of preferred authentication methods ('PLAIN', 'LOGIN', 'CRAM-MD5', 'XOAUTH2')
	logger, // override the built-in logger (useful for e.g. Azure Function Apps, where console.log doesn't work)
};

更多模块的使用可参考官方文档，单元测试用例详情可参考

关于混淆

• 代码混淆，请查看代码混淆简介
• 如果希望emailjs库在代码混淆过程中不会被混淆，需要在混淆规则配置文件obfuscation-rules.txt中添加相应的排除规则：

-keep
./oh_modules/@ohos/emailjs

约束与限制

在下述版本验证通过：

• DevEco Studio: NEXT Beta1-5.0.3.806, SDK: API12 Release(5.0.0.66)

• DevEco Studio:4.0 Release(4.0.3.600),SDK API10(4.0.10.11)

支持的邮箱类型：QQ邮箱、163邮箱、126邮箱、新浪邮箱、搜狐邮箱。

目录结构

|-entry 
    |-ets
    |   |-entryability
    |           |-EntryAbility.ts
    |   |-pages
    |           |-LoginPage.ets             #主页demo
    |           |-SendMailPage.ets
|-SMTP
    |-ets  # 用于处理向任何 SMTP 服务器发送 HTML 电子邮件和附件
    |-js   # 用于适配node的polyfill方案 

贡献代码

使用过程中发现任何问题都可以提 Issue 给组件，当然，也非常欢迎给发 PR共建 。

开源协议

本项目基于 MIT license ，请自由地享受和参与开源。