# Object - MailMsg 邮件消息

## `MailMsg`

声明：class

用于创建、解析、保存和发送邮件消息的内置对象

<!-- tags: Object MailMsg 邮件消息 写入 保存 对象 实例 邮件 SMTP POP3 IMAP 创建 生成 构造函数 实例化 new -->

### `create()`

声明：function

无参数构造函数。创建空的 MailMsg 实例，用于组装邮件消息

<!-- tags: Object MailMsg 邮件消息 创建 生成 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

### `addAttachment()`

声明：function

添加一个文件附件的消息部分

<!-- tags: Object MailMsg 邮件消息 添加 追加 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

返回：messagepart

### `addText()`

声明：function

添加一个文本格式的消息部分

<!-- tags: Object MailMsg 邮件消息 添加 追加 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

返回：messagepart

### `asBinary(headers_only)`

声明：function

消息的原始内容，二进制数据类型

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数           | 类型    | 说明                           |
| -------------- | ------- | ------------------------------ |
| `headers_only` | boolean | 真假型，是否仅仅只要头部的内容 |

返回：binary

### `loadFromFile(alias, file_name, headers_only)`

声明：function

从文件中打开邮件消息

<!-- tags: Object MailMsg 邮件消息 读取 获取 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数           | 类型    | 说明                               |
| -------------- | ------- | ---------------------------------- |
| `alias`        | string  | 可选。字符串类型，目录别名。可省略 |
| `file_name`    | string  | 字符串类型，文件名                 |
| `headers_only` | boolean | 可选。是否仅需要头部内容           |

返回：any

### `loadFromStream(stream, headers_only)`

声明：function

从流中打开邮件消息

<!-- tags: Object MailMsg 邮件消息 读取 获取 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数           | 类型    | 说明                     |
| -------------- | ------- | ------------------------ |
| `stream`       | comobj  | 流类型对象               |
| `headers_only` | boolean | 可选。是否仅需要头部内容 |

返回：any

### `messagePart(index)`

声明：function

返回指定的消息部分

<!-- tags: Object MailMsg 邮件消息 返回 获取 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数    | 类型 | 说明  |
| ------- | ---- | ----- |
| `index` | any  | index |

返回：messagepart

### `saveToFile(alias, file_name, headers_only)`

声明：function

保存到文件中

<!-- tags: Object MailMsg 邮件消息 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数           | 类型    | 说明                               |
| -------------- | ------- | ---------------------------------- |
| `alias`        | string  | 可选。字符串类型，目录别名。可省略 |
| `file_name`    | string  | 字符串类型，文件名                 |
| `headers_only` | boolean | 可选。是否仅保存头部内容           |

返回：any

### `saveToStream(stream, headers_only)`

声明：function

保存到流中

<!-- tags: Object MailMsg 邮件消息 写入 保存 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数           | 类型    | 说明                     |
| -------------- | ------- | ------------------------ |
| `stream`       | comobj  | 流类型对象               |
| `headers_only` | boolean | 可选。是否仅保存头部内容 |

返回：any

### `sendCmd(cmd, cmd_result, ret_code)`

声明：function

发送命令

<!-- tags: Object MailMsg 邮件消息 发送 提交 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

| 参数         | 类型   | 说明                   |
| ------------ | ------ | ---------------------- |
| `cmd`        | string | 字符串类型，发送的命令 |
| `cmd_result` | string | 可选。返回的结果串     |
| `ret_code`   | string | 可选。返回的代码串     |

返回：boolean

### `AsString`

声明：property

获取或设置消息的原始内容

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `AttachmentEncoding`

声明：property

获取或设置附件编码

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `AttachmentTempDirectory`

声明：property

获取或设置临时的附件存贮目录

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `BccList`

声明：property

获取或设置消息的暗送地址

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Body`

声明：property

获取或设置消息的正文

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `CCList`

声明：property

获取或设置消息的抄送地址

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `CharSet`

声明：property

获取或设置消息的默认编码格式

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `ContentDisposition`

声明：property

一些不能被放在内容里的描述串，例如inline表示在邮件中直接显示，attachment则表示当成附件，attachment可附带"filename"，"creation-date"，"modification-date"， "read-date"，"size"等参数来描述attachment

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `ContentTransferEncoding`

声明：property

读写类型，消息内容传输时的编码类型，主要编码方式有。 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

访问：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

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `ConvertPreamble`

声明：property

控制是否转换序文

<!-- tags: Object MailMsg 邮件消息 转换 编码 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read/write

### `Date`

声明：property

获取或设置邮件的时间

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：datetime

访问：read/write

### `Encoding`

声明：property

邮件的编码算法，0：MIME编码算法，1：UUEncode编码算法

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP MIME -->

可见性：public

类型：integer

访问：read/write

### `ExceptionOnBlockedAttachments`

声明：property

控制是否在文件附件无法被创建时引发异常

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read/write

### `ExtraHeaders`

声明：property

获取或设置邮件的附加头信息

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Flags`

声明：property

邮件标志，位标示：已回复（1）已标志（2）已删除（3）草稿（4）已阅读（5）最近的（6）

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：integer

访问：read/write

### `From`

声明：property

获取或设置邮件来源

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `FromList`

声明：property

获取或设置邮件来源列表

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Headers`

声明：property

获取或设置消息头部信息

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `InReplyTo`

声明：property

获取或设置回复地址

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `IsEncoded`

声明：property

控制是否编码

<!-- tags: Object MailMsg 邮件消息 判断 检查 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read/write

### `IsMsgSinglePartMime`

声明：property

指示是否是一个单个部分的邮件

<!-- tags: Object MailMsg 邮件消息 判断 检查 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read

### `LastGeneratedHeaders`

声明：property

获取或设置最后生成的头信息

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `MessagePartsCount`

声明：property

获取或设置消息的部分个数

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：integer

访问：read/write

### `MsgID`

声明：property

获取或设置消息ID

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP ID -->

可见性：public

类型：string

访问：read/write

### `NewsGroups`

声明：property

发送到的新闻组，只当采用NNTP对象的时候有用

<!-- tags: Object MailMsg 邮件消息 发送 提交 对象 实例 邮件 SMTP POP3 IMAP NNTP -->

可见性：public

类型：string

访问：read/write

### `NoDecode`

声明：property

获取或设置当为真是不解码内容

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read/write

### `NoEncode`

声明：property

获取或设置当为真是不会发送附件

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read/write

### `Organization`

声明：property

获取或设置作者的从属组织

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Priority`

声明：property

优先级，0最高，4最低

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：integer

访问：read/write

### `ReceiptRecipient`

声明：property

倘若指定对方要接收的收条，为收条的收件邮件地址

<!-- tags: Object MailMsg 邮件消息 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Recipients`

声明：property

获取或设置收件人邮件地址

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `References`

声明：property

获取或设置NNTP里的回复过的邮件列表

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP NNTP -->

可见性：public

类型：string

访问：read/write

### `ReplyTo`

声明：property

获取或设置回复邮件地址

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Sender`

声明：property

获取或设置发件人

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `Subject`

声明：property

获取或设置邮件标题

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `UID`

声明：property

获取或设置唯一标识

<!-- tags: Object MailMsg 邮件消息 获取 查询 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：string

访问：read/write

### `UseNowForDate`

声明：property

发送邮件的时候邮件时间是否用当前时间

<!-- tags: Object MailMsg 邮件消息 发送 提交 对象 实例 邮件 SMTP POP3 IMAP -->

可见性：public

类型：boolean

访问：read/write
