✨ feat(tsl-api-reference): update API catalog and data dictionary
This commit is contained in:
@@ -4,7 +4,9 @@
|
||||
|
||||
声明:class
|
||||
|
||||
SMTP 内置对象
|
||||
用于连接 SMTP 服务器并发送邮件的内置对象
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
### `create(host)`
|
||||
|
||||
@@ -12,6 +14,8 @@ SMTP 内置对象
|
||||
|
||||
创建 SMTP 实例
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 创建 生成 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -24,6 +28,8 @@ SMTP 内置对象
|
||||
|
||||
连接服务器。需要设置host属性。并且不能多次connect,否则第二次之后的会报错
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 连接 登录 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -43,6 +49,8 @@ return 1;
|
||||
|
||||
断开连接
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -63,6 +71,8 @@ return 1;
|
||||
|
||||
断开并且通知服务器
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -83,6 +93,8 @@ return 1;
|
||||
|
||||
展开用户名,例如用于邮件列表。需要服务器配置,暂不支持
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -97,6 +109,8 @@ return 1;
|
||||
|
||||
登录,暂不支持。但是,在设置了Username和Password属性时,使用connect()方法就包括连接服务器和登陆功能。如需验证用户名密码可使用Authenticate()方法
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 连接 登录 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -107,6 +121,8 @@ return 1;
|
||||
|
||||
发送邮件。暂时不支持
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 发送 提交 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -148,6 +164,8 @@ return 1;
|
||||
|
||||
发送邮件
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 发送 提交 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -186,6 +204,8 @@ return 1;
|
||||
|
||||
发送命令
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 发送 提交 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -214,6 +234,8 @@ return r;
|
||||
|
||||
验证用户名。验证用户名。用户名是否存在当前服务器中,注:smtp服务器可禁止此功能
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -243,6 +265,8 @@ end;
|
||||
|
||||
服务器验证。验证用户名和密码是否能登陆smtp服务器。使用之前需要先使用connect()方法
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:boolean
|
||||
@@ -255,6 +279,8 @@ end;
|
||||
|
||||
认证类型,0:明文用户密码,1:MD5,2:SASL认证,-1:自定义认证
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 摘要 哈希 散列 digest hash 对象 实例 邮件 POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:integer
|
||||
@@ -267,6 +293,8 @@ end;
|
||||
|
||||
自定义认证类型,仅当 AuthType 设置为-1时有效;设置为"AUTH=*":自动选择服务器支持的认证类型;多个用分号连接
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP AUTH -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -279,6 +307,8 @@ end;
|
||||
|
||||
是否已经验证。需要先执行Authenticate()方法验证
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:boolean
|
||||
@@ -289,7 +319,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
主机名称或地址
|
||||
获取或设置主机名称或地址
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 获取 查询 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -301,7 +333,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
最后的命令执行结果
|
||||
获取最后的命令执行结果
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 获取 查询 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -313,7 +347,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
最后的命令执行的返回码
|
||||
获取最后的命令执行的返回码
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 获取 查询 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -325,7 +361,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
密码
|
||||
获取或设置密码
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 获取 查询 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -337,7 +375,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
主机端口
|
||||
获取或设置主机端口
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 获取 查询 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -349,7 +389,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
用户名
|
||||
获取或设置用户名
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 获取 查询 对象 实例 邮件 POP3 IMAP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -361,7 +403,9 @@ end;
|
||||
|
||||
声明:property
|
||||
|
||||
是否使用显式 TLS(即 STARTTLS 加密协议)
|
||||
控制是否使用显式 TLS(即 STARTTLS 加密协议)
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP TLS STARTTLS -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -375,6 +419,8 @@ end;
|
||||
|
||||
是否采用SSL连接。采用ssl需要设置到服务器的对应端口
|
||||
|
||||
<!-- tags: Object SMTP 邮件发送 对象 实例 邮件 POP3 IMAP SSL -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:boolean
|
||||
|
||||
Reference in New Issue
Block a user