# Class: Mail
• Mail()
邮件详情
# Properties
# Readonly attachments
• attachments: MailAttachment[]
邮件附件列表
Returns: MailAttachment[]
# Optional Readonly buff
• buff? : MailBuff
自定义 Buff
Returns: MailBuff
# Readonly content
• content: string
邮件内容
Returns: string
# Readonly expireTime
• expireTime: Long
到期时间
Returns: Long
# Readonly from
• from: MailFrom
发件人信息
Returns: MailFrom
# Readonly id
• id: number
邮件(在当前组内的) ID
Returns: number
# Readonly sendTime
• sendTime: Long
发送时间
Returns: Long
# status
• status: MailStatus
邮件状态
Returns: MailStatus
# Readonly subject
• subject: string
邮件标题
Returns: string
# 操作触发
# collect
▸ collect(params?: Omit‹CollectMailsByGroupParams, "type" | "mailIdsToCollect"›): Promise‹CollectMailsByGroupRes›
收取邮件附件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params? | Omit‹CollectMailsByGroupParams, "type" | "mailIdsToCollect"› |
# 返回值:
Promise‹CollectMailsByGroupRes›
# collectAndDelete
▸ collectAndDelete(params?: Omit‹CollectAndDeleteMailsByGroupParams, "type" | "mailIdsToCollectAndDelete"›): Promise‹CollectAndDeleteMailsByGroupRes›
收取并删除邮件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params? | Omit‹CollectAndDeleteMailsByGroupParams, "type" | "mailIdsToCollectAndDelete"› |
# 返回值:
Promise‹CollectAndDeleteMailsByGroupRes›
# delete
▸ delete(params?: Omit‹DeleteMailsByGroupParams, "type" | "mailIdsToDelete"›): Promise‹DeleteMailsByGroupRes›
删除邮件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params? | Omit‹DeleteMailsByGroupParams, "type" | "mailIdsToDelete"› |
# 返回值:
Promise‹DeleteMailsByGroupRes›
# markAsRead
▸ markAsRead(params?: Omit‹MarkMailsAsReadByGroupParams, "type" | "mailIdsToMarkAsRead"›): Promise‹MarkMailsAsReadByGroupRes›
标记为已读状态
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params? | Omit‹MarkMailsAsReadByGroupParams, "type" | "mailIdsToMarkAsRead"› |
# 返回值:
Promise‹MarkMailsAsReadByGroupRes›