# mail_base

**Repository Path**: fengwuhong/mail_base

## Basic Information

- **Project Name**: mail_base
- **Description**: 申请开源仓库mail_base，建设支持IMAP、POP3、SMTP标准协议能力的邮件SDK和基础功能客户端
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/openharmony-sig/mail_base
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 30
- **Created**: 2024-03-01
- **Last Updated**: 2024-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 标准邮件协议 SDK

## 介绍

**mail_base**是专为**OpenHarmony**系统开发的标准邮件协议 SDK，采用纯**TypeScript**语言实现。本仓库包含标准邮件协议 SDK 源码和基础邮件客户端 Demo 源码。

**标准邮件协议 SDK 主要支持特性如下：**

1.  支持标准协议（IMAP、POP3、SMTP）服务器配置、连接
2.  支持邮件收信、发信、读信、搜索等核心功能
3.  支持文件夹管理和操作
4.  支持协议扩展
5.  支持二次开发邮件客户端

**基础邮件客户端主要业务功能如下：**

1. 标准协议登录：IMAP、POP3、SMTP 配置
2. OAuth2 登录：如 Gmail、Outlook、163 等（_暂未实现_）
3. 账号管理：新增、删除、编辑、签名等
4. 邮件编辑：写信、草稿、回复等
5. 邮件接收：收信、解析、存储等
6. 邮件查看：读信、列表、搜索等
7. 邮件发送：发信、转发等
8. 邮件操作：标记重要、已读、移动等
9. 文件夹管理：新建、编辑、删除等

标准邮件协议 SDK，封装 SMTP，IMAP，POP3 协议，支持 MIME 邮件解析


## 更新日志（RleaseNote&ChangeLog）

点击查看更新日志：[更新日志](https://gitee.com/openharmony-sig/mail_base/blob/master/common/mail_client_sdk/CHANGELOG.md)


## 基础邮件客户端 Demo 效果

待补充


## 安装使用

### SDK引用

第 1 种方式：nmp 引用

```
ohpm install @coremail/mail_base
```

第 2 种方式：源码引用

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

### 二次开发

请参考 Wiki 了解 SDK 的使用方法：[Wiki](https://gitee.com/openharmony-sig/mail_base/blob/master/common/mail_client_sdk/README.md)


## 约束与限制
在下述版本验证通过：

```
DevEco Studio：4.1 Canary2(4.1.3.401)

SDK：API11 Canary2(4.1.0.36)

OpenHarmony系统版本：2.1.3.5（Canary）
```


## 贡献代码

使用过程中发现任何问题都可以提[Issue](https://gitee.com/openharmony-sig/mail_base/issues)给我们，当然，我们也非常欢迎你给我们发[PR](https://gitee.com/openharmony-sig/mail_base/pulls) 


## 开源协议

```
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.
```