csh/playbook
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
34a3a5dec1ea3e405d0ffd7fddbba7b25a70b445
playbook/skills/tsl-api-reference/references/codegen/builtin/object/mailmsg.md
T
csh 9010829c6d ✨ feat(tsl-api-reference): expand and reorganize api catalog 
Flatten builtin pages, add third-party and platform scopes, and import financial and data warehouse references.

Keep the existing generated index without rebuilding after signature normalization.
2026-08-10 18:26:24 +08:00

598 lines
8.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Object - MailMsg 邮件消息
## `MailMsg`
声明：class
MailMsg 内置对象
### `create()`
声明：function
创建 MailMsg 实例
可见性：public
### `addAttachment()`
声明：function
添加一个文件附件的消息部分
可见性：public
返回：messagepart
### `addText()`
声明：function
添加一个文本格式的消息部分
可见性：public
返回：messagepart
### `asBinary(headers_only)`
声明：function
消息的原始内容，二进制数据类型
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `headers_only` | boolean | 真假型，是否仅仅只要头部的内容 |
返回：binary
### `loadFromFile(alias, file_name, headers_only)`
声明：function
从文件中打开邮件消息
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `alias` | string | 可选。字符串类型，目录别名。可省略 |
| `file_name` | string | 字符串类型，文件名 |
| `headers_only` | boolean | 可选。是否仅需要头部内容 |
返回：any
### `loadFromStream(stream, headers_only)`
声明：function
从流中打开邮件消息
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `stream` | comobj | 流类型对象 |
| `headers_only` | boolean | 可选。是否仅需要头部内容 |
返回：any
### `messagePart(index)`
声明：function
返回指定的消息部分
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `index` | any | index |
返回：messagepart
### `saveToFile(alias, file_name, headers_only)`
声明：function
保存到文件中
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `alias` | string | 可选。字符串类型，目录别名。可省略 |
| `file_name` | string | 字符串类型，文件名 |
| `headers_only` | boolean | 可选。是否仅保存头部内容 |
返回：any
### `saveToStream(stream, headers_only)`
声明：function
保存到流中
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `stream` | comobj | 流类型对象 |
| `headers_only` | boolean | 可选。是否仅保存头部内容 |
返回：any
### `sendCmd(cmd, cmd_result, ret_code)`
声明：function
发送命令
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `cmd` | string | 字符串类型，发送的命令 |
| `cmd_result` | string | 可选。返回的结果串 |
| `ret_code` | string | 可选。返回的代码串 |
返回：boolean
### `AsString`
声明：property
消息的原始内容
可见性：public
类型：string
访问：read/write
### `AttachmentEncoding`
声明：property
附件编码
可见性：public
类型：string
访问：read/write
### `AttachmentTempDirectory`
声明：property
临时的附件存贮目录
可见性：public
类型：string
访问：read/write
### `BccList`
声明：property
消息的暗送地址
可见性：public
类型：string
访问：read/write
### `Body`
声明：property
消息的正文
可见性：public
类型：string
访问：read/write
### `CCList`
声明：property
消息的抄送地址
可见性：public
类型：string
访问：read/write
### `CharSet`
声明：property
消息的默认编码格式
可见性：public
类型：string
访问：read/write
### `ContentDisposition`
声明：property
一些不能被放在内容里的描述串，例如inline表示在邮件中直接显示，attachment则表示当成附件，attachment可附带"filename"，"creation-date"，"modification-date"， "read-date"，"size"等参数来描述attachment
可见性：public
类型：string
访问：read/write
### `ContentTransferEncoding`
声明：property
读写类型，消息内容传输时的编码类型，主要编码方式有。 7bit – 7位不编码的ASCII码，默认编码方式。 8bit – 8位不编码的原始值。 binary – 不编码的10进制数据流。 quoted-printable – 转换为7位可打印的ASCII编码方式。每个高位为1的码翻译为如=A1的16进制模式。 base64 – Base64模式，一种将8字节转换为7字节的编码方式
可见性：public
类型：string
访问：read/write
### `ContentType`
声明：property
读写类型，消息内容类型，常见类型种类如下 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
可见性：public
类型：string
访问：read/write
### `ConvertPreamble`
声明：property
是否转换序文
可见性：public
类型：boolean
访问：read/write
### `Date`
声明：property
邮件的时间
可见性：public
类型：datetime
访问：read/write
### `Encoding`
声明：property
邮件的编码算法，0：MIME编码算法，1：UUEncode编码算法
可见性：public
类型：integer
访问：read/write
### `ExceptionOnBlockedAttachments`
声明：property
是否在文件附件无法被创建时引发异常
可见性：public
类型：boolean
访问：read/write
### `ExtraHeaders`
声明：property
邮件的附加头信息
可见性：public
类型：string
访问：read/write
### `Flags`
声明：property
邮件标志，位标示：已回复（1）已标志（2）已删除（3）草稿（4）已阅读（5）最近的（6）
可见性：public
类型：integer
访问：read/write
### `From`
声明：property
邮件来源
可见性：public
类型：string
访问：read/write
### `FromList`
声明：property
邮件来源列表
可见性：public
类型：string
访问：read/write
### `Headers`
声明：property
消息头部信息
可见性：public
类型：string
访问：read/write
### `InReplyTo`
声明：property
回复地址
可见性：public
类型：string
访问：read/write
### `IsEncoded`
声明：property
是否编码
可见性：public
类型：boolean
访问：read/write
### `IsMsgSinglePartMime`
声明：property
是否是一个单个部分的邮件
可见性：public
类型：boolean
访问：read
### `LastGeneratedHeaders`
声明：property
最后生成的头信息
可见性：public
类型：string
访问：read/write
### `MessagePartsCount`
声明：property
消息的部分个数
可见性：public
类型：integer
访问：read/write
### `MsgID`
声明：property
消息ID
可见性：public
类型：string
访问：read/write
### `NewsGroups`
声明：property
发送到的新闻组，只当采用NNTP对象的时候有用
可见性：public
类型：string
访问：read/write
### `NoDecode`
声明：property
当为真是不解码内容
可见性：public
类型：boolean
访问：read/write
### `NoEncode`
声明：property
当为真是不会发送附件
可见性：public
类型：boolean
访问：read/write
### `Organization`
声明：property
作者的从属组织
可见性：public
类型：string
访问：read/write
### `Priority`
声明：property
优先级，0最高，4最低
可见性：public
类型：integer
访问：read/write
### `ReceiptRecipient`
声明：property
倘若指定对方要接收的收条，为收条的收件邮件地址
可见性：public
类型：string
访问：read/write
### `Recipients`
声明：property
收件人邮件地址
可见性：public
类型：string
访问：read/write
### `References`
声明：property
NNTP里的回复过的邮件列表
可见性：public
类型：string
访问：read/write
### `ReplyTo`
声明：property
回复邮件地址
可见性：public
类型：string
访问：read/write
### `Sender`
声明：property
发件人
可见性：public
类型：string
访问：read/write
### `Subject`
声明：property
邮件标题
可见性：public
类型：string
访问：read/write
### `UID`
声明：property
唯一标识
可见性：public
类型：string
访问：read/write
### `UseNowForDate`
声明：property
发送邮件的时候邮件时间是否用当前时间
可见性：public
类型：boolean
访问：read/write
Reference in New Issue View Git Blame Copy Permalink