feat(tsl-api-reference): update API catalog and data dictionary

This commit is contained in:
csh
2026-08-11 18:10:24 +08:00
parent 34a3a5dec1
commit 7bd965de89
1231 changed files with 64187 additions and 18822 deletions
@@ -6,12 +6,16 @@
用于连接和登录 FTP 服务器,并管理远程目录、传输文件及发送服务器命令
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
### `create(host)`
声明:function
创建 FTP 实例
<!-- tags: Object FTP 文件传输 创建 生成 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -24,6 +28,8 @@
终止连接
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
返回:any
@@ -48,6 +54,8 @@ return obj.Abort();
改变FTP服务器上的当前目录
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -77,6 +85,8 @@ return obj.RetrieveCurrentDir();
切换到FTP服务器上当前目录的父目录
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
返回:any
@@ -103,6 +113,8 @@ return obj.RetrieveCurrentDir();
打开FTP连接
<!-- tags: Object FTP 文件传输 打开 open 文件 目录 路径 file 对象 实例 -->
可见性:public
返回:any
@@ -125,6 +137,8 @@ return obj.connect();
计算FTP服务器上指定文件的CRC值。需要FTP服务器支持XCRC功能
<!-- tags: Object FTP 文件传输 计算 求解 文件 目录 路径 file 对象 实例 CRC -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -141,6 +155,8 @@ return obj.connect();
删除FTP服务器上的文件
<!-- tags: Object FTP 文件传输 删除 移除 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -174,6 +190,8 @@ return obj.FileDate("Test.txt",0);
断开并且通知服务器
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
返回:any
@@ -182,7 +200,9 @@ return obj.FileDate("Test.txt",0);
声明:function
FTP服务器上文件的修改时间
FTP服务器上文件的修改时间
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -214,7 +234,9 @@ return DateTimeToStr(ret);
声明:function
从FTP服务器上下载文件
获取从FTP服务器上下载文件
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -249,7 +271,9 @@ obj.get("FtpTest.txt",st,0);
声明:function
FTP服务器命令以及其他帮助信息,使用FTP的HELP命令。必须在登陆连接后才可以使用Help函数
FTP服务器命令以及其他帮助信息,使用FTP的HELP命令。必须在登陆连接后才可以使用Help函数
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 HELP -->
可见性:public
@@ -266,6 +290,8 @@ obj.get("FtpTest.txt",st,0);
指出FTP服务器是否支持FTP MDTM和LIST-T 命令
<!-- tags: Object FTP 文件传输 判断 检查 文件 目录 路径 file 对象 实例 MDTM -->
可见性:public
返回:boolean
@@ -274,7 +300,9 @@ obj.get("FtpTest.txt",st,0);
声明:function
从FTP服务器上下载文件
列出从FTP服务器上下载文件
<!-- tags: Object FTP 文件传输 列出 列表 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -314,6 +342,8 @@ return AFiles.GetText();
提供FTP连接的验证,此前必须制定Username和Password属性
<!-- tags: Object FTP 文件传输 连接 登录 文件 目录 路径 file 对象 实例 -->
可见性:public
返回:any
@@ -340,6 +370,8 @@ return obj.RetrieveCurrentDir();
在FTP服务器上创建目录
<!-- tags: Object FTP 文件传输 创建 生成 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -370,6 +402,8 @@ obj.MakeDir("newDir");
向FTP服务器发送一个KEEP-ALIVE信号。服务器在长时间处于空闲状态下,使用NOOP方法可以防止服务器关闭连接
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 KEEP ALIVE NOOP -->
可见性:public
返回:any
@@ -380,6 +414,8 @@ obj.MakeDir("newDir");
上传文件到FTP服务器
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -416,6 +452,8 @@ obj.Put(st,"put.txt",false);
关闭FTP客户端连接。Quit用于文件未传输时关闭连接,如果一个文件传输进程正在进行,请优先使用Abort()
<!-- tags: Object FTP 文件传输 关闭 close 文件 目录 路径 file 对象 实例 -->
可见性:public
返回:any
@@ -426,6 +464,8 @@ obj.Put(st,"put.txt",false);
用于执行在这个类中未实现的FTP命令
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -440,6 +480,8 @@ obj.Put(st,"put.txt",false);
清除FTP客户端的账户及其设置信息
<!-- tags: Object FTP 文件传输 清除 重置 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -454,6 +496,8 @@ obj.Put(st,"put.txt",false);
移除FTP服务器上的目录
<!-- tags: Object FTP 文件传输 删除 移除 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -484,6 +528,8 @@ obj.Remove("testDir");
重命名FTP服务器指定文件
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -515,6 +561,8 @@ obj.rename("testDir","newDir");
指出服务器上是否支持REST命令
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 REST -->
可见性:public
返回:boolean
@@ -523,7 +571,9 @@ obj.rename("testDir","newDir");
声明:function
指定一个在FTP命令之后的行为
设置指定一个在FTP命令之后的行为
<!-- tags: Object FTP 文件传输 设置 修改 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -540,6 +590,8 @@ obj.rename("testDir","newDir");
请求以指定的语言返回响应的内容
<!-- tags: Object FTP 文件传输 设置 修改 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -554,6 +606,8 @@ obj.rename("testDir","newDir");
设置指定文件的最后修改时间
<!-- tags: Object FTP 文件传输 设置 修改 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -569,6 +623,8 @@ obj.rename("testDir","newDir");
设置指定文件的最后修改时间
<!-- tags: Object FTP 文件传输 设置 修改 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -584,6 +640,8 @@ obj.rename("testDir","newDir");
发送一个FTP服务器端的命令
<!-- tags: Object FTP 文件传输 发送 提交 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -596,7 +654,9 @@ obj.rename("testDir","newDir");
声明:function
服务器上文件的大小信息
服务器上文件的大小信息
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -628,6 +688,8 @@ return obj.Size("test.txt");
实现FTP的STAT命令
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 STAT -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -640,7 +702,9 @@ return obj.Size("test.txt");
声明:property
代表连接到远程FTP服务器的账户信息
获取或设置代表连接到远程FTP服务器的账户信息
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -654,6 +718,8 @@ return obj.Size("test.txt");
表示登陆验证时使用的机制。这个属性的值决定在TSL握手协议中与FTP AUTH命令交换时使用的参数
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 AUTH -->
可见性:public
类型:TAuthCmd
@@ -664,7 +730,9 @@ return obj.Size("test.txt");
声明:property
是否自动发送FEAT指令获得所支持的命令
控制是否自动发送FEAT指令获得所支持的命令
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 FEAT -->
可见性:public
@@ -678,6 +746,8 @@ return obj.Size("test.txt");
指定当使用Connect方法与FTP服务器建立会话时,FTP客户端是否自动连接
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:boolean
@@ -690,6 +760,8 @@ return obj.Size("test.txt");
表示服务器是否支持续传操作
<!-- tags: Object FTP 文件传输 判断 检查 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:boolean
@@ -702,6 +774,8 @@ return obj.Size("test.txt");
表示当前FTP数据交换中有效的传输模式设置
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:any
@@ -712,7 +786,9 @@ return obj.Size("test.txt");
声明:property
与客户端会话的数据通道绑定的端口号
获取或设置与客户端会话的数据通道绑定的端口号
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -724,7 +800,9 @@ return obj.Size("test.txt");
声明:property
FTP客户端数据通道的端口号上限
获取或设置FTP客户端数据通道的端口号上限
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -736,7 +814,9 @@ FTP客户端数据通道的端口号上限
声明:property
FTP客户端数据通道的端口号下限
获取或设置FTP客户端数据通道的端口号下限
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -750,6 +830,8 @@ FTP客户端数据通道的端口号下限
表示目录列表结构
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:string
@@ -762,6 +844,8 @@ FTP客户端数据通道的端口号下限
指定当客户端在一个NAT防火墙后发送PORT或者EPRT命令时使用的IP地址
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 NAT PORT EPRT -->
可见性:public
类型:string
@@ -774,6 +858,8 @@ FTP客户端数据通道的端口号下限
表示FTP服务器的IP地址或者主机名称
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 IP -->
可见性:public
类型:string
@@ -786,6 +872,8 @@ FTP客户端数据通道的端口号下限
返回服务器支持的语言列表
<!-- tags: Object FTP 文件传输 返回 获取 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:TStringList
@@ -798,6 +886,8 @@ FTP客户端数据通道的端口号下限
最后一条命令的返回结果,包括命令返回状态字以及结果
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:TStringList
@@ -808,7 +898,9 @@ FTP客户端数据通道的端口号下限
声明:property
侦听成功的超时时间
获取或设置侦听成功的超时时间
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -820,7 +912,9 @@ FTP客户端数据通道的端口号下限
声明:property
最后一条LIST命令的返回
获取最后一条LIST命令的返回
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 LIST -->
可见性:public
@@ -834,6 +928,8 @@ FTP客户端数据通道的端口号下限
指定FTP的数据通道连接方法,如果为真则采用被动模式
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:boolean
@@ -846,6 +942,8 @@ FTP客户端数据通道的端口号下限
如果设置为假,被动模式下依旧使用FTP的HOST属性,如果为真,则使用被动连接过来的对端IP地址。简单来说,如果设置为真,则允许分布式FTP服务,也就是对端可能是多个IP地址的FTP来发送或者接受数据
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 HOST IP -->
可见性:public
类型:boolean
@@ -856,7 +954,9 @@ FTP客户端数据通道的端口号下限
声明:property
登陆FTP服务器时用于认证的凭据
获取或设置登陆FTP服务器时用于认证的凭据
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -870,6 +970,8 @@ FTP客户端数据通道的端口号下限
用于在打开连接时用到的远程FTP服务器主机上指定的端口号
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:integer
@@ -880,7 +982,9 @@ FTP客户端数据通道的端口号下限
声明:property
FTP代理的主机IP或名称
获取或设置FTP代理的主机IP或名称
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 IP -->
可见性:public
@@ -892,7 +996,9 @@ FTP代理的主机IP或名称
声明:property
FTP代理服务器的登陆密码
获取或设置FTP代理服务器的登陆密码
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -904,7 +1010,9 @@ FTP代理服务器的登陆密码
声明:property
FTP代理服务器的端口号
获取或设置FTP代理服务器的端口号
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -918,6 +1026,8 @@ FTP代理服务器的端口号
指定连接代理服务器时使用的方法。 0:使用代理服务器的CONNECT命令直接连接 1:采用USER命令,发送USER user@hostname串进行登录。 2:登录时发送SITE命令 3:发送OPEN命令 4:使用USER,PASS命令发送代理服务器的用户名密码,发送USER user@firewalluser@hostname 和 PASS pass@firewallpass 5:先使用USER,PASS命令使用代理服务器的用户名密码,穿透代理服务器,然后使用目标的用户名和密码 6:采用USER hostuserId@hostname firewallUsername模式。 7: Novell BorderManager Proxy
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 CONNECT USER SITE -->
可见性:public
类型:integer
@@ -928,7 +1038,9 @@ FTP代理服务器的端口号
声明:property
FTP代理服务器的登陆用户名
获取或设置FTP代理服务器的登陆用户名
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -940,7 +1052,9 @@ FTP代理服务器的登陆用户名
声明:property
客户端等待FTP连接响应时间的毫秒数
获取或设置客户端等待FTP连接响应时间的毫秒数
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -954,6 +1068,8 @@ FTP代理服务器的登陆用户名
获得服务器上当前目录的名称
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:string
@@ -966,6 +1082,8 @@ FTP代理服务器的登陆用户名
表示FTP服务器是否支持完整性验证的扩展功能
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:boolean
@@ -976,7 +1094,9 @@ FTP代理服务器的登陆用户名
声明:property
远程FTP服务器的操作系统的描述信息
获取远程FTP服务器的操作系统的描述信息
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -990,6 +1110,8 @@ FTP代理服务器的登陆用户名
实现FTP的MODE命令,设置FTP的传输模式,0为非压缩格式,1为压缩格式
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 MODE -->
可见性:public
类型:integer
@@ -1000,7 +1122,9 @@ FTP代理服务器的登陆用户名
声明:property
FTP客户端在数据通道进行读操作时的等待时间的毫秒数
获取或设置FTP客户端在数据通道进行读操作时的等待时间的毫秒数
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -1014,6 +1138,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
指定传输类型,包括Binary(0)和ASCII(1),默认使用Binary方式进行传输
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 ASCII -->
可见性:public
类型:integer
@@ -1024,7 +1150,9 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
声明:property
指定是否使用快速路径连接穿越防火墙和地址转换器(NAT
获取或设置指定是否使用"快速路径"连接穿越防火墙和地址转换器(NAT
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 NAT -->
可见性:public
@@ -1038,6 +1166,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
表示FTP客户端是否需要使用清除通道命令(CCC)
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 CCC -->
可见性:public
类型:boolean
@@ -1050,6 +1180,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
指示在数据交换时是否使用了额外的IPV6端口以及是否设置为PASV模式
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 IPV6 PASV -->
可见性:public
类型:boolean
@@ -1062,6 +1194,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
指定当客户端试图获得目录列表时是否使用应该使用FTP的MLST或MLSD命令
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 MLST MLSD -->
可见性:public
类型:boolean
@@ -1072,7 +1206,9 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
声明:property
登陆FTP服务器时使用的身份验证ID
获取或设置登陆FTP服务器时使用的身份验证ID
<!-- tags: Object FTP 文件传输 获取 查询 文件 目录 路径 file 对象 实例 ID -->
可见性:public
@@ -1084,7 +1220,9 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
声明:property
是否使用显式 TLS(即 STARTTLS 加密协议)
控制是否使用显式 TLS(即 STARTTLS 加密协议)
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 TLS STARTTLS -->
可见性:public
@@ -1098,6 +1236,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
用于指定传输安全等级
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:boolean
@@ -1110,6 +1250,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
表示客户端会话是否支持RFC 2428 NAT 扩展
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 RFC NAT -->
可见性:public
类型:boolean
@@ -1120,7 +1262,9 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
声明:property
表示客户端会话是否使用了快速路径连接
表示客户端会话是否使用了"快速路径"连接
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
@@ -1134,6 +1278,8 @@ FTP客户端在数据通道进行读操作时的等待时间的毫秒数
表示客户端会话是否使用了安全FTP连接
<!-- tags: Object FTP 文件传输 文件 目录 路径 file 对象 实例 -->
可见性:public
类型:any
@@ -4,7 +4,9 @@
声明:class
IMAP 内置对象
用于连接 IMAP 服务器、管理邮箱并读取邮件的内置对象
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
### `create(host, user_name, password)`
@@ -12,6 +14,8 @@ IMAP 内置对象
创建 IMAP 实例
<!-- tags: Object IMAP 邮件收取 创建 生成 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -26,6 +30,8 @@ IMAP 内置对象
添加邮件至指定文件夹
<!-- tags: Object IMAP 邮件收取 添加 追加 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -40,6 +46,8 @@ IMAP 内置对象
获取服务器的支持命令列表
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
返回:string
@@ -59,7 +67,9 @@ return ret;
声明:function
查看邮箱文件夹邮件数量
判断查看邮箱文件夹邮件数量
<!-- tags: Object IMAP 邮件收取 判断 检查 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -75,6 +85,8 @@ return ret;
复制邮件至目标文件夹
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -87,7 +99,9 @@ return ret;
声明:function
建邮箱文件夹
建邮箱文件夹
<!-- tags: Object IMAP 邮件收取 创建 生成 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -114,6 +128,8 @@ return ret;//创建成功,返回1
删除指定邮件文件夹
<!-- tags: Object IMAP 邮件收取 删除 移除 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -128,6 +144,8 @@ return ret;//创建成功,返回1
发送空指令保持服务的连接
<!-- tags: Object IMAP 邮件收取 发送 提交 对象 实例 邮件 SMTP POP3 -->
可见性:public
返回:any
@@ -138,6 +156,8 @@ return ret;//创建成功,返回1
获取邮箱文件夹的列表信息
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -164,6 +184,8 @@ return ret;
登录,调用前必须先设置Host、Port、Username、Password属性
<!-- tags: Object IMAP 邮件收取 连接 登录 对象 实例 邮件 SMTP POP3 -->
可见性:public
返回:any
@@ -174,6 +196,8 @@ return ret;
退出登录
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
可见性:public
返回:any
@@ -184,6 +208,8 @@ return ret;
重命名邮箱文件夹
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -199,6 +225,8 @@ return ret;
RetrieveMailBoxSize
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -213,6 +241,8 @@ RetrieveMailBoxSize
认证类型,0:明文用户密码,1:MD5,2:SASL认证,-1:自定义认证
<!-- tags: Object IMAP 邮件收取 摘要 哈希 散列 digest hash 对象 实例 邮件 SMTP -->
可见性:public
类型:integer
@@ -225,6 +255,8 @@ RetrieveMailBoxSize
自定义认证类型,仅当 AuthType 设置为-1时有效;设置为"AUTH=*":自动选择服务器支持的认证类型;多个用分号连接
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 AUTH -->
可见性:public
类型:string
@@ -235,7 +267,9 @@ RetrieveMailBoxSize
声明:property
主机名称或地址
获取或设置主机名称或地址
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -247,7 +281,9 @@ RetrieveMailBoxSize
声明:property
最后的命令执行结果
获取最后的命令执行结果
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -259,7 +295,9 @@ RetrieveMailBoxSize
声明:property
最后的命令执行的返回码
获取最后的命令执行的返回码
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -271,7 +309,9 @@ RetrieveMailBoxSize
声明:property
密码
获取或设置密码
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -283,7 +323,9 @@ RetrieveMailBoxSize
声明:property
主机端口
获取或设置主机端口
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -295,7 +337,9 @@ RetrieveMailBoxSize
声明:property
用户名
获取或设置用户名
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
可见性:public
@@ -307,7 +351,9 @@ RetrieveMailBoxSize
声明:property
是否使用显式 TLS(即 STARTTLS 加密协议)
控制是否使用显式 TLS(即 STARTTLS 加密协议)
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 TLS STARTTLS -->
可见性:public
@@ -319,7 +365,9 @@ RetrieveMailBoxSize
声明:property
是否采用SSL连接
控制是否采用SSL连接
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 SSL -->
可见性:public
@@ -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
@@ -4,7 +4,9 @@
声明:class
MessagePart 内置对象
表示邮件正文、附件等消息分段的内置对象
<!-- tags: Object MessagePart 邮件分段 对象 实例 邮件 SMTP POP3 IMAP -->
### `create()`
@@ -12,6 +14,8 @@ MessagePart 内置对象
创建 MessagePart 实例
<!-- tags: Object MessagePart 邮件分段 创建 生成 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
### `loadFromFile(alias, file_name)`
@@ -20,6 +24,8 @@ MessagePart 内置对象
从文件中打开邮件消息部分,仅对附件型有效
<!-- tags: Object MessagePart 邮件分段 读取 获取 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -35,6 +41,8 @@ MessagePart 内置对象
从流中打开邮件消息部分,仅对附件型有效
<!-- tags: Object MessagePart 邮件分段 读取 获取 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -49,6 +57,8 @@ MessagePart 内置对象
保存到文件中,仅对附件型有效
<!-- tags: Object MessagePart 邮件分段 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -64,6 +74,8 @@ MessagePart 内置对象
保存到流中,仅对附件型有效
<!-- tags: Object MessagePart 邮件分段 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -76,7 +88,9 @@ MessagePart 内置对象
声明:property
内容以二进制类型的原始值
获取或设置内容以二进制类型的原始值
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -88,7 +102,9 @@ MessagePart 内置对象
声明:property
内容以字符串方式的原始值
获取或设置内容以字符串方式的原始值
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -102,6 +118,8 @@ MessagePart 内置对象
主体内容,仅对文本类型有效
<!-- tags: Object MessagePart 邮件分段 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
类型:string
@@ -112,7 +130,9 @@ MessagePart 内置对象
声明:property
消息的默认编码格式
获取或设置消息的默认编码格式
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -124,7 +144,9 @@ MessagePart 内置对象
声明:property
内容描述
获取或设置内容描述
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -136,7 +158,9 @@ MessagePart 内置对象
声明:property
内容ID
获取或设置内容ID
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP ID -->
可见性:public
@@ -148,7 +172,9 @@ MessagePart 内置对象
声明:property
内容的位置URL
获取或设置内容的位置URL
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP URL -->
可见性:public
@@ -162,6 +188,8 @@ MessagePart 内置对象
读写类型,消息内容传输时的编码类型,主要编码方式有。 7bit – 7位不编码的ASCII码,默认编码方式。 8bit – 8位不编码的原始值。 binary – 不编码的10进制数据流。 quoted-printable 转换为7位可打印的ASCII编码方式。每个高位为1的码翻译为如=A1的16进制模式。 base64 – Base64模式,一种将8字节转换为7字节的编码方式
<!-- tags: Object MessagePart 邮件分段 对象 实例 邮件 SMTP POP3 IMAP ASCII A1 -->
可见性:public
类型:string
@@ -174,6 +202,8 @@ MessagePart 内置对象
读写类型,消息内容类型,常见类型种类如下 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 MessagePart 邮件分段 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
类型:string
@@ -184,7 +214,9 @@ MessagePart 内置对象
声明:property
邮件的附加头信息
获取或设置邮件的附加头信息
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -198,6 +230,8 @@ MessagePart 内置对象
文件名,仅对附件类型有效
<!-- tags: Object MessagePart 邮件分段 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
类型:string
@@ -208,7 +242,9 @@ MessagePart 内置对象
声明:property
消息头部信息
获取或设置消息头部信息
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -220,7 +256,9 @@ MessagePart 内置对象
声明:property
是否编码
控制是否编码
<!-- tags: Object MessagePart 邮件分段 判断 检查 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -232,7 +270,9 @@ MessagePart 内置对象
声明:property
消息ID
获取或设置消息ID
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP ID -->
可见性:public
@@ -244,7 +284,9 @@ MessagePart 内置对象
声明:property
内容在MailMsg的索引
获取内容在MailMsg的索引
<!-- tags: Object MessagePart 邮件分段 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
@@ -258,6 +300,8 @@ MessagePart 内置对象
消息部分的类型,0:文本类型,1:附件类型
<!-- tags: Object MessagePart 邮件分段 对象 实例 邮件 SMTP POP3 IMAP -->
可见性:public
类型:integer
@@ -4,7 +4,9 @@
声明:class
Pop3 内置对象
用于连接 POP3 服务器并读取或删除邮件的内置对象
<!-- tags: Object Pop3 邮件接收 读取 获取 对象 实例 邮件 SMTP IMAP -->
### `create(host, user_name, password)`
@@ -12,6 +14,8 @@ Pop3 内置对象
创建 Pop3 实例
<!-- tags: Object Pop3 邮件接收 创建 生成 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -26,6 +30,8 @@ Pop3 内置对象
取服务器的支持命令列表
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:string
@@ -44,6 +50,8 @@ return pop3Obj.CAPA();
返回邮件的个数
<!-- tags: Object Pop3 邮件接收 返回 获取 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:integer
@@ -62,6 +70,8 @@ return ret.CheckMessages();//返回整数
连接服务器
<!-- tags: Object Pop3 邮件接收 连接 登录 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -86,6 +96,8 @@ return ret.CheckMessages();
删除指定的邮件,返回删除是否正确
<!-- tags: Object Pop3 邮件接收 删除 移除 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -100,6 +112,8 @@ return ret.CheckMessages();
断开连接
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -110,6 +124,8 @@ return ret.CheckMessages();
断开并且通知服务器
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -120,6 +136,8 @@ return ret.CheckMessages();
发送空指令保持服务的连接
<!-- tags: Object Pop3 邮件接收 发送 提交 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -128,7 +146,9 @@ return ret.CheckMessages();
声明:function
登录,此前必须制定Username和Password属性
连接登录,此前必须制定Username和Password属性
<!-- tags: Object Pop3 邮件接收 连接 登录 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -140,6 +160,8 @@ return ret.CheckMessages();
复位,撤销所有本次会话中的删除操作
<!-- tags: Object Pop3 邮件接收 清除 重置 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:boolean
@@ -150,6 +172,8 @@ return ret.CheckMessages();
取邮件的内容
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -165,6 +189,8 @@ return ret.CheckMessages();
取邮件的内容,仅仅取邮件的头部信息,不取附件等内容
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -180,6 +206,8 @@ return ret.CheckMessages();
获取邮箱的大小
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:integer
@@ -198,6 +226,8 @@ return pop3Obj.RetrieveMailBoxSize();
取指定邮件的大小
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -220,6 +250,8 @@ return pop3Obj.RetrieveMsgSize(1);
取邮件的原始内容
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -235,6 +267,8 @@ return pop3Obj.RetrieveMsgSize(1);
发送命令
<!-- tags: Object Pop3 邮件接收 发送 提交 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -257,7 +291,9 @@ return array(r,cr,rc);
声明:function
取邮件的前N行内容
转换取邮件的前N行内容
<!-- tags: Object Pop3 邮件接收 转换 编码 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -285,6 +321,8 @@ else return "获取指定邮件前3行内容失败!";
取服务器的邮件唯一标示列表
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -307,6 +345,8 @@ return ids;
认证类型,0:明文用户密码,1:MD5,2:SASL认证,-1:自定义认证
<!-- tags: Object Pop3 邮件接收 摘要 哈希 散列 digest hash 对象 实例 邮件 SMTP -->
可见性:public
类型:integer
@@ -319,6 +359,8 @@ return ids;
自定义认证类型,仅当 AuthType 设置为-1时有效;设置为"AUTH=*":自动选择服务器支持的认证类型;多个用分号连接
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP AUTH -->
可见性:public
类型:string
@@ -329,7 +371,9 @@ return ids;
声明:property
是否在连接的时候自动登录
控制是否在连接的时候自动登录
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -341,7 +385,9 @@ return ids;
声明:property
取服务器的支持命令列表(不重新发送命令)
获取取服务器的支持命令列表(不重新发送命令)
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -353,7 +399,9 @@ return ids;
声明:property
是否是MD5认证
指示是否是MD5认证
<!-- tags: Object Pop3 邮件接收 摘要 哈希 散列 digest hash 判断 检查 对象 实例 -->
可见性:public
@@ -365,7 +413,9 @@ return ids;
声明:property
是否执行过CAPA命令
指示是否执行过CAPA命令
<!-- tags: Object Pop3 邮件接收 判断 检查 对象 实例 邮件 SMTP IMAP CAPA -->
可见性:public
@@ -377,7 +427,9 @@ return ids;
声明:property
主机名称或地址
获取或设置主机名称或地址
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -389,7 +441,9 @@ return ids;
声明:property
最后的命令执行结果
获取最后的命令执行结果
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -401,7 +455,9 @@ return ids;
声明:property
最后的命令执行的返回码
获取最后的命令执行的返回码
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -413,7 +469,9 @@ return ids;
声明:property
密码
获取或设置密码
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -425,7 +483,9 @@ return ids;
声明:property
主机端口
获取或设置主机端口
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -437,7 +497,9 @@ return ids;
声明:property
用户名
获取或设置用户名
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -449,7 +511,9 @@ return ids;
声明:property
是否使用显式 TLS(即 STARTTLS 加密协议)
控制是否使用显式 TLS(即 STARTTLS 加密协议)
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP TLS STARTTLS -->
可见性:public
@@ -461,7 +525,9 @@ return ids;
声明:property
是否采用SSL连接
控制是否采用SSL连接
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP SSL -->
可见性:public
@@ -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
@@ -4,7 +4,9 @@
声明:class
TCipher 内置对象
提供对称加密和解密能力的内置对象
<!-- tags: Object TCipher 对称加密 对象 实例 -->
### `create(mode)`
@@ -12,13 +14,15 @@ TCipher 内置对象
创建 TCipher 实例
<!-- tags: Object TCipher 对称加密 创建 生成 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------ | ------- | -------------- |
| `mode` | integer | mode,取值见下 |
### mode 取值
#### `mode` 取值
- `1` — DES_ECB(密钥长度(字节)8,IV长度(字节)0)
- `2` — DEC_CBC(密钥长度(字节)8,IV长度(字节)8)
@@ -47,11 +51,13 @@ TCipher 内置对象
字符串s的内容解密,返回解密后的字符串
<!-- tags: Object TCipher 对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `s` | any | s |
| ---- | ---- | ---- |
| `s` | any | s |
返回:string
@@ -61,14 +67,16 @@ TCipher 内置对象
对文件src_filename进行解密,加密后的内容写入dest_filename文件中
<!-- tags: Object TCipher 对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `src_alias` | any | src_alias |
| `src_filename` | any | src_filename |
| `dest_alias` | any | dest_alias |
| `dest_filename` | any | dest_filename |
| 参数 | 类型 | 说明 |
| --------------- | ---- | ------------- |
| `src_alias` | any | src_alias |
| `src_filename` | any | src_filename |
| `dest_alias` | any | dest_alias |
| `dest_filename` | any | dest_filename |
返回:any
@@ -78,11 +86,13 @@ TCipher 内置对象
对字符串s的内容加密,返回加密后的字符串
<!-- tags: Object TCipher 对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `s` | any | s |
| ---- | ---- | ---- |
| `s` | any | s |
返回:string
@@ -92,14 +102,16 @@ TCipher 内置对象
对文件src_filename进行加密,加密后的内容写入dest_filename文件中
<!-- tags: Object TCipher 对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `src_alias` | any | src_alias |
| `src_filename` | any | src_filename |
| `dest_alias` | any | dest_alias |
| `dest_filename` | any | dest_filename |
| 参数 | 类型 | 说明 |
| --------------- | ---- | ------------- |
| `src_alias` | any | src_alias |
| `src_filename` | any | src_filename |
| `dest_alias` | any | dest_alias |
| `dest_filename` | any | dest_filename |
返回:any
@@ -109,6 +121,8 @@ TCipher 内置对象
初始化向量,hex字符串
<!-- tags: Object TCipher 对称加密 对象 实例 -->
可见性:public
类型:string
@@ -121,6 +135,8 @@ TCipher 内置对象
秘钥,hex字符串
<!-- tags: Object TCipher 对称加密 对象 实例 -->
可见性:public
类型:string
@@ -131,7 +147,9 @@ TCipher 内置对象
声明:property
密钥长度
获取密钥长度
<!-- tags: Object TCipher 对称加密 获取 查询 对象 实例 -->
可见性:public
@@ -143,7 +161,9 @@ TCipher 内置对象
声明:property
初始化向量长度
获取初始化向量长度
<!-- tags: Object TCipher 对称加密 获取 查询 对象 实例 -->
可见性:public
@@ -155,7 +175,9 @@ TCipher 内置对象
声明:property
算法类型
设置算法类型
<!-- tags: Object TCipher 对称加密 设置 修改 对象 实例 -->
可见性:public
@@ -167,7 +189,9 @@ TCipher 内置对象
声明:property
密码
设置密码
<!-- tags: Object TCipher 对称加密 设置 修改 对象 实例 -->
可见性:public
@@ -4,7 +4,9 @@
声明:class
TCookie 内置对象
表示 HTTP Cookie 名称、值和属性的内置对象
<!-- tags: Object TCookie Cookie 网络 HTTP 请求 network 对象 实例 -->
### `assign(src)`
@@ -12,6 +14,8 @@ TCookie 内置对象
从Src复制Cookie的内容
<!-- tags: Object TCookie Cookie 网络 HTTP 请求 network 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -26,6 +30,8 @@ TCookie 内置对象
复制Cookie的内容到Des
<!-- tags: Object TCookie Cookie 网络 HTTP 请求 network 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -38,7 +44,9 @@ TCookie 内置对象
声明:function
Cookie在Header里的串
Cookie在Header里的串
<!-- tags: Object TCookie Cookie 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -48,7 +56,9 @@ TCookie 内置对象
声明:property
Cookie的作用域
获取或设置Cookie的作用域
<!-- tags: Object TCookie Cookie 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -60,7 +70,9 @@ Cookie的作用域
声明:property
Cookie的过期时间
获取或设置Cookie的过期时间
<!-- tags: Object TCookie Cookie 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -72,7 +84,9 @@ Cookie的过期时间
声明:property
Cookie的名字
获取或设置Cookie的名字
<!-- tags: Object TCookie Cookie 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -84,7 +98,9 @@ Cookie的名字
声明:property
Cookie的作用路径
获取或设置Cookie的作用路径
<!-- tags: Object TCookie Cookie 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -96,7 +112,9 @@ Cookie的作用路径
声明:property
是否仅对HTTPS安全连接有效
控制是否仅对HTTPS安全连接有效
<!-- tags: Object TCookie Cookie 网络 HTTP 请求 network 对象 实例 HTTPS -->
可见性:public
@@ -108,7 +126,9 @@ Cookie的作用路径
声明:property
Cookie的值
获取或设置Cookie的值
<!-- tags: Object TCookie Cookie 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -4,7 +4,9 @@
声明:class
TCookieCollection 内置对象
用于创建、查找和管理 HTTP Cookie 集合的内置对象
<!-- tags: Object 查找 搜索 lookup 网络 HTTP 请求 network 对象 实例 -->
### `add()`
@@ -12,6 +14,8 @@ TCookieCollection 内置对象
添加Cookie
<!-- tags: Object 添加 追加 网络 HTTP 请求 network 对象 实例 -->
可见性:public
返回:TCookie
@@ -22,6 +26,8 @@ TCookieCollection 内置对象
删除所有的Cookie
<!-- tags: Object 删除 移除 网络 HTTP 请求 network 对象 实例 -->
可见性:public
返回:any
@@ -32,6 +38,8 @@ TCookieCollection 内置对象
取指定序号的Cookie
<!-- tags: Object 网络 HTTP 请求 network 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -44,7 +52,9 @@ TCookieCollection 内置对象
声明:property
包括Cookie的个数
获取包括Cookie的个数
<!-- tags: Object 获取 查询 网络 HTTP 请求 network 对象 实例 -->
可见性:public
@@ -58,6 +68,8 @@ TCookieCollection 内置对象
返回WebResponse对象
<!-- tags: Object 返回 获取 网络 HTTP 请求 network 对象 实例 -->
可见性:public
类型:TWebResponse
@@ -4,7 +4,9 @@
声明:class
TFileStream 内置对象
以文件为存储后端并提供流式读写能力的内置对象
<!-- tags: Object TFileStream 文件流 文件 目录 路径 file 对象 实例 -->
父类:`TStream`
@@ -14,22 +16,24 @@ TFileStream 内置对象
创建 TFileStream 实例
<!-- tags: Object TFileStream 文件流 创建 生成 文件 目录 路径 file 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `alias` | string | 字符串类型,目录别名 |
| `file_name` | string | 字符串类型,文件名 |
| 参数 | 类型 | 说明 |
| ----------- | ------- | ---------------------------------------------- |
| `alias` | string | 字符串类型,目录别名 |
| `file_name` | string | 字符串类型,文件名 |
| `file_mode` | integer | 整数类型。为打开模式和共享模式的组合值(相加) |
### file_mode 打开模式取值
#### `file_mode` 取值
- `65535` — 创建
- `0` — 只读
- `1` — 只写
- `2` — 读写
### file_mode 共享模式取值
#### `file_mode` 取值
- `0` — FCBs打开模式共享
- `16` — 禁止共享打开
@@ -4,7 +4,9 @@
声明:class
THandleStream 内置对象
封装系统句柄并提供流式读写能力的内置对象
<!-- tags: Object THandleStream 句柄流 对象 实例 -->
父类:`TStream`
@@ -14,6 +16,8 @@ THandleStream 内置对象
创建 THandleStream 实例
<!-- tags: Object THandleStream 句柄流 创建 生成 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -4,7 +4,9 @@
声明:class
THashedStringList 内置对象
使用哈希索引加速查找的字符串列表内置对象
<!-- tags: Object 哈希索引 哈希表 hash 查找 搜索 lookup 数组 列表 array list 字符串 -->
父类:`TStringList`
@@ -14,4 +16,6 @@ THashedStringList 内置对象
创建 THashedStringList 实例
<!-- tags: Object 创建 生成 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
@@ -4,7 +4,9 @@
声明:class
TIniFile 内置对象
用于读取和写入 INI 配置文件的内置对象
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
### `create(alias, file_name)`
@@ -12,6 +14,8 @@ TIniFile 内置对象
创建 TIniFile 实例
<!-- tags: Object TIniFile INI 文件 创建 生成 目录 路径 file 数据库 SQL database -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -25,6 +29,8 @@ TIniFile 内置对象
删除指定的键
<!-- tags: Object TIniFile INI 文件 删除 移除 目录 路径 file 数据库 SQL database -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -40,6 +46,8 @@ TIniFile 内置对象
删除章节
<!-- tags: Object TIniFile INI 文件 删除 移除 目录 路径 file 数据库 SQL database -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -52,7 +60,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -68,7 +78,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -84,7 +96,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -100,7 +114,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -116,7 +132,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -132,7 +150,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -148,7 +168,9 @@ TIniFile 内置对象
声明:function
读INI章节的所有键名
INI章节的所有键名
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -163,7 +185,9 @@ TIniFile 内置对象
声明:function
读INI章节的所有章节名
INI章节的所有章节名
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -177,7 +201,9 @@ TIniFile 内置对象
声明:function
读INI章节的所有内容
INI章节的所有内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -192,7 +218,9 @@ TIniFile 内置对象
声明:function
读INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 读取 获取 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -208,7 +236,9 @@ TIniFile 内置对象
声明:function
是否存在指定章节名
判断是否存在指定章节名
<!-- tags: Object TIniFile INI 文件 判断 检查 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -222,7 +252,9 @@ TIniFile 内置对象
声明:function
是否存在指定的键
判断是否存在指定的键
<!-- tags: Object TIniFile INI 文件 判断 检查 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -237,7 +269,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -253,7 +287,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -269,7 +305,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -285,7 +323,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -301,7 +341,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -317,7 +359,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -333,7 +377,9 @@ TIniFile 内置对象
声明:function
写INI内容
INI内容
<!-- tags: Object TIniFile INI 文件 写入 保存 目录 路径 file 数据库 SQL database -->
可见性:public
@@ -4,7 +4,9 @@
声明:class
TMemIniFile 内置对象
在内存中读取、修改和保存 INI 配置的内置对象
<!-- tags: Object 读取 获取 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
### `create()`
@@ -12,6 +14,8 @@ TMemIniFile 内置对象
创建 TMemIniFile 实例
<!-- tags: Object 创建 生成 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
可见性:public
### `clear()`
@@ -20,6 +24,8 @@ TMemIniFile 内置对象
清除掉内容
<!-- tags: Object 清除 重置 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
可见性:public
返回:any
@@ -45,7 +51,9 @@ return getObj.GetText();
声明:function
所有内容
取所有内容
<!-- tags: Object 获取 查询 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
可见性:public
@@ -76,6 +84,8 @@ return getObj.GetText();
设置所有内容
<!-- tags: Object 设置 修改 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -105,6 +115,8 @@ return getObj.GetText();
读写类型,决定节和键名是否大小写相关
<!-- tags: Object 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
可见性:public
类型:boolean
@@ -4,7 +4,9 @@
声明:class
TMemoryStream 内置对象
以内存缓冲区保存和操作流数据的内置对象
<!-- tags: Object TMemoryStream 内存流 写入 保存 对象 实例 -->
### `create()`
@@ -12,6 +14,8 @@ TMemoryStream 内置对象
创建 TMemoryStream 实例
<!-- tags: Object TMemoryStream 内存流 创建 生成 对象 实例 -->
可见性:public
### `clear()`
@@ -20,6 +24,8 @@ TMemoryStream 内置对象
清除内容
<!-- tags: Object TMemoryStream 内存流 清除 重置 对象 实例 -->
可见性:public
返回:any
@@ -28,7 +34,9 @@ TMemoryStream 内置对象
声明:function
从指定的文件中载内容
从指定的文件中载内容
<!-- tags: Object TMemoryStream 内存流 读取 获取 对象 实例 -->
可见性:public
@@ -43,7 +51,9 @@ TMemoryStream 内置对象
声明:function
从指定的流中载内容
从指定的流中载内容
<!-- tags: Object TMemoryStream 内存流 读取 获取 对象 实例 -->
可见性:public
@@ -59,6 +69,8 @@ TMemoryStream 内置对象
将内容存贮到指定的文件中
<!-- tags: Object TMemoryStream 内存流 写入 保存 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -74,6 +86,8 @@ TMemoryStream 内置对象
将内容保存到指定的流中
<!-- tags: Object TMemoryStream 内存流 写入 保存 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -4,7 +4,9 @@
声明:class
TRegistryIniFile 内置对象
以系统注册表为存储后端的 INI 配置内置对象
<!-- tags: Object 文件 目录 路径 file 数据库 SQL database 对象 实例 INI -->
父类:`TIniFile`
@@ -14,6 +16,8 @@ TRegistryIniFile 内置对象
创建 TRegistryIniFile 实例
<!-- tags: Object 创建 生成 文件 目录 路径 file 数据库 SQL database 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -4,7 +4,9 @@
声明:class
TRSA 内置对象
提供 RSA 非对称加密、解密和签名能力的内置对象
<!-- tags: Object TRSA 非对称加密 对象 实例 RSA -->
### `create()`
@@ -12,6 +14,8 @@ TRSA 内置对象
创建 TRSA 实例
<!-- tags: Object TRSA 非对称加密 创建 生成 对象 实例 -->
可见性:public
### `priDecrypt(s)`
@@ -20,6 +24,8 @@ TRSA 内置对象
对字符串s的内容用私钥解密
<!-- tags: Object TRSA 非对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -34,6 +40,8 @@ TRSA 内置对象
对字符串s的内容用私钥加密
<!-- tags: Object TRSA 非对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -48,6 +56,8 @@ TRSA 内置对象
对字符串s的内容用公钥解密
<!-- tags: Object TRSA 非对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -62,6 +72,8 @@ TRSA 内置对象
对字符串s的内容用公钥加密
<!-- tags: Object TRSA 非对称加密 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -76,6 +88,8 @@ TRSA 内置对象
生成指定位数的公钥和私钥,位数必须是256的正整数倍,最大4096
<!-- tags: Object TRSA 非对称加密 对象 实例 -->
可见性:public
类型:any
@@ -86,7 +100,9 @@ TRSA 内置对象
声明:property
私钥
获取或设置私钥
<!-- tags: Object TRSA 非对称加密 获取 查询 对象 实例 -->
可见性:public
@@ -98,7 +114,9 @@ TRSA 内置对象
声明:property
公钥
获取或设置公钥
<!-- tags: Object TRSA 非对称加密 获取 查询 对象 实例 -->
可见性:public
@@ -4,13 +4,17 @@
声明:class
TSession 内置对象
表示服务端会话及其键值数据的内置对象
<!-- tags: Object TSession 会话 对象 实例 -->
### `LastActive`
声明:property
最后活动时间
获取最后活动时间
<!-- tags: Object TSession 会话 获取 查询 对象 实例 -->
可见性:public
@@ -22,7 +26,9 @@ TSession 内置对象
声明:property
非活动的失效秒数
获取或设置非活动的失效秒数
<!-- tags: Object TSession 会话 获取 查询 对象 实例 -->
可见性:public
@@ -34,7 +40,9 @@ TSession 内置对象
声明:property
被引用的个数
获取被引用的个数
<!-- tags: Object TSession 会话 获取 查询 对象 实例 -->
可见性:public
@@ -46,7 +54,9 @@ TSession 内置对象
声明:property
Session的标识
获取Session的标识
<!-- tags: Object TSession 会话 获取 查询 对象 实例 -->
可见性:public
@@ -58,7 +68,9 @@ Session的标识
声明:property
Session的所属ID
获取Session的所属ID
<!-- tags: Object TSession 会话 获取 查询 对象 实例 ID -->
可见性:public
@@ -4,7 +4,9 @@
声明:class
TSessionMan 内置对象
用于创建、查找、维护和删除服务端会话的内置对象
<!-- tags: Object TSessionMan 会话管理 查找 搜索 lookup 对象 实例 -->
### `create()`
@@ -12,6 +14,8 @@ TSessionMan 内置对象
创建 TSessionMan 实例
<!-- tags: Object TSessionMan 会话管理 创建 生成 对象 实例 -->
可见性:public
### `deleteSession(id, session_id)`
@@ -20,6 +24,8 @@ TSessionMan 内置对象
删除会话
<!-- tags: Object TSessionMan 会话管理 删除 移除 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -33,7 +39,9 @@ TSessionMan 内置对象
声明:function
一个已有的会话
一个已有的会话
<!-- tags: Object TSessionMan 会话管理 获取 查询 对象 实例 -->
可见性:public
@@ -48,7 +56,9 @@ TSessionMan 内置对象
声明:function
建一个会话
建一个会话
<!-- tags: Object TSessionMan 会话管理 创建 生成 对象 实例 -->
可见性:public
@@ -63,7 +73,9 @@ TSessionMan 内置对象
声明:function
指定用户的在线会话列表,一般用于调试用
指定用户的在线会话列表,一般用于调试用
<!-- tags: Object TSessionMan 会话管理 获取 查询 对象 实例 -->
可见性:public
@@ -78,7 +90,9 @@ TSessionMan 内置对象
声明:function
在线的ID列表
在线的ID列表
<!-- tags: Object TSessionMan 会话管理 获取 查询 对象 实例 ID -->
可见性:public
@@ -0,0 +1,43 @@
# Object - TSLObj
## `TSLObj`
声明:class
表示由 TSL 类创建或扩展插件注册的 TSL 对象类型
<!-- tags: 对象类型 对象 类 实例 TSLObj object -->
### `classInfo(n)`
声明:function
获取当前对象的类定义信息或类类型
<!-- tags: 对象 类信息 类型信息 反射 introspection TSLObj object -->
可见性:public
| 参数 | 类型 | 说明 |
| ---- | ------- | --------------------------------------------------------- |
| `n` | integer | 可选。传入 `1` 返回当前对象的类类型,省略时返回类定义信息 |
返回:array\|tclass
省略 `n` 时,返回结果包含 `classname``inherited``members``properties``subs` 字段
#### 示例
```tsl
obj := new ClassInfoProbe();
info := obj.classInfo();
echo info["classname"], "\n";
class_type := obj.classInfo(1);
restored := createObject(class_type);
echo restored is class(ClassInfoProbe), "\n";
type ClassInfoProbe = class
end;
// 输出:classinfoprobe
// 输出:1
```
@@ -4,7 +4,9 @@
声明:class
TStream 内置对象
定义顺序读写、定位和复制操作的流基类
<!-- tags: Object TStream 流基类 对象 实例 -->
### `copyFrom(src, count)`
@@ -12,6 +14,8 @@ TStream 内置对象
复制流,复制成功后当前位置会移动Count个位置
<!-- tags: Object TStream 流基类 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -25,7 +29,9 @@ TStream 内置对象
声明:function
内容
内容
<!-- tags: Object TStream 流基类 读取 获取 对象 实例 -->
可见性:public
@@ -42,6 +48,8 @@ TStream 内置对象
移动指针
<!-- tags: Object TStream 流基类 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -57,6 +65,8 @@ TStream 内置对象
设置大小。私有方法,实例与继承类无法访问。改变大小可通过属性Size进行赋值设置
<!-- tags: Object TStream 流基类 设置 修改 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -71,6 +81,8 @@ TStream 内置对象
写入内容
<!-- tags: Object TStream 流基类 写入 保存 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -86,6 +98,8 @@ TStream 内置对象
读写类型。设置或者得到当前的位置
<!-- tags: Object TStream 流基类 对象 实例 -->
可见性:public
类型:integer
@@ -98,6 +112,8 @@ TStream 内置对象
读写类型。设置或者得到大小
<!-- tags: Object TStream 流基类 对象 实例 -->
可见性:public
类型:integer
@@ -4,7 +4,9 @@
声明:class
TStringList 内置对象
提供字符串集合存储、查找、排序和名称值管理能力的内置对象
<!-- tags: Object TStringList 字符串列表 排序 sort 查找 搜索 lookup 数组 列表 array list -->
### `create()`
@@ -12,6 +14,8 @@ TStringList 内置对象
创建 TStringList 实例
<!-- tags: Object TStringList 字符串列表 创建 生成 数组 列表 array list 字符串 文本 string -->
可见性:public
### `add(s)`
@@ -20,6 +24,8 @@ TStringList 内置对象
添加字符串
<!-- tags: Object TStringList 字符串列表 添加 追加 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -51,6 +57,8 @@ return r;
将Strings里的字符串批量添加
<!-- tags: Object TStringList 字符串列表 添加 追加 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -76,6 +84,8 @@ return obj.CommaText;
添加字符串,与Add相同,但不返回索引号
<!-- tags: Object TStringList 字符串列表 添加 追加 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -90,6 +100,8 @@ return obj.CommaText;
将内容复制成和src里的内容一样
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -116,6 +128,8 @@ return array(obj2.Delimiter,obj2.DelimitedText);
清除掉所有内容
<!-- tags: Object TStringList 字符串列表 清除 重置 数组 列表 array list 字符串 文本 string -->
可见性:public
返回:any
@@ -126,6 +140,8 @@ return array(obj2.Delimiter,obj2.DelimitedText);
删除指定索引
<!-- tags: Object TStringList 字符串列表 删除 移除 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -140,6 +156,8 @@ return array(obj2.Delimiter,obj2.DelimitedText);
比较两个内容是否相同
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -154,6 +172,8 @@ return array(obj2.Delimiter,obj2.DelimitedText);
将两个位置的内容互相交换
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -178,6 +198,8 @@ return obj.CommaText;
查找字符串。仅对已经排序好的TStringlist有效,未排序的请用IndexOf
<!-- tags: Object TStringList 字符串列表 排序 sort 查找 搜索 lookup 数组 列表 array list -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -204,6 +226,8 @@ else return '查找失败';
返回字符串所在的索引号。查找与大小写敏感设置有关
<!-- tags: Object TStringList 字符串列表 查找 搜索 lookup 返回 获取 数组 列表 array list -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -218,6 +242,8 @@ else return '查找失败';
返回Name键值所在的索引号
<!-- tags: Object TStringList 字符串列表 返回 获取 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -232,6 +258,8 @@ else return '查找失败';
插入字符串在指定索引号。仅未排序的场景适用,已排序的情况请用 Add
<!-- tags: Object TStringList 字符串列表 排序 sort 添加 追加 数组 列表 array list 字符串 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -245,7 +273,9 @@ else return '查找失败';
声明:function
从指定的文件中载内容
从指定的文件中载内容
<!-- tags: Object TStringList 字符串列表 读取 获取 数组 列表 array list 字符串 文本 string -->
可见性:public
@@ -269,7 +299,9 @@ return obj.CommaText;
声明:function
从指定的流中载内容
从指定的流中载内容
<!-- tags: Object TStringList 字符串列表 读取 获取 数组 列表 array list 字符串 文本 string -->
可见性:public
@@ -296,6 +328,8 @@ return obj.CommaText;
将指定位置的内容移动到新位置
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -311,6 +345,8 @@ return obj.CommaText;
取第Index个Name=Value串的Name串。Index从0开始
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -325,6 +361,8 @@ return obj.CommaText;
将内容存贮到指定的文件中
<!-- tags: Object TStringList 字符串列表 写入 保存 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -349,6 +387,8 @@ obj.SaveToFile('',pathName);
将内容保存到指定的流中
<!-- tags: Object TStringList 字符串列表 写入 保存 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -377,6 +417,8 @@ return ws.size; //返回20
设置text的内容,与设置属性Text的操作相同
<!-- tags: Object TStringList 字符串列表 设置 修改 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -391,6 +433,8 @@ return ws.size; //返回20
排序
<!-- tags: Object TStringList 字符串列表 排序 sort 数组 列表 array list 字符串 文本 string -->
可见性:public
返回:any
@@ -401,6 +445,8 @@ return ws.size; //返回20
取或者设置指定索引的字符串。下标从0开始
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -424,6 +470,8 @@ return obj.strings(1); //读
取或者设置指定索引的字符串。功能同Strings,区别在于读取时StringsW返回的是宽字节字符串,而Strings返回的是多字节字符串
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -438,6 +486,8 @@ return obj.strings(1); //读
读取或写入第Index个串的Value值。Index下标从0开始
<!-- tags: Object TStringList 字符串列表 读取 获取 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -463,6 +513,8 @@ return array(s0,obj.DelimitedText);
设置或者取得Name=Value模式串中指定的Name的Value值
<!-- tags: Object TStringList 字符串列表 设置 修改 数组 列表 array list 字符串 文本 string -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -493,6 +545,8 @@ return r;
容量,如果已知需要的字符串比较多,预先设置容量会有比较好的性能
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
类型:integer
@@ -505,6 +559,8 @@ return r;
大小写敏感,决定排序或者查找时是否大小写敏感。设置为真则表示大小写敏感,为假为大小写不敏感,默认为假
<!-- tags: Object TStringList 字符串列表 排序 sort 查找 搜索 lookup 数组 列表 array list -->
可见性:public
类型:boolean
@@ -515,7 +571,9 @@ return r;
声明:property
逗号分割串。将每个字符串用,分割连接起来。若字符串中间有逗号,则在字符串两头加号(注,单引号无效),若字符串中还包含号,如字符串 3,a"bc,则用'"3,a""bc"'表达
逗号分割串。将每个字符串用,分割连接起来。若字符串中间有逗号,则在字符串两头加"号(注,单引号无效),若字符串中还包含"号,如字符串' 3,a"bc',则用'"3,a""bc"'表达
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
@@ -529,6 +587,8 @@ return r;
功能同CommaText,区别是在读取时CommaTextW返回为宽字节字符串,而CommaText返回的是多字节字符串
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
类型:string
@@ -539,7 +599,9 @@ return r;
声明:property
字符串个数
获取字符串个数
<!-- tags: Object TStringList 字符串列表 获取 查询 数组 列表 array list 字符串 文本 string -->
可见性:public
@@ -551,7 +613,9 @@ return r;
声明:property
用分割符连接起来的单个字符串。连接符用Delimiter属性指定,默认为逗号。而当字符串中存在连接符时,用QuoteChar加在字符串两端。当QuoteChar为,且Delimiter为逗号时,DelimitedText的结果和CommaText一样
用分割符连接起来的单个字符串。连接符用Delimiter属性指定,默认为逗号。而当字符串中存在连接符时,用QuoteChar加在字符串两端。当QuoteChar为",且Delimiter为逗号时,DelimitedText的结果和CommaText一样
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
@@ -565,6 +629,8 @@ return r;
DelmitedText所依赖的连接符,默认为逗号
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
类型:string
@@ -577,6 +643,8 @@ DelmitedText所依赖的连接符,默认为逗号
重复串时的行为控制,0:忽略重复串(默认值),1:允许重复串,2:重复串出错。排序时有效
<!-- tags: Object TStringList 字符串列表 排序 sort 数组 列表 array list 字符串 文本 string -->
可见性:public
类型:integer
@@ -589,6 +657,8 @@ DelmitedText所依赖的连接符,默认为逗号
获取Text的值
<!-- tags: Object TStringList 字符串列表 获取 查询 数组 列表 array list 字符串 文本 string -->
可见性:public
类型:string
@@ -601,6 +671,8 @@ DelmitedText所依赖的连接符,默认为逗号
获取Text的值,并以宽字符串类型返回
<!-- tags: Object TStringList 字符串列表 获取 查询 数组 列表 array list 字符串 文本 string -->
可见性:public
类型:string
@@ -613,6 +685,8 @@ DelmitedText所依赖的连接符,默认为逗号
Name,Value之间的间隔符,默认为=
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
类型:string
@@ -625,6 +699,8 @@ Name,Value之间的间隔符,默认为=
DelmitedText所依赖的引号符。一般在串中存在分割符时使用
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
类型:string
@@ -637,6 +713,8 @@ DelmitedText所依赖的引号符。一般在串中存在分割符时使用
是否已经排序,设置为真则进行排序
<!-- tags: Object TStringList 字符串列表 排序 sort 数组 列表 array list 字符串 文本 string -->
可见性:public
类型:boolean
@@ -649,6 +727,8 @@ DelmitedText所依赖的引号符。一般在串中存在分割符时使用
以回车换行分割每个字符串连接起来的单个串。如果存在包括回车换行的串,就会有混淆,如果要没有混淆,则需要用DelmitedText或者CommaText
<!-- tags: Object TStringList 字符串列表 数组 列表 array list 字符串 文本 string text 对象 -->
可见性:public
类型:string
@@ -661,6 +741,8 @@ DelmitedText所依赖的引号符。一般在串中存在分割符时使用
功能同Text,区别在于在读取时TextW返回为宽字节字符串,而Text返回的是多字节字符串
<!-- tags: Object TStringList 字符串列表 读取 获取 数组 列表 array list 字符串 文本 string -->
可见性:public
类型:string
@@ -4,7 +4,9 @@
声明:class
TWebRequest 内置对象
封装 HTTP 请求头、请求参数、Cookie 和请求正文的内置对象
<!-- tags: Object TWebRequest Web 请求 对象 实例 HTTP -->
### `create()`
@@ -12,6 +14,8 @@ TWebRequest 内置对象
创建 TWebRequest 实例
<!-- tags: Object TWebRequest Web 请求 创建 生成 对象 实例 -->
可见性:public
### `extractContentFields(strings)`
@@ -20,6 +24,8 @@ TWebRequest 内置对象
将post的内容展开到列表里
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -34,6 +40,8 @@ TWebRequest 内置对象
将Cookie的内容展开到列表里
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -48,6 +56,8 @@ TWebRequest 内置对象
将Query的内容展开到列表里
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -60,7 +70,9 @@ TWebRequest 内置对象
声明:function
取Header的值
获取取Header的值
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -76,6 +88,8 @@ TWebRequest 内置对象
读取客户端发送的数据
<!-- tags: Object TWebRequest Web 请求 读取 获取 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -91,6 +105,8 @@ TWebRequest 内置对象
读取客户端发送的数据
<!-- tags: Object TWebRequest Web 请求 读取 获取 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -105,6 +121,8 @@ TWebRequest 内置对象
将一个URI转换成服务器上可用的路径格式
<!-- tags: Object TWebRequest Web 请求 转换 编码 对象 实例 URI -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -119,6 +137,8 @@ TWebRequest 内置对象
向客户端发送的数据
<!-- tags: Object TWebRequest Web 请求 写入 保存 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -134,6 +154,8 @@ TWebRequest 内置对象
向客户端发送头部
<!-- tags: Object TWebRequest Web 请求 写入 保存 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -150,6 +172,8 @@ TWebRequest 内置对象
向客户端发送的数据
<!-- tags: Object TWebRequest Web 请求 写入 保存 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -164,6 +188,8 @@ TWebRequest 内置对象
客户端接收的内容,为空表示什么都接受。例如audio/*表示接收音频数据
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
类型:string
@@ -174,7 +200,9 @@ TWebRequest 内置对象
声明:property
头部的认证信息
获取头部的认证信息
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -188,6 +216,8 @@ TWebRequest 内置对象
头部的Cache-Control信息,表明缓存策略,可为no-cache, no-store, max-ages=seconds, max-stale=seconds, min-refresh=seconds
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
类型:string
@@ -200,6 +230,8 @@ TWebRequest 内置对象
头部的Connection信息,如果为close则会当完成请求时关闭链接
<!-- tags: Object TWebRequest Web 请求 连接 登录 对象 实例 -->
可见性:public
类型:string
@@ -212,6 +244,8 @@ TWebRequest 内置对象
POST的非解析内容,解析内容可在ContentFields中得到。如果内容特别大,Content不会包括所有的内容,剩余的内容需要用ReadClient来读取
<!-- tags: Object TWebRequest Web 请求 解析 parse 对象 实例 POST -->
可见性:public
类型:string
@@ -224,6 +258,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
传输编码,例如GZIP
<!-- tags: Object TWebRequest Web 请求 对象 实例 GZIP -->
可见性:public
类型:string
@@ -236,6 +272,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
解析后的Post的Content内容,将Post的内容用Name=Value的方式分割存贮
<!-- tags: Object TWebRequest Web 请求 解析 parse 对象 实例 -->
可见性:public
类型:TStringList
@@ -248,6 +286,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
发送的数据的长度
<!-- tags: Object TWebRequest Web 请求 发送 提交 对象 实例 -->
可见性:public
类型:integer
@@ -260,6 +300,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
发送的数据的类型
<!-- tags: Object TWebRequest Web 请求 发送 提交 对象 实例 -->
可见性:public
类型:string
@@ -272,6 +314,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
发送的数据的版本
<!-- tags: Object TWebRequest Web 请求 发送 提交 对象 实例 -->
可见性:public
类型:string
@@ -284,6 +328,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
发送的数据中的Cookie串
<!-- tags: Object TWebRequest Web 请求 发送 提交 对象 实例 -->
可见性:public
类型:string
@@ -296,6 +342,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
发送的数据中的Cookie串解析后按照Name=Value的模式存贮
<!-- tags: Object TWebRequest Web 请求 发送 提交 对象 实例 -->
可见性:public
类型:TStringList
@@ -306,7 +354,9 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
声明:property
浏览器客户端时的本地时间
获取浏览器客户端时的本地时间
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -320,6 +370,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
内容的原始请求URL,仅当发送的内容不是原始WEB客户端发起时有意义
<!-- tags: Object TWebRequest Web 请求 对象 实例 URL -->
可见性:public
类型:string
@@ -330,7 +382,9 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
声明:property
决定一个请求是否过期
获取决定一个请求是否过期
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -342,7 +396,9 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
声明:property
客户端的email地址
获取客户端的email地址
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -354,7 +410,9 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
声明:property
请求的URL中的主机名
获取请求的URL中的主机名
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 URL -->
可见性:public
@@ -368,6 +426,8 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
服务器可决定返回一个没有更新的错误(客户端可用原来的存贮的版本)
<!-- tags: Object TWebRequest Web 请求 判断 检查 对象 实例 -->
可见性:public
类型:datetime
@@ -378,7 +438,9 @@ POST的非解析内容,解析内容可在ContentFields中得到。如果内容
声明:property
URL的路径部分
获取URL的路径部分
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 URL -->
可见性:public
@@ -390,7 +452,9 @@ URL的路径部分
声明:property
URL的脚本部分
获取URL的脚本部分
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 URL -->
可见性:public
@@ -404,6 +468,8 @@ URL的脚本部分
只读类型,客户端请求的方法。方法种类有如下: OPTION:返回请求者和相应者之间可以使用的通信选项,主要用来检测服务器处理能力; GET:获得以URL标示的文件内容或者程序执行结果。服务器根据文件名后缀判断服务内容,比如该URL是静态文本还是一个程序; HEAD:除了不返回响应的信息本体以外,得到的是跟GET一样的信息。一般用来测试链接的有效性、可达性和近期修改; POST:把消息本体中的消息发送到一个URL或者其他类似的服务器端定义行为。通常用来提交一个HTML表单或者一些数据操作活动; PUT:把消息本体中的消息发送到一个URL,跟POST类似,但不常用; DELETE:删除URL指定的资源; TRACE:调用一个远程应用层请求消息回路。发出这个消息的用户终端除了收到原来的消息内容以外,还得到消息在Internet上的传送路径
<!-- tags: Object TWebRequest Web 请求 对象 实例 OPTION GET URL HEAD POST HTML -->
可见性:public
类型:string
@@ -416,6 +482,8 @@ URL的脚本部分
客户端请求的方法。0:未指定,1:GET 2:PUT3POST4:HEAD
<!-- tags: Object TWebRequest Web 请求 对象 实例 GET PUT POST HEAD -->
可见性:public
类型:integer
@@ -426,7 +494,9 @@ URL的脚本部分
声明:property
客户端请求的URL的路径信息
获取客户端请求的URL的路径信息
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 URL -->
可见性:public
@@ -438,7 +508,9 @@ URL的脚本部分
声明:property
请求的脚本在服务器上对应的真实路径
获取请求的脚本在服务器上对应的真实路径
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -452,6 +524,8 @@ URL的脚本部分
请求的HTTP协议版本,如1.0或者1.1
<!-- tags: Object TWebRequest Web 请求 对象 实例 HTTP -->
可见性:public
类型:string
@@ -462,7 +536,9 @@ URL的脚本部分
声明:property
请求的查询参数部分
获取请求的查询参数部分
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -476,6 +552,8 @@ URL的脚本部分
请求的查询参数部分以Name=Value模式的TStrings存贮
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
类型:TStringList
@@ -486,7 +564,9 @@ URL的脚本部分
声明:property
请求的来源地址(发起请求的源地址)
获取请求的来源地址(发起请求的源地址)
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -498,7 +578,9 @@ URL的脚本部分
声明:property
客户端的IP地址
获取客户端的IP地址
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 IP -->
可见性:public
@@ -510,7 +592,9 @@ URL的脚本部分
声明:property
客户端的主机名称
获取客户端的主机名称
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -524,6 +608,8 @@ URL的脚本部分
请求路径和脚本名的部分,不包括主机和参数部分
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
类型:string
@@ -534,7 +620,9 @@ URL的脚本部分
声明:property
与服务器连接到的端口
获取与服务器连接到的端口
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -546,7 +634,9 @@ URL的脚本部分
声明:property
客户端请求的Title域
获取客户端请求的Title域
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -558,7 +648,9 @@ URL的脚本部分
声明:property
客户端请求的完整路径
获取客户端请求的完整路径
<!-- tags: Object TWebRequest Web 请求 获取 查询 对象 实例 -->
可见性:public
@@ -572,6 +664,8 @@ URL的脚本部分
客户端的标识,例如浏览器名和版本号等
<!-- tags: Object TWebRequest Web 请求 对象 实例 -->
可见性:public
类型:string
@@ -4,7 +4,9 @@
声明:class
TWebResponse 内置对象
用于设置 HTTP 状态、响应头、Cookie 和响应正文的内置对象
<!-- tags: Object 对象 实例 HTTP -->
### `create()`
@@ -12,6 +14,8 @@ TWebResponse 内置对象
创建 TWebResponse 实例
<!-- tags: Object 创建 生成 对象 实例 -->
可见性:public
### `getCustomHeader(name)`
@@ -20,6 +24,8 @@ TWebResponse 内置对象
读取CustomHeaders里的内容
<!-- tags: Object 读取 获取 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -34,6 +40,8 @@ TWebResponse 内置对象
发送重定向
<!-- tags: Object 发送 提交 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -48,6 +56,8 @@ TWebResponse 内置对象
发送响应包
<!-- tags: Object 发送 提交 对象 实例 -->
可见性:public
返回:any
@@ -58,6 +68,8 @@ TWebResponse 内置对象
发送流
<!-- tags: Object 发送 提交 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -70,7 +82,9 @@ TWebResponse 内置对象
声明:function
是否已发送。已经发送则设置头信息没有意义
判断是否已发送。已经发送则设置头信息没有意义
<!-- tags: Object 判断 检查 对象 实例 -->
可见性:public
@@ -82,6 +96,8 @@ TWebResponse 内置对象
设置Cookie字段
<!-- tags: Object 设置 修改 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -100,6 +116,8 @@ TWebResponse 内置对象
设置header字段
<!-- tags: Object 设置 修改 对象 实例 -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -115,6 +133,8 @@ TWebResponse 内置对象
服务器所支持的逗号分隔的方法列表。最少需要支持GET和HEAD方法
<!-- tags: Object 对象 实例 GET HEAD -->
可见性:public
类型:string
@@ -127,6 +147,8 @@ TWebResponse 内置对象
返回的内容传输的编码方式,如GZIP
<!-- tags: Object 返回 获取 对象 实例 GZIP -->
可见性:public
类型:string
@@ -139,6 +161,8 @@ TWebResponse 内置对象
设置全部返回内容的长度
<!-- tags: Object 设置 修改 对象 实例 -->
可见性:public
类型:integer
@@ -151,6 +175,8 @@ TWebResponse 内置对象
返回目前在正在输出的流
<!-- tags: Object 返回 获取 对象 实例 -->
可见性:public
类型:TStream
@@ -163,6 +189,8 @@ TWebResponse 内置对象
返回的内容的类型,包括字符集如html/text; charset=gb2312
<!-- tags: Object 返回 获取 对象 实例 -->
可见性:public
类型:string
@@ -175,6 +203,8 @@ TWebResponse 内置对象
返回的内容的版本
<!-- tags: Object 返回 获取 对象 实例 -->
可见性:public
类型:string
@@ -187,6 +217,8 @@ TWebResponse 内置对象
返回的Cookie列表对象,可用该对象添加Cookie
<!-- tags: Object 返回 获取 对象 实例 -->
可见性:public
类型:TCookieCollection
@@ -199,6 +231,8 @@ TWebResponse 内置对象
设置或者读取Headers对象,可利用该对象来设置Header的具体内容
<!-- tags: Object 设置 修改 对象 实例 -->
可见性:public
类型:TStringList
@@ -209,7 +243,9 @@ TWebResponse 内置对象
声明:property
当前发送的内容的时间
获取或设置当前发送的内容的时间
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -221,7 +257,9 @@ TWebResponse 内置对象
声明:property
内容生成者
获取或设置内容生成者
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -233,7 +271,9 @@ TWebResponse 内置对象
声明:property
内容过期的时间
获取或设置内容过期的时间
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -247,6 +287,8 @@ TWebResponse 内置对象
获得REPONSE相关的客户请求对象
<!-- tags: Object 获取 查询 对象 实例 REPONSE -->
可见性:public
类型:TWebRequest
@@ -257,7 +299,9 @@ TWebResponse 内置对象
声明:property
内容的最终更新时间
获取或设置内容的最终更新时间
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -271,6 +315,8 @@ TWebResponse 内置对象
设置要跳转的路径
<!-- tags: Object 设置 修改 对象 实例 -->
可见性:public
类型:string
@@ -281,7 +327,9 @@ TWebResponse 内置对象
声明:property
用来跟踪记录调试的串
获取或设置用来跟踪记录调试的串
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -293,7 +341,9 @@ TWebResponse 内置对象
声明:property
未授权时告诉客户端所需授权的路径集
获取或设置未授权时告诉客户端所需授权的路径集
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -305,7 +355,9 @@ TWebResponse 内置对象
声明:property
当返回错误的时候所需要的原因串
获取或设置当返回错误的时候所需要的原因串
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -319,6 +371,8 @@ TWebResponse 内置对象
提供服务的应用的标示串
<!-- tags: Object 对象 实例 -->
可见性:public
类型:string
@@ -331,6 +385,8 @@ TWebResponse 内置对象
返回的状态吗,200表示正确
<!-- tags: Object 返回 获取 对象 实例 -->
可见性:public
类型:integer
@@ -341,7 +397,9 @@ TWebResponse 内置对象
声明:property
内容的标题
获取或设置内容的标题
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -353,7 +411,9 @@ TWebResponse 内置对象
声明:property
协议版本
获取或设置协议版本
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public
@@ -365,7 +425,9 @@ TWebResponse 内置对象
声明:property
401错误发生时支持逗号分隔的认证方法列表
获取或设置401错误发生时支持逗号分隔的认证方法列表
<!-- tags: Object 获取 查询 对象 实例 -->
可见性:public