程序包 net.risesoft.controller.rest

类 EmailMobileController

java.lang.Object

net.risesoft.controller.rest.EmailMobileController

@RestController
@RequestMapping("/mobile")
public class EmailMobileController
extends Object

电子邮件接口

构造器概要

构造器

构造器	说明
EmailMobileController()

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<EmailAttachmentDTO>	addAttachment(String tenantId, String userId, String folder, String messageId, org.springframework.web.multipart.MultipartFile file)	上传附件
net.risesoft.pojo.Y9Result<Object>	addressBook(String tenantId, String userId, String id)	通讯录详情
net.risesoft.pojo.Y9Result<Object>	addressBookDelete(String tenantId, String userId, String id)	删除个人通讯录
net.risesoft.pojo.Y9Result<Object>	addressBookList(String tenantId, String userId)	获取个人通讯录列表
net.risesoft.pojo.Y9Result<Object>	addressBookSave(String tenantId, String userId, JamesAddressBook jamesAddressBook)	个人通讯录保存/修改
net.risesoft.pojo.Y9Result<Object>	addressBooksearch(String tenantId, String userId, String search)	个人通讯录查询
net.risesoft.pojo.Y9Result<Object>	addressRelevancy(String tenantId, String userId, String search)	邮件地址关联
void	batchDownload(String tenantId, String userId, String folder, String messageId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	批量下载文件
net.risesoft.pojo.Y9Result<Object>	contact(String tenantId, String userId)	联系人信息
net.risesoft.pojo.Y9Result<List<EmailFolderDTO>>	customList(String tenantId, String userId)	自定义文件夹列表
net.risesoft.pojo.Y9Result<Object>	delete(String tenantId, String userId, long[] uids, String folder)	删除邮件
net.risesoft.pojo.Y9Result<Object>	delete(String tenantId, String userId, String folder)	删除文件夹
net.risesoft.pojo.Y9Result<Object>	deleteAttachment(String tenantId, String userId, String folder, String messageId, String fileName)	删除附件
net.risesoft.pojo.Y9Result<Object>	deletePermanently(String tenantId, String userId, long[] uids, String folder)	永久删除邮件
net.risesoft.pojo.Y9Result<EmailDetailDTO>	detail(String tenantId, String userId, String folder, long uid)	邮件详情
void	download(String tenantId, String userId, String folder, String messageId, String fileName, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request)	附件下载
void	exportEml(String tenantId, String userId, String folder, int uid, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request)	导出邮件 eml
net.risesoft.pojo.Y9Result<Object>	flag(String tenantId, String userId, long[] uids, String folder, boolean flagged)	邮件标星
net.risesoft.pojo.Y9Result<EmailDTO>	forward(String tenantId, String userId, String folder, long uid)	转发邮件
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.OrgUnit>>	getOrgTree(String tenantId, String userId, String id, net.risesoft.enums.platform.OrgTreeTypeEnum treeType, String name)	获取组织树
net.risesoft.pojo.Y9Result<Map<String,String>>	getPersonData(String tenantId, String userId)	获取人员信息
net.risesoft.pojo.Y9Result<Map<String,Object>>	list(String tenantId, String userId)	所有文件夹列表，包括默认文件夹和自定义文件夹列表
net.risesoft.pojo.Y9Page<EmailListDTO>	list(String tenantId, String userId, int page, int size, String folder)	根据文件夹分页查找邮件列表
net.risesoft.pojo.Y9Result<Object>	move(String tenantId, String userId, long[] uids, String originFolder, String toFolder)	移动邮件
net.risesoft.pojo.Y9Result<EmailDTO>	quickReply(String tenantId, String userId, String folder, Long uid, String richText)	快速回复
net.risesoft.pojo.Y9Result<Object>	read(String tenantId, String userId, long[] uids, String folder, Boolean isRead)	标记为已读或未读
net.risesoft.pojo.Y9Result<EmailDTO>	reply(String tenantId, String userId, String folder, Long uid)	回复
net.risesoft.pojo.Y9Result<EmailDTO>	replyAll(String tenantId, String userId, String folder, Long uid)	回复不包括自己和密送的其他所有收件人
net.risesoft.pojo.Y9Result<Object>	save(String tenantId, String userId, String originFolderName, String newFolderName)	新增或修改文件夹
net.risesoft.pojo.Y9Result<String>	save(String tenantId, String userId, EmailDTO email)	保存邮件
net.risesoft.pojo.Y9Page<EmailListDTO>	search(String tenantId, String userId, EmailSearchDTO searchDTO)	搜索邮件
net.risesoft.pojo.Y9Result<Object>	send(String tenantId, String userId, String messageId)	发送邮件
net.risesoft.pojo.Y9Result<Object>	todoList(String tenantId, String userId)	待办数量列表
net.risesoft.pojo.Y9Result<Object>	unread(String tenantId, String userId)	收件箱邮件未读消息数

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

EmailMobileController

public EmailMobileController()

方法详细资料

delete

@DeleteMapping(value="/email",
               produces="application/json")
public net.risesoft.pojo.Y9Result<Object> delete(@RequestHeader("auth-tenantId")
                                                 String tenantId,
                                                 @RequestHeader("auth-userId")
                                                 String userId,
                                                 @RequestParam("uids")
                                                 long[] uids,
                                                 String folder)
                                          throws javax.mail.MessagingException

删除邮件

参数:

tenantId - 租户id

userId - 用户id

uids - 邮件 uid

folder - 文件夹

返回:

Y9Result<Object>

抛出:

javax.mail.MessagingException - 通讯异常

deletePermanently

@DeleteMapping(value="/permanently",
               produces="application/json")
public net.risesoft.pojo.Y9Result<Object> deletePermanently(@RequestHeader("auth-tenantId")
                                                            String tenantId,
                                                            @RequestHeader("auth-userId")
                                                            String userId,
                                                            @RequestParam("uids")
                                                            long[] uids,
                                                            String folder)
                                                     throws javax.mail.MessagingException

永久删除邮件

参数:

tenantId - 租户id

userId - 用户id

uids - 邮件 uid

folder - 文件夹

返回:

Y9Result<Object>

抛出:

javax.mail.MessagingException - 通讯异常

detail

@GetMapping(value="/{folder}/{uid}",
            produces="application/json")
public net.risesoft.pojo.Y9Result<EmailDetailDTO> detail(@RequestHeader("auth-tenantId")
                                                         String tenantId,
                                                         @RequestHeader("auth-userId")
                                                         String userId,
                                                         @PathVariable
                                                         String folder,
                                                         @PathVariable
                                                         long uid)
                                                  throws Exception

邮件详情

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

uid - 邮件 uid

返回:

Y9Result<EmailDetailDTO>

抛出:

Exception - 异常

exportEml

@GetMapping(value="/exportEml",
            produces="application/json")
public void exportEml(@RequestHeader("auth-tenantId")
                      String tenantId,
                      @RequestHeader("auth-userId")
                      String userId,
                      String folder,
                      int uid,
                      javax.servlet.http.HttpServletResponse response,
                      javax.servlet.http.HttpServletRequest request)
               throws javax.mail.MessagingException,
                      IOException

导出邮件 eml

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

uid - 邮件 uid

response - 响应

request - 请求

抛出:

javax.mail.MessagingException - 通讯异常

IOException - IO异常

flag

@PostMapping(value="/flag",
             produces="application/json")
public net.risesoft.pojo.Y9Result<Object> flag(@RequestHeader("auth-tenantId")
                                               String tenantId,
                                               @RequestHeader("auth-userId")
                                               String userId,
                                               @RequestParam("uids")
                                               long[] uids,
                                               @RequestParam
                                               String folder,
                                               boolean flagged)
                                        throws Exception

邮件标星

参数:

tenantId - 租户id

userId - 用户id

uids - 邮件 uid

folder - 文件夹

flagged - 是否标星

返回:

Y9Result<Object>

抛出:

Exception - 异常

forward

@GetMapping(value="/forward/{folder}/{uid}",
            produces="application/json")
public net.risesoft.pojo.Y9Result<EmailDTO> forward(@RequestHeader("auth-tenantId")
                                                    String tenantId,
                                                    @RequestHeader("auth-userId")
                                                    String userId,
                                                    @PathVariable
                                                    String folder,
                                                    @PathVariable
                                                    long uid)
                                             throws Exception

转发邮件

参数:

tenantId - 租户id

userId - 用户id

uid - 消息 uid

folder - 文件夹

返回:

Y9Result<EmailDTO>

抛出:

Exception - 异常

list

@GetMapping("/list")
public net.risesoft.pojo.Y9Page<EmailListDTO> list(@RequestHeader("auth-tenantId")
                                                   String tenantId,
                                                   @RequestHeader("auth-userId")
                                                   String userId,
                                                   int page,
                                                   @RequestParam
                                                   int size,
                                                   @RequestParam(required=false)
                                                   String folder)
                                            throws IOException,
                                                   javax.mail.MessagingException

根据文件夹分页查找邮件列表

参数:

tenantId - 租户id

userId - 用户id

page - 页数

size - 每页数量

folder - 文件夹

返回:

Y9Page<EmailListDTO>

抛出:

IOException - IO异常

javax.mail.MessagingException - 通讯异常

move

@PostMapping(value="/move",
             produces="application/json")
public net.risesoft.pojo.Y9Result<Object> move(@RequestHeader("auth-tenantId")
                                               String tenantId,
                                               @RequestHeader("auth-userId")
                                               String userId,
                                               @RequestParam("uids")
                                               long[] uids,
                                               String originFolder,
                                               String toFolder)
                                        throws javax.mail.MessagingException

移动邮件

参数:

tenantId - 租户id

userId - 用户id

uids - 邮件 uid

originFolder - 原始文件夹

toFolder - 移动至文件夹

返回:

Y9Result<Object>

抛出:

javax.mail.MessagingException - 通讯异常

read

@PostMapping(value="/read",
             produces="application/json")
public net.risesoft.pojo.Y9Result<Object> read(@RequestHeader("auth-tenantId")
                                               String tenantId,
                                               @RequestHeader("auth-userId")
                                               String userId,
                                               @RequestParam("uids")
                                               long[] uids,
                                               @RequestParam
                                               String folder,
                                               @RequestParam
                                               Boolean isRead)
                                        throws Exception

标记为已读或未读

参数:

tenantId - 租户id

userId - 用户id

uids - 邮件 uid

folder - 文件夹

isRead - 是否已读

返回:

Y9Result<Object>

抛出:

Exception - 异常

reply

@GetMapping(value="/reply/{folder}/{uid}",
            produces="application/json")
public net.risesoft.pojo.Y9Result<EmailDTO> reply(@RequestHeader("auth-tenantId")
                                                  String tenantId,
                                                  @RequestHeader("auth-userId")
                                                  String userId,
                                                  @PathVariable
                                                  String folder,
                                                  @PathVariable
                                                  Long uid)
                                           throws Exception

回复

参数:

tenantId - 租户id

userId - 用户id

uid - 邮件 uid

folder - 文件夹

返回:

Y9Result<EmailDTO>

抛出:

Exception - 异常

quickReply

@PostMapping(value="/quickReply/{folder}/{uid}",
             produces="application/json")
public net.risesoft.pojo.Y9Result<EmailDTO> quickReply(@RequestHeader("auth-tenantId")
                                                       String tenantId,
                                                       @RequestHeader("auth-userId")
                                                       String userId,
                                                       @PathVariable
                                                       String folder,
                                                       @PathVariable
                                                       Long uid,
                                                       @RequestParam
                                                       String richText)
                                                throws Exception

快速回复

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

uid - uid

richText - 回复内容

返回:

Y9Result<EmailDTO>

抛出:

Exception - 异常

replyAll

@GetMapping(value="/replyAll/{folder}/{uid}",
            produces="application/json")
public net.risesoft.pojo.Y9Result<EmailDTO> replyAll(@RequestHeader("auth-tenantId")
                                                     String tenantId,
                                                     @RequestHeader("auth-userId")
                                                     String userId,
                                                     @PathVariable
                                                     String folder,
                                                     @PathVariable
                                                     Long uid)
                                              throws Exception

回复不包括自己和密送的其他所有收件人

参数:

tenantId - 租户id

userId - 用户id

uid - 邮件 uid

folder - 文件夹

返回:

Y9Result<EmailDTO>

抛出:

Exception - 异常

save

@PostMapping(value="/save",
             produces="application/json")
public net.risesoft.pojo.Y9Result<String> save(@RequestHeader("auth-tenantId")
                                               String tenantId,
                                               @RequestHeader("auth-userId")
                                               String userId,
                                               EmailDTO email)
                                        throws Exception

保存邮件

参数:

tenantId - 租户id

userId - 用户id

email - 邮件

返回:

Y9Result<String>

抛出:

Exception - 异常

search

@GetMapping(value="/search",
            produces="application/json")
public net.risesoft.pojo.Y9Page<EmailListDTO> search(@RequestHeader("auth-tenantId")
                                                     String tenantId,
                                                     @RequestHeader("auth-userId")
                                                     String userId,
                                                     EmailSearchDTO searchDTO)
                                              throws javax.mail.MessagingException,
                                                     IOException

搜索邮件

参数:

tenantId - 租户id

userId - 用户id

searchDTO - 搜索dto

返回:

Y9Page<EmailListDTO>

抛出:

javax.mail.MessagingException - 通讯异常

IOException - IO异常

send

@PostMapping(value="/send",
             produces="application/json")
public net.risesoft.pojo.Y9Result<Object> send(@RequestHeader("auth-tenantId")
                                               String tenantId,
                                               @RequestHeader("auth-userId")
                                               String userId,
                                               String messageId)
                                        throws Exception

发送邮件

参数:

tenantId - 租户id

userId - 用户id

messageId - 消息id

返回:

Y9Result<Object>

抛出:

Exception - 异常

todoList

@GetMapping(value="/todoList",
            produces="application/json")
public net.risesoft.pojo.Y9Result<Object> todoList(@RequestHeader("auth-tenantId")
                                                   String tenantId,
                                                   @RequestHeader("auth-userId")
                                                   String userId)
                                            throws javax.mail.MessagingException

待办数量列表

参数:

tenantId - 租户id

userId - 用户id

返回:

Y9Result<Object>

抛出:

javax.mail.MessagingException - 通讯异常

addAttachment

@PostMapping(value="/addAttachment",
             produces="application/json")
public net.risesoft.pojo.Y9Result<EmailAttachmentDTO> addAttachment(@RequestHeader("auth-tenantId")
                                                                    String tenantId,
                                                                    @RequestHeader("auth-userId")
                                                                    String userId,
                                                                    String folder,
                                                                    String messageId,
                                                                    org.springframework.web.multipart.MultipartFile file)
                                                             throws Exception

上传附件

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

messageId - 消息id

file - 文件

返回:

Y9Result<EmailAttachmentDTO>

抛出:

Exception - 异常

download

@RequestMapping(value="/download",
                produces="application/json")
public void download(@RequestHeader("auth-tenantId")
                     String tenantId,
                     @RequestHeader("auth-userId")
                     String userId,
                     String folder,
                     String messageId,
                     String fileName,
                     javax.servlet.http.HttpServletResponse response,
                     javax.servlet.http.HttpServletRequest request)

附件下载

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

messageId - 消息id

fileName - 文件名

response - 响应

request - 请求

batchDownload

@RequestMapping(value="/batchDownload",
                produces="application/json")
public void batchDownload(@RequestHeader("auth-tenantId")
                          String tenantId,
                          @RequestHeader("auth-userId")
                          String userId,
                          String folder,
                          String messageId,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)

批量下载文件

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

messageId - 消息id

request - 请求

response - 响应

deleteAttachment

@DeleteMapping(value="/deleteAttachment",
               produces="application/json")
public net.risesoft.pojo.Y9Result<Object> deleteAttachment(@RequestHeader("auth-tenantId")
                                                           String tenantId,
                                                           @RequestHeader("auth-userId")
                                                           String userId,
                                                           String folder,
                                                           String messageId,
                                                           String fileName)
                                                    throws Exception

删除附件

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

messageId - 消息id

fileName - 文件名称

返回:

Y9Result<Object>

抛出:

Exception - 异常

save

@PostMapping(value="/folder",
             produces="application/json")
public net.risesoft.pojo.Y9Result<Object> save(@RequestHeader("auth-tenantId")
                                               String tenantId,
                                               @RequestHeader("auth-userId")
                                               String userId,
                                               String originFolderName,
                                               String newFolderName)

新增或修改文件夹

参数:

tenantId - 租户id

userId - 用户id

originFolderName - 原始文件夹名称 （不为空时代表修改）

newFolderName - 新文件夹名称

返回:

Y9Result<Object>

delete

@DeleteMapping(value="/folder",
               produces="application/json")
public net.risesoft.pojo.Y9Result<Object> delete(@RequestHeader("auth-tenantId")
                                                 String tenantId,
                                                 @RequestHeader("auth-userId")
                                                 String userId,
                                                 String folder)

删除文件夹

参数:

tenantId - 租户id

userId - 用户id

folder - 文件夹

返回:

Y9Result<Object>

customList

@GetMapping(value="/folder/customList",
            produces="application/json")
public net.risesoft.pojo.Y9Result<List<EmailFolderDTO>> customList(@RequestHeader("auth-tenantId")
                                                                   String tenantId,
                                                                   @RequestHeader("auth-userId")
                                                                   String userId)
                                                            throws javax.mail.MessagingException

自定义文件夹列表

参数:

tenantId - 租户id

userId - 用户id

返回:

Y9Result<List<EmailFolderDTO>>

抛出:

javax.mail.MessagingException - 通讯异常

list

@GetMapping(value="/allList",
            produces="application/json")
public net.risesoft.pojo.Y9Result<Map<String,Object>> list(@RequestHeader("auth-tenantId")
                                                                 String tenantId,
                                                                 @RequestHeader("auth-userId")
                                                                 String userId)
                                                          throws javax.mail.MessagingException

所有文件夹列表，包括默认文件夹和自定义文件夹列表

参数:

tenantId - 租户id

userId - 用户id

返回:

Y9Result<Map<String, Object>>

抛出:

javax.mail.MessagingException - 通讯异常

getOrgTree

@RequestMapping(value="/getOrgTree",
                produces="application/json")
public net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.OrgUnit>> getOrgTree(@RequestHeader("auth-tenantId")
                                                                                        String tenantId,
                                                                                        @RequestHeader("auth-userId")
                                                                                        String userId,
                                                                                        @RequestParam(required=false)
                                                                                        String id,
                                                                                        @RequestParam(required=false)
                                                                                        net.risesoft.enums.platform.OrgTreeTypeEnum treeType,
                                                                                        @RequestParam(required=false)
                                                                                        String name)

获取组织树

参数:

tenantId - 租户id

userId - 用户id

id - id

treeType - 树类型

name - 名字

返回:

Y9Result<List<OrgUnit>>

getPersonData

@GetMapping(value="/getPersonData",
            produces="application/json")
public net.risesoft.pojo.Y9Result<Map<String,String>> getPersonData(@RequestHeader("auth-tenantId")
                                                                          String tenantId,
                                                                          @RequestHeader("auth-userId")
                                                                          String userId)

获取人员信息

参数:

tenantId - 租户id

userId - 人员id

返回:

Y9Result<Map<String, String>>

contact

@GetMapping(value="/contact",
            produces="application/json")
public net.risesoft.pojo.Y9Result<Object> contact(@RequestHeader("auth-tenantId")
                                                  String tenantId,
                                                  @RequestHeader("auth-userId")
                                                  String userId)
                                           throws javax.mail.MessagingException,
                                                  IOException

联系人信息

参数:

tenantId - 租户id

userId - 人员id

返回:

Y9Result<Object>

抛出:

javax.mail.MessagingException - 通讯异常

IOException - IO异常

addressBookSave

@PostMapping("/addressBookSave")
public net.risesoft.pojo.Y9Result<Object> addressBookSave(@RequestHeader("auth-tenantId")
                                                          String tenantId,
                                                          @RequestHeader("auth-userId")
                                                          String userId,
                                                          JamesAddressBook jamesAddressBook)
                                                   throws Exception

个人通讯录保存/修改

参数:

tenantId - 租户id

userId - 用户id

jamesAddressBook - 通讯录信息

返回:

Y9Result<Object>

抛出:

Exception - 异常

addressBooksearch

@GetMapping("/addressBooksearch")
public net.risesoft.pojo.Y9Result<Object> addressBooksearch(@RequestHeader("auth-tenantId")
                                                            String tenantId,
                                                            @RequestHeader("auth-userId")
                                                            String userId,
                                                            String search)

个人通讯录查询

参数:

tenantId - 租户id

userId - 用户id

search - 邮件地址/姓名

返回:

Y9Result<Object>

addressBook

@GetMapping("/addressBook")
public net.risesoft.pojo.Y9Result<Object> addressBook(@RequestHeader("auth-tenantId")
                                                      String tenantId,
                                                      @RequestHeader("auth-userId")
                                                      String userId,
                                                      String id)

通讯录详情

参数:

tenantId - 租户id

userId - 用户id

id - 通讯录唯一id

返回:

Y9Result<Object>

addressBookList

@GetMapping("/addressBookList")
public net.risesoft.pojo.Y9Result<Object> addressBookList(@RequestHeader("auth-tenantId")
                                                          String tenantId,
                                                          @RequestHeader("auth-userId")
                                                          String userId)

获取个人通讯录列表

参数:

tenantId - 租户id

userId - 用户id

返回:

Y9Result<Object>

addressBookDelete

@DeleteMapping("/addressBookDelete")
public net.risesoft.pojo.Y9Result<Object> addressBookDelete(@RequestHeader("auth-tenantId")
                                                            String tenantId,
                                                            @RequestHeader("auth-userId")
                                                            String userId,
                                                            String id)

删除个人通讯录

参数:

tenantId - 租户id

userId - 用户id

id - 通讯录唯一id

返回:

Y9Result<Object>

addressRelevancy

@GetMapping("/addressRelevancy")
public net.risesoft.pojo.Y9Result<Object> addressRelevancy(@RequestHeader("auth-tenantId")
                                                           String tenantId,
                                                           @RequestHeader("auth-userId")
                                                           String userId,
                                                           String search)

邮件地址关联

参数:

tenantId - 租户id

userId - 用户id

search - 邮件地址/姓名

返回:

Y9Result<Object>

unread

@GetMapping("/unread")
public net.risesoft.pojo.Y9Result<Object> unread(@RequestHeader("auth-tenantId")
                                                 String tenantId,
                                                 @RequestHeader("auth-userId")
                                                 String userId)
                                          throws Exception

收件箱邮件未读消息数

参数:

tenantId - 租户id

userId - 用户id search 邮件地址/姓名

返回:

Y9Result<Object>

抛出:

Exception - 异常

Date:

2024/2/27 10:31