IL3 33.U3U YD CCS M21 中华人民共和国通信行业标准 YD/T 4422--2023 基于表述性状态转移(REST)技术的业务 能力开放应用程序接口(API)邮件业务 RESTful based service capability openAPI-Email 2023-07-28发布 2023-11-01实施 中华人民共和国工业和信息化部 发布
YD/T4422-2023 目次 前言.. .Ⅱ 1范围 2规范性引用文件.. 3术语、定义和缩略语、 3.1术语和定义. I 3.2缩略语... 2 4邮件业务概述 2 5邮件业务API定义 3 5.1概述. 3 5.2资源概述.. 3 5.3数据类型. 7 6资源详细定义.. 13 6.1通用要求. 13 6.2用户接口. 13 6.3标签接口. 27 6.4草稿接口. 34 6.5邮件夹接口. 44 6.6附件接口. 52 6.7电子邮件接口 57 7安全要求.. 81 7.1认证和授权 81 7.2API访问权限和频率控制. 82 附录A(规范性)响应码要求. 83
YD/T4422--2023 前言 本文件按照GB/T1.1-2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定 起草.
请注意本文件的某些内容可能涉及专利.
本文件的发布机构不承担识别专利的责任.
本文件由中国通信标准化协会提出和归口.
本文件起草单位:西安交通大学、中国电信集团有限公司.
本文件主要起草人:曲桦、赵季红、李金艳、吴彤、杨峰义、张彦鹏、边江、刘伟、张斌.
YD/T4422-2023 基于表述性状态转移(REST)的业务能力 开放应用程序接口(API)邮件业务 1范围 本文件规定了基于表述性状态转移(REST)技术实现邮件业务的开放应用程序接口(API),包括 接口的资源定义、资源操作、数据结构和安全要求等.
本文件适用于提供邮件业务能力开放的应用程序接口(API)的研发、测试.
2规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款.
其中,注日期的引用文件, 仅该日期对应的版本适用于本文件:不注日期的引用文件,其最新版本(包括的修改单)适用于本 文件.
YD/T2144一2010基于简单邮件传输协议(SMTP)的互联网中文电子邮件地址技术要求 YD/T2423一2012基于表述性状态转移(REST)技术的电信业务能力开放平台技术要求 IETF RFC2616传输控制协议(Hypertext Transfer Protocol HTTP/1.1) IETFRFC3986统一资源标识符(URI):通用语法(Uniform Resource Identifier(URI):GenericSyntax) IETF RFC4627JavaScript 对象标记(json)的 application/json媒体类型[The application/json Media Type for JavaScript Object Notation (JSON)] 3术语、定义和缩略语 3.1术语和定义 下列术语和定义适用于本文件.
3.1.1 表述性状态转移representational state transfer 一种针对网络应用的设计和开发方式,指的是一组架构约束条件和原则,可以降低开发的复杂性, 提高系统的可伸缩性.
[来源:YD/T2423-2012]
YD/T4422-2023 3.1.2 电子邮件email 在计算机网络上,用户终端之间往来的信函.
[来源:YD/T2144-2010] 3.1.3 黑名单blackname 记录发送垃圾邮件的服务器的IP或者主机信息的名单.
[来源:YD/T1311-2004] 3.2缩略语 下列缩略语适用于本标准.
API 应用程序编程接口 Application Programming Interface Autho4A PI 网络应用程序接口授权框架 Authorization Framework for Network APIs HTML 超文本标记语言 Hypertext Markup Language HTTP 超文本传输协议 Hyper Text Transfer Protocol IP 因特网协议 Internet Protocol JSON JavaScript对象表示法 JavaScript Object Notation MIME 多功能网络邮件扩展 Multipurpose Internet Mail Extensions OMA 开放移动联盟 Open Mobile Alliance REST 表述性状态转移 Representational State Transfer SMTP 简单邮件传输协议 Simple Mail Transfer Protocol URI 统一资源标识 Uniform Resource Identifier URL 统一资源定位符 Uniform Resource Locator XML 扩展标记语言 eXtensible Markup Language XSD XML模式定义 XML Schema Definition 4邮件业务概述 电子邮件(Email)业务是指两个用户终端通过计算机网络交换电子邮件的一种服务.
该业务为一 对多服务,即每个邮件发送方可对应一个或多个邮件接收用户.
邮件业务具有一下业务特征: 一支持获取用户信息、更新用户信息、获取通讯录、添加通讯录、移出通讯录、获取黑名单、添 加黑名单、移出黑名单; 一支持创建标签、获取标签、获取标签列表、删除标签、更新标签; 一支持创建草稿、获取草稿、获取草稿列表、删除草稿、更新草稿; 一支持创建邮件夹、获取邮件夹、获取邮件夹列表、删除邮件夹、更新邮件夹;