UserMailboxMessage (larksuite-oapi 2.8.1 API)

java.lang.Object
- com.lark.oapi.service.mail.v1.resource.UserMailboxMessage

public class UserMailboxMessage
extends Object

构造器概要

构造器
构造器和说明

UserMailboxMessage(Config config)

构造器
构造器和说明
`UserMailboxMessage(Config config)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BatchGetUserMailboxMessageResp`	`batchGet(BatchGetUserMailboxMessageReq req)` ，通过指定邮件ID，获取对应邮件的标签、文件夹、摘要、正文、html、附件等信息。
`BatchGetUserMailboxMessageResp`	`batchGet(BatchGetUserMailboxMessageReq req, RequestOptions reqOptions)` ，通过指定邮件ID，获取对应邮件的标签、文件夹、摘要、正文、html、附件等信息。
`BatchModifyUserMailboxMessageResp`	`batchModify(BatchModifyUserMailboxMessageReq req)` ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件读和未读、移动邮件至垃圾邮件等能力。
`BatchModifyUserMailboxMessageResp`	`batchModify(BatchModifyUserMailboxMessageReq req, RequestOptions reqOptions)` ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件读和未读、移动邮件至垃圾邮件等能力。
`BatchTrashUserMailboxMessageResp`	`batchTrash(BatchTrashUserMailboxMessageReq req)` ，通过指定邮件ID，批量移动邮件到已删除文件夹官网API文档链接:	`BatchTrashUserMailboxMessageResp`	`batchTrash(BatchTrashUserMailboxMessageReq req, RequestOptions reqOptions)` ，通过指定邮件ID，批量移动邮件到已删除文件夹官网API文档链接:	`GetUserMailboxMessageResp`	`get(GetUserMailboxMessageReq req)` ，获取邮件详情官网API文档链接:	`GetUserMailboxMessageResp`	`get(GetUserMailboxMessageReq req, RequestOptions reqOptions)` ，获取邮件详情官网API文档链接:	`GetByCardUserMailboxMessageResp`	`getByCard(GetByCardUserMailboxMessageReq req)` ，卡片ID获取邮件ID 官网API文档链接:	`GetByCardUserMailboxMessageResp`	`getByCard(GetByCardUserMailboxMessageReq req, RequestOptions reqOptions)` ，卡片ID获取邮件ID 官网API文档链接:	`ListUserMailboxMessageResp`	`list(ListUserMailboxMessageReq req)` ，根据用户指定的标签或文件夹，列出对应位置下的邮件列表。
`ListUserMailboxMessageResp`	`list(ListUserMailboxMessageReq req, RequestOptions reqOptions)` ，根据用户指定的标签或文件夹，列出对应位置下的邮件列表。
`ListThreadMessageUserMailboxMessageResp`	`listThreadMessage(ListThreadMessageUserMailboxMessageReq req)` ，通过用户邮箱地址和邮件会话ID，获取该会话下的所有邮件关键信息列表。
`ListThreadMessageUserMailboxMessageResp`	`listThreadMessage(ListThreadMessageUserMailboxMessageReq req, RequestOptions reqOptions)` ，通过用户邮箱地址和邮件会话ID，获取该会话下的所有邮件关键信息列表。
`ModifyUserMailboxMessageResp`	`modify(ModifyUserMailboxMessageReq req)` ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件已读和未读、移动邮件至垃圾邮件等能力。
`ModifyUserMailboxMessageResp`	`modify(ModifyUserMailboxMessageReq req, RequestOptions reqOptions)` ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件已读和未读、移动邮件至垃圾邮件等能力。
`SendUserMailboxMessageResp`	`send(SendUserMailboxMessageReq req)` ，官网API文档链接:	`SendUserMailboxMessageResp`	`send(SendUserMailboxMessageReq req, RequestOptions reqOptions)` ，官网API文档链接:	`TrashUserMailboxMessageResp`	`trash(TrashUserMailboxMessageReq req)` ，移动邮件到已删除文件夹。
`TrashUserMailboxMessageResp`	`trash(TrashUserMailboxMessageReq req, RequestOptions reqOptions)` ，移动邮件到已删除文件夹。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - UserMailboxMessage
```
public UserMailboxMessage(Config config)
```
- 方法详细资料
  - batchGet
```
public BatchGetUserMailboxMessageResp batchGet(BatchGetUserMailboxMessageReq req,
                                               RequestOptions reqOptions)
                                        throws Exception
```
    ，通过指定邮件ID，获取对应邮件的标签、文件夹、摘要、正文、html、附件等信息。注意，如需获取摘要、正文、主题或收发件人地址，需要申请对应的字段权限。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_get&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/BatchGetUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - batchGet
```
public BatchGetUserMailboxMessageResp batchGet(BatchGetUserMailboxMessageReq req)
                                        throws Exception
```
    ，通过指定邮件ID，获取对应邮件的标签、文件夹、摘要、正文、html、附件等信息。注意，如需获取摘要、正文、主题或收发件人地址，需要申请对应的字段权限。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_get&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/BatchGetUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - batchModify
```
public BatchModifyUserMailboxMessageResp batchModify(BatchModifyUserMailboxMessageReq req,
                                                     RequestOptions reqOptions)
                                              throws Exception
```
    ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件读和未读、移动邮件至垃圾邮件等能力。不支持移动邮件到已删除文件夹，如需，请使用批量删除邮件接口。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_modify&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/BatchModifyUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - batchModify
```
public BatchModifyUserMailboxMessageResp batchModify(BatchModifyUserMailboxMessageReq req)
                                              throws Exception
```
    ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件读和未读、移动邮件至垃圾邮件等能力。不支持移动邮件到已删除文件夹，如需，请使用批量删除邮件接口。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_modify&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/BatchModifyUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - batchTrash
```
public BatchTrashUserMailboxMessageResp batchTrash(BatchTrashUserMailboxMessageReq req,
                                                   RequestOptions reqOptions)
                                            throws Exception
```
    ，通过指定邮件ID，批量移动邮件到已删除文件夹
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_trash&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/BatchTrashUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - batchTrash
```
public BatchTrashUserMailboxMessageResp batchTrash(BatchTrashUserMailboxMessageReq req)
                                            throws Exception
```
    ，通过指定邮件ID，批量移动邮件到已删除文件夹
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=batch_trash&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/BatchTrashUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetUserMailboxMessageResp get(GetUserMailboxMessageReq req,
                                     RequestOptions reqOptions)
                              throws Exception
```
    ，获取邮件详情
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/GetUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetUserMailboxMessageResp get(GetUserMailboxMessageReq req)
                              throws Exception
```
    ，获取邮件详情
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/GetUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - getByCard
```
public GetByCardUserMailboxMessageResp getByCard(GetByCardUserMailboxMessageReq req,
                                                 RequestOptions reqOptions)
                                          throws Exception
```
    ，卡片ID获取邮件ID
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get_by_card&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/GetByCardUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - getByCard
```
public GetByCardUserMailboxMessageResp getByCard(GetByCardUserMailboxMessageReq req)
                                          throws Exception
```
    ，卡片ID获取邮件ID
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get_by_card&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/GetByCardUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListUserMailboxMessageResp list(ListUserMailboxMessageReq req,
                                       RequestOptions reqOptions)
                                throws Exception
```
    ，根据用户指定的标签或文件夹，列出对应位置下的邮件列表。注意，必须填写folder_id或label_id中的一个字段。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/ListUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListUserMailboxMessageResp list(ListUserMailboxMessageReq req)
                                throws Exception
```
    ，根据用户指定的标签或文件夹，列出对应位置下的邮件列表。注意，必须填写folder_id或label_id中的一个字段。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/ListUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - listThreadMessage
```
public ListThreadMessageUserMailboxMessageResp listThreadMessage(ListThreadMessageUserMailboxMessageReq req,
                                                                 RequestOptions reqOptions)
                                                          throws Exception
```
    ，通过用户邮箱地址和邮件会话ID，获取该会话下的所有邮件关键信息列表。如需查询主题、正文、摘要、收发件人信息，请申请字段权限。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list_thread_message&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/ListThreadMessageUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - listThreadMessage
```
public ListThreadMessageUserMailboxMessageResp listThreadMessage(ListThreadMessageUserMailboxMessageReq req)
                                                          throws Exception
```
    ，通过用户邮箱地址和邮件会话ID，获取该会话下的所有邮件关键信息列表。如需查询主题、正文、摘要、收发件人信息，请申请字段权限。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list_thread_message&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/ListThreadMessageUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - modify
```
public ModifyUserMailboxMessageResp modify(ModifyUserMailboxMessageReq req,
                                           RequestOptions reqOptions)
                                    throws Exception
```
    ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件已读和未读、移动邮件至垃圾邮件等能力。不支持移动邮件到已删除文件夹，如需删除邮件，请使用删除邮件接口。至少填写add_label_ids、remove_label_ids、add_folder中的一个参数。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=modify&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/ModifyUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - modify
```
public ModifyUserMailboxMessageResp modify(ModifyUserMailboxMessageReq req)
                                    throws Exception
```
    ，本接口提供修改邮件的能力，支持移动邮件的文件夹、给邮件添加和移除标签、标记邮件已读和未读、移动邮件至垃圾邮件等能力。不支持移动邮件到已删除文件夹，如需删除邮件，请使用删除邮件接口。至少填写add_label_ids、remove_label_ids、add_folder中的一个参数。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=modify&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/ModifyUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - send
```
public SendUserMailboxMessageResp send(SendUserMailboxMessageReq req,
                                       RequestOptions reqOptions)
                                throws Exception
```
    ，
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=send&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/SendUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - send
```
public SendUserMailboxMessageResp send(SendUserMailboxMessageReq req)
                                throws Exception
```
    ，
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=send&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/SendUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - trash
```
public TrashUserMailboxMessageResp trash(TrashUserMailboxMessageReq req,
                                         RequestOptions reqOptions)
                                  throws Exception
```
    ，移动邮件到已删除文件夹。注意，该接口无法删除草稿，如需删除草稿，请使用删除草稿接口
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=trash&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/TrashUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception
  - trash
```
public TrashUserMailboxMessageResp trash(TrashUserMailboxMessageReq req)
                                  throws Exception
```
    ，移动邮件到已删除文件夹。注意，该接口无法删除草稿，如需删除草稿，请使用删除草稿接口
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=trash&project=mail&resource=user_mailbox.message&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/mailv1/TrashUserMailboxMessageSample.java ;
    
    抛出:
    
    Exception

类 UserMailboxMessage

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

UserMailboxMessage

方法详细资料

batchGet

batchGet

batchModify

batchModify

batchTrash

batchTrash

get

get

getByCard

getByCard

list

list

listThreadMessage

listThreadMessage

modify

modify

send

send

trash

trash