# Class: MailGroup
• MailGroup()
邮件组 依据 MailGroupType 划分 包含了同组的所有邮件
# Properties
# Readonly mails
• mails: Mail[]
(该邮件组内)邮件列表
Returns: Mail[]
# Readonly type
• type: MailGroupType
邮件组类型
Returns: MailGroupType
# 事件监听
# offMailStatusChange
▸ offMailStatusChange(handler?: MailStatusChangeEventHandler): void
取消注册 当前邮件组 邮件状态变更 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler? | MailStatusChangeEventHandler |
# 返回值:
void
# offMailsReceived
▸ offMailsReceived(handler?: MailsReceivedEventHandler): void
取消注册 当前邮件组 收到新邮件 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler? | MailsReceivedEventHandler |
# 返回值:
void
# onMailStatusChange
▸ onMailStatusChange(handler: MailStatusChangeEventHandler): void
注册 当前邮件组 邮件状态变更 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler | MailStatusChangeEventHandler |
# 返回值:
void
# onMailsReceived
▸ onMailsReceived(handler: MailsReceivedEventHandler): void
注册 当前邮件组 收到新邮件 事件处理函数
# 参数:
| 属性 | 类型 |
|---|---|
handler | MailsReceivedEventHandler |
# 返回值:
void
# 操作触发
# collectAndDeleteMails
▸ collectAndDeleteMails(params: Omit‹CollectAndDeleteMailsByGroupParams, "type"›): Promise‹CollectAndDeleteMailsByGroupRes›
(从当前邮箱)收取并删除指定(一个或多个)邮件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹CollectAndDeleteMailsByGroupParams, "type"› |
# 返回值:
Promise‹CollectAndDeleteMailsByGroupRes›
# collectMails
▸ collectMails(params: Omit‹CollectMailsByGroupParams, "type"›): Promise‹CollectMailsByGroupRes›
(从当前邮箱)收取邮件附件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹CollectMailsByGroupParams, "type"› |
# 返回值:
Promise‹CollectMailsByGroupRes›
# deleteMails
▸ deleteMails(params: Omit‹DeleteMailsByGroupParams, "type"›): Promise‹DeleteMailsByGroupRes›
(从当前邮箱)删除指定(一个或多个)邮件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹DeleteMailsByGroupParams, "type"› |
# 返回值:
Promise‹DeleteMailsByGroupRes›
# markMailsAsRead
▸ markMailsAsRead(params: Omit‹MarkMailsAsReadByGroupParams, "type"›): Promise‹MarkMailsAsReadByGroupRes›
标记(当前邮箱中)给定的(一个或多个)邮件 为已读状态
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹MarkMailsAsReadByGroupParams, "type"› |
# 返回值:
Promise‹MarkMailsAsReadByGroupRes›
# refresh
▸ refresh(params?: Omit‹RefreshMailGroupParams, "type"›): Promise‹RefreshMailGroupRes›
刷新邮件列表
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params? | Omit‹RefreshMailGroupParams, "type"› |
# 返回值:
Promise‹RefreshMailGroupRes›
# sendMail
▸ sendMail(params: Omit‹SendMailByGroupParams, "type"›): Promise‹SendMailByGroupRes›
(从当前邮箱)发送邮件
throws {MogsError}
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹SendMailByGroupParams, "type"› |
# 返回值:
Promise‹SendMailByGroupRes›