1 Star 0 Fork 26

pangyinqiang / ohos_mail_base

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

标准邮件协议 SDK

英文文档:English

介绍

ohos_mail_base是专为OpenHarmony系统开发的标准邮件协议 SDK,采用纯TypeScript语言实现。本仓库包含标准邮件协议 SDK 源码和相关使用说明文档。

SDK 主要支持特性如下:

  1. 支持邮件标准协议(IMAP, POP3, SMTP):连接,登录,协议解析等
  2. 支持MIME格式邮件的解析和组信
  3. 支持MSG格式邮件的读取
  4. 一套邮件客户端引擎的架构,方便扩展协议

标准协议的支持情况:

  • POP3: 支持了USER, PASS, STAT, LIST, UIDL, RETR, TOP, DELE, QUIT, NOOP等指令
  • IMAP: 支持了文件夹、邮件等操作的指令。
    • 通用:CAPABILITY, LOGIN, LOGOUT, LIST, LSUB, UID, SEARCH
    • 文件夹:SELECT, STATUS, CREATE, RENAME, DELETE, CLOSE
    • 邮件:FETCH, COPY, EXPUNGE, APPEND, STORE
    • 邮件属性:Seen, Answered, Deleted, Flagged, Draft, Recent
    • FETCH支持:BODYSTRUCTURE, FLAGS, ENVELOPE, RFC822.SIZE, INTERNALDATE, BODY.PEEK[], BODY[]等的解析
  • SMTP: 支持了AUTH, MAIL FROM, RCPT TO, DATA, HELO, EHLO, QUIT等指令

对MIME的支持:

  • 支持multipart/mixed, multipart/related, mulitipart/alternative等复合格式
  • 支持Content-Type, Content-ID, Content-Disposition, Date等头信息的解析
  • 支持base64, quoted-printable, utf7 IMAP等格式的编解码

对MSG的支持:

  • 支持CFB格式的读取
  • 支持MSG格式常用字段信息的读取
  • 支持RTF格式转成html

本SDK还定义了一套MailEngine, IFoler, IMail, IStore, ITransport等接口,为开发者提供方便易用的API接口,同时也屏蔽协议底层细节,扩展私有协议支持可以不影响上层应用。具体使用请查看开发文档

安装使用

引用 ohos_mail_base SDK

  1. ohpm 引用
ohpm install @coremail/mail_base
  1. 源码引用

开发者可执行 clone 源码,将 lib 目录下的代码导入自己工程中引用,开发平台推荐 Dev Eco

更新日志(RleaseNote&ChangeLog)

点击查看更新日志:更新日志

约束与限制

DevEco Studio:4.1 Canary2(4.1.3.401)

SDK:API11 Canary2(4.1.0.36)

OpenHarmony系统版本:2.1.3.5(Canary)

贡献代码

使用过程中发现任何问题都可以提Issue,当然,也非常欢迎发PR

二次开发

本项目只包括了SDK的代码和DevEco的instrumentTest的测试代码,本仓库不是一个完整的DevEco项目,无法在DevEco中打开。如果要对本仓库代码进行修改,请参考如下步骤:

  1. git clone 本项目
  2. 在DevEco中新建一个空项目,会自动生成一个entry类型的项目。
  3. 将空项目中的.hvigor, AppScope, hvigor, build-profile.json5, hvigorfile.js, hvigorw, hvigorw.bat, oh-package.json5文件,复制到本项目的目录下。这样就可以使用DevEco打开。
  4. 在DevEco中删除自动生成的那个entry类型的项目。修改build-profile.json5文件,将lib和test加上 然后就可以正常编译运行。

使用本SDK的项目

  1. mail-client

兼容测试的邮箱

邮箱服务商 IMAP POP3 SMTP
139.com
189.com
wo.cn
tom.com
aliyun.com
qq.com
foxmail.com
163.com
vip.163.com
126.com
vip.126.com
yeah.net
188.com
sina.com
sina.cn
sohu.com

开源协议

Copyright 2023 Coremail论客

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2023 Coremail论客 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

ohos_mail_base是专为OpenHarmony系统开发的标准邮件协议 SDK,采用纯TypeScript语言实现。本仓库包含标准邮件协议 SDK 源码和相关使用说明文档。 展开 收起
TypeScript
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/pang-yinqiang/ohos_mail_base.git
git@gitee.com:pang-yinqiang/ohos_mail_base.git
pang-yinqiang
ohos_mail_base
ohos_mail_base
master

搜索帮助