✨ feat(tsl-api-reference): update API catalog and data dictionary
This commit is contained in:
@@ -4,7 +4,9 @@
|
||||
|
||||
声明:class
|
||||
|
||||
MailMsg 内置对象
|
||||
用于创建、解析、保存和发送邮件消息的内置对象
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
### `create()`
|
||||
|
||||
@@ -12,6 +14,8 @@ MailMsg 内置对象
|
||||
|
||||
创建 MailMsg 实例
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 创建 生成 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
### `addAttachment()`
|
||||
@@ -20,6 +24,8 @@ MailMsg 内置对象
|
||||
|
||||
添加一个文件附件的消息部分
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 添加 追加 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:messagepart
|
||||
@@ -30,6 +36,8 @@ MailMsg 内置对象
|
||||
|
||||
添加一个文本格式的消息部分
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 添加 追加 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:messagepart
|
||||
@@ -40,6 +48,8 @@ MailMsg 内置对象
|
||||
|
||||
消息的原始内容,二进制数据类型
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -54,6 +64,8 @@ MailMsg 内置对象
|
||||
|
||||
从文件中打开邮件消息
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 读取 获取 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -70,6 +82,8 @@ MailMsg 内置对象
|
||||
|
||||
从流中打开邮件消息
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 读取 获取 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -85,6 +99,8 @@ MailMsg 内置对象
|
||||
|
||||
返回指定的消息部分
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 返回 获取 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -99,6 +115,8 @@ MailMsg 内置对象
|
||||
|
||||
保存到文件中
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -115,6 +133,8 @@ MailMsg 内置对象
|
||||
|
||||
保存到流中
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -130,6 +150,8 @@ MailMsg 内置对象
|
||||
|
||||
发送命令
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 发送 提交 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -144,7 +166,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息的原始内容
|
||||
获取或设置消息的原始内容
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -156,7 +180,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
附件编码
|
||||
获取或设置附件编码
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -168,7 +194,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
临时的附件存贮目录
|
||||
获取或设置临时的附件存贮目录
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -180,7 +208,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息的暗送地址
|
||||
获取或设置消息的暗送地址
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -192,7 +222,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息的正文
|
||||
获取或设置消息的正文
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -204,7 +236,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息的抄送地址
|
||||
获取或设置消息的抄送地址
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -216,7 +250,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息的默认编码格式
|
||||
获取或设置消息的默认编码格式
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -230,6 +266,8 @@ MailMsg 内置对象
|
||||
|
||||
一些不能被放在内容里的描述串,例如inline表示在邮件中直接显示,attachment则表示当成附件,attachment可附带"filename","creation-date","modification-date", "read-date","size"等参数来描述attachment
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -242,6 +280,8 @@ MailMsg 内置对象
|
||||
|
||||
读写类型,消息内容传输时的编码类型,主要编码方式有。 7bit – 7位不编码的ASCII码,默认编码方式。 8bit – 8位不编码的原始值。 binary – 不编码的10进制数据流。 quoted-printable – 转换为7位可打印的ASCII编码方式。每个高位为1的码翻译为如=A1的16进制模式。 base64 – Base64模式,一种将8字节转换为7字节的编码方式
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP ASCII A1 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -254,6 +294,8 @@ MailMsg 内置对象
|
||||
|
||||
读写类型,消息内容类型,常见类型种类如下 text/plain text/html text/xml text/enhanced image/jpeg image/gif audio/basic audio/au video/mpeg application/octet-stream application/postscript application/ms-word application/ms-excel application/rtf multipart/mixed multipart/alternative multipart/parallel multipart/related message/rfc822 message/external-body
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -264,7 +306,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
是否转换序文
|
||||
控制是否转换序文
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 转换 编码 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -276,7 +320,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
邮件的时间
|
||||
获取或设置邮件的时间
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -290,6 +336,8 @@ MailMsg 内置对象
|
||||
|
||||
邮件的编码算法,0:MIME编码算法,1:UUEncode编码算法
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP MIME -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:integer
|
||||
@@ -300,7 +348,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
是否在文件附件无法被创建时引发异常
|
||||
控制是否在文件附件无法被创建时引发异常
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -312,7 +362,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
邮件的附加头信息
|
||||
获取或设置邮件的附加头信息
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -326,6 +378,8 @@ MailMsg 内置对象
|
||||
|
||||
邮件标志,位标示:已回复(1)已标志(2)已删除(3)草稿(4)已阅读(5)最近的(6)
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:integer
|
||||
@@ -336,7 +390,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
邮件来源
|
||||
获取或设置邮件来源
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -348,7 +404,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
邮件来源列表
|
||||
获取或设置邮件来源列表
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -360,7 +418,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息头部信息
|
||||
获取或设置消息头部信息
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -372,7 +432,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
回复地址
|
||||
获取或设置回复地址
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -384,7 +446,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
是否编码
|
||||
控制是否编码
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 判断 检查 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -396,7 +460,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
是否是一个单个部分的邮件
|
||||
指示是否是一个单个部分的邮件
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 判断 检查 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -408,7 +474,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
最后生成的头信息
|
||||
获取或设置最后生成的头信息
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -420,7 +488,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息的部分个数
|
||||
获取或设置消息的部分个数
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -432,7 +502,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
消息ID
|
||||
获取或设置消息ID
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP ID -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -446,6 +518,8 @@ MailMsg 内置对象
|
||||
|
||||
发送到的新闻组,只当采用NNTP对象的时候有用
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 发送 提交 对象 实例 邮件 SMTP POP3 IMAP NNTP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -456,7 +530,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
当为真是不解码内容
|
||||
获取或设置当为真是不解码内容
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -468,7 +544,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
当为真是不会发送附件
|
||||
获取或设置当为真是不会发送附件
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -480,7 +558,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
作者的从属组织
|
||||
获取或设置作者的从属组织
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -494,6 +574,8 @@ MailMsg 内置对象
|
||||
|
||||
优先级,0最高,4最低
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:integer
|
||||
@@ -506,6 +588,8 @@ MailMsg 内置对象
|
||||
|
||||
倘若指定对方要接收的收条,为收条的收件邮件地址
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -516,7 +600,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
收件人邮件地址
|
||||
获取或设置收件人邮件地址
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -528,7 +614,9 @@ MailMsg 内置对象
|
||||
|
||||
声明:property
|
||||
|
||||
NNTP里的回复过的邮件列表
|
||||
获取或设置NNTP里的回复过的邮件列表
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP NNTP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -540,7 +628,9 @@ NNTP里的回复过的邮件列表
|
||||
|
||||
声明:property
|
||||
|
||||
回复邮件地址
|
||||
获取或设置回复邮件地址
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -552,7 +642,9 @@ NNTP里的回复过的邮件列表
|
||||
|
||||
声明:property
|
||||
|
||||
发件人
|
||||
获取或设置发件人
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -564,7 +656,9 @@ NNTP里的回复过的邮件列表
|
||||
|
||||
声明:property
|
||||
|
||||
邮件标题
|
||||
获取或设置邮件标题
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -576,7 +670,9 @@ NNTP里的回复过的邮件列表
|
||||
|
||||
声明:property
|
||||
|
||||
唯一标识
|
||||
获取或设置唯一标识
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -590,6 +686,8 @@ NNTP里的回复过的邮件列表
|
||||
|
||||
发送邮件的时候邮件时间是否用当前时间
|
||||
|
||||
<!-- tags: Object MailMsg 邮件消息 发送 提交 对象 实例 邮件 SMTP POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:boolean
|
||||
|
||||
Reference in New Issue
Block a user