Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 使用Systemctl启动项目
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
    • 已过时
    • 胖包与瘦包的打包与部署
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • 拦截器
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • Http响应加密
    • 在 Tio-boot 中使用零拷贝发送大文件
    • WebJars
    • JProtobuf
    • Tio-Boot HTTP Speed Test
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板 (SqlTemplates)
    • 数据源配置与使用
    • ActiveRecord
    • Db 工具类
    • 批量操作
    • Model
    • 生成器与 Model
    • 异常处理
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • 使用 tio-core 在 tio-boot 中构建独立的 TCP 服务器
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • SSL
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 与 magic-script 集成指南
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-kit-server

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • Teach me anything - 基于大语言的知识点讲解视频生成系统
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • /zh/66_manim/32.html
    • /zh/66_manim/33.html
  • 68_java-llm-proxy

    • 使用tio-boot搭建openai 代理服务
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 73_tio-mail-wing

    • tio-mail-wing简介
    • 任务1:实现POP3系统
    • 使用 getmail 验证 tio-mail-wing POP3 服务
    • 任务2:实现 SMTP 服务
    • 数据库初始化文档
    • 用户管理
    • 邮件管理
    • 任务3:实现 SMTP 服务 数据库版本
    • 任务4:实现 POP3 服务(数据库版本)
    • IMAP 协议
    • 任务5:实现 IMAP 服务(数据库版本)
    • IMAP实现讲解
    • IMAP 手动测试脚本
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

任务5:实现 IMAP 服务(数据库版本)

  • 任务概述
  • 1. ImapPacket
  • 2. ImapSessionContext
  • 3. ImapServerAioListener
  • 4. ImapServerAioHandler
  • 5. ImapServerConfig
  • 6. ImapService
  • 7.ImapFetchService
  • 小结

任务概述

本任务旨在基于 T-IO 框架和数据库后端,实现一个完整的 IMAP 服务。系统包含以下几部分:

  1. ImapPacket:用于表示网络数据包的简单封装。
  2. ImapSessionContext:会话级上下文,用于管理客户端状态、登录信息和当前选中邮箱。
  3. ImapServerAioListener:连接级监听器,负责发送欢迎消息及断开时日志记录。
  4. ImapServerAioHandler:核心处理器,负责协议报文的解码、编码与命令分发。
  5. ImapServerConfig:服务启动配置类,负责读取端口并启动 TioServer。
  6. ImapService:集中处理各类 IMAP 命令,和数据库(通过 ActiveRecord)交互,完成邮件列表、SELECT/FETCH/STORE/EXPUNGE 等操作。

1. ImapPacket

// src/main/java/com/tio/mail/wing/packet/ImapPacket.java
package com.tio.mail.wing.packet;

import com.litongjava.aio.Packet;

@SuppressWarnings("serial")
public class ImapPacket extends Packet {
  private String line;

  public ImapPacket(String line) {
    this.line = line;
  }

  public String getLine() {
    return line;
  }
}
  • 功能:继承自 com.litongjava.aio.Packet,内部只保存一行文本。
  • 用途:在 T-IO 的编解码流程中,承载单条 IMAP 协议行数据。

2. ImapSessionContext

package com.tio.mail.wing.handler;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class ImapSessionContext {

  public enum State {
    /** 未认证 */
    NON_AUTHENTICATED,
    /** 等待 Base64 编码的用户名 */
    AUTH_WAIT_USERNAME,
    /** 等待 Base64 编码的密码 */
    AUTH_WAIT_PASSWORD,
    /** 已认证 */
    AUTHENTICATED,
    /** 已选择邮箱 */
    SELECTED
  }

  private State state = State.NON_AUTHENTICATED;
  private Long userId;
  private String username;
  private String selectedMailbox;

  /**
   * 用于暂存 AUTHENTICATE 命令的 tag,
   * 以便在多步交互后能正确响应
   */
  private String currentCommandTag;
}
  • State 枚举:生命周期从“未认证”到“已选择邮箱”五种状态。

  • 字段:

    • state:当前状态。
    • userId、username:登录用户信息。
    • selectedMailbox:当前选中的邮箱名称。
    • currentCommandTag:AUTHENTICATE 多步交互时暂存客户端 tag。

3. ImapServerAioListener

package com.tio.mail.wing.listener;

import com.litongjava.aio.Packet;
import com.litongjava.tio.core.ChannelContext;
import com.litongjava.tio.core.Tio;
import com.litongjava.tio.server.intf.ServerAioListener;
import com.tio.mail.wing.handler.ImapSessionContext;
import com.tio.mail.wing.packet.ImapPacket;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ImapServerAioListener implements ServerAioListener {

  @Override
  public void onAfterConnected(ChannelContext channelContext,
                               boolean isConnected,
                               boolean isReconnect) throws Exception {
    if (isConnected) {
      log.info("IMAP client connected: {}", channelContext.getClientNode());
      channelContext.set("sessionContext", new ImapSessionContext());
      // 发送欢迎消息
      Tio.send(channelContext,
               new ImapPacket("* OK tio-mail-wing IMAP4rev1 server ready \r\n"));
    }
  }

  @Override
  public void onBeforeClose(ChannelContext channelContext,
                            Throwable throwable,
                            String remark,
                            boolean isRemove) throws Exception {
    log.info("IMAP client disconnected: {}", channelContext.getClientNode());
  }

  @Override public void onAfterDecoded(ChannelContext channelContext,
                                        Packet packet,
                                        int packetSize) throws Exception { }
  @Override public void onAfterReceivedBytes(ChannelContext channelContext,
                                             int receivedBytes) throws Exception { }
  @Override public void onAfterSent(ChannelContext channelContext,
                                    Packet packet,
                                    boolean isSentSuccess) throws Exception { }
  @Override public void onAfterHandled(ChannelContext channelContext,
                                       Packet packet,
                                       long cost) throws Exception { }
  @Override public boolean onHeartbeatTimeout(ChannelContext channelContext,
                                              Long interval,
                                              int heartbeatTimeoutCount) {
    return false;
  }

}
  • onAfterConnected:首次建立连接时,创建 ImapSessionContext 并发送 IMAP 欢迎行。
  • onBeforeClose:连接断开时记录日志。
  • 其余回调目前留空,可根据需要扩展心跳、流量统计、数据解码前后日志等。

4. ImapServerAioHandler

package com.tio.mail.wing.handler;

import java.nio.ByteBuffer;

import com.litongjava.aio.Packet;
import com.litongjava.db.activerecord.ActiveRecordException;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.tio.core.ChannelContext;
import com.litongjava.tio.core.Tio;
import com.litongjava.tio.core.TioConfig;
import com.litongjava.tio.core.exception.LengthOverflowException;
import com.litongjava.tio.core.exception.TioDecodeException;
import com.litongjava.tio.core.utils.ByteBufferUtils;
import com.litongjava.tio.server.intf.ServerAioHandler;
import com.tio.mail.wing.packet.ImapPacket;
import com.tio.mail.wing.service.ImapFetchService;
import com.tio.mail.wing.service.ImapService;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ImapServerAioHandler implements ServerAioHandler {

  private ImapService imapService = Aop.get(ImapService.class);

  @Override
  public Packet decode(ByteBuffer buffer, int limit, int position, int readableLength, ChannelContext ctx) throws TioDecodeException {
    String charset = ctx.getTioConfig().getCharset();
    String line = null;
    try {
      line = ByteBufferUtils.readLine(buffer, charset);
    } catch (LengthOverflowException e) {
      log.error("Line length overflow", e);
    }
    return line == null ? null : new ImapPacket(line);
  }

  @Override
  public ByteBuffer encode(Packet packet, TioConfig tioConfig, ChannelContext ctx) {
    String charset = ctx.getTioConfig().getCharset();
    ImapPacket imapPacket = (ImapPacket) packet;
    try {
      return ByteBuffer.wrap(imapPacket.getLine().getBytes(charset));
    } catch (Exception e) {
      log.error("Encoding error", e);
      return null;
    }
  }

  @Override
  public void handler(Packet packet, ChannelContext ctx) throws Exception {
    ImapPacket imapPacket = (ImapPacket) packet;
    String line = imapPacket.getLine().trim();
    ImapSessionContext session = (ImapSessionContext) ctx.get("sessionContext");
    String username = session.getUsername();
    if (username != null) {
      log.info("user {} <<< {}", username, line);
    } else {
      log.info("<<< {}", line);
    }

    if (session.getState() == ImapSessionContext.State.AUTH_WAIT_USERNAME || session.getState() == ImapSessionContext.State.AUTH_WAIT_PASSWORD) {
      String reply = imapService.handleAuthData(session, line);
      if (reply != null) {
        Tio.send(ctx, new ImapPacket(reply));
      }
      return;
    }

    String[] parts = line.split("\\s+", 3);
    String tag = parts[0];
    String command = parts.length > 1 ? parts[1].toUpperCase() : "";
    String args = parts.length > 2 ? parts[2] : "";

    String reply = null;
    try {
      switch (command) {
      case "CAPABILITY":
        reply = imapService.handleCapability(tag);
        break;
      case "ID":
        reply = imapService.handleId(tag);
        break;
      case "IDLE":
        reply = imapService.handleIdle();
        break;
      case "AUTHENTICATE":
        reply = imapService.handleAuthenticate(session, tag, args);
        break;
      case "LOGIN":
        reply = imapService.handleLogin(session, tag, args);
        break;
      case "LOGOUT":
        reply = imapService.handleLogout(session, tag);
        if (reply != null) {
          Tio.send(ctx, new ImapPacket(reply));
        }
        Tio.close(ctx, "logout");
        return;
      case "CLOSE":
        reply = imapService.handleClose(session, tag);
      case "LIST":
        reply = imapService.handleList(session, tag, args);
        break;
      case "LSUB":
        reply = imapService.handleList(session, tag, args);
        break;
      case "CREATE":
        reply = imapService.handleCreate(session, tag, args);
        break;
      case "SUBSCRIBE":
        reply = imapService.handleSubscribe(tag);
        break;
      case "SELECT":
        reply = imapService.handleSelect(session, tag, args);
        break;
      case "FETCH":
        // 传递 isUidCommand = false
        ImapFetchService imapFetchService = Aop.get(ImapFetchService.class);
        reply = imapFetchService.handleFetch(session, tag, args, false);
        break;
      case "STORE":
        // 传递 isUidCommand = false
        reply = imapService.handleStore(session, tag, args, false);
        break;
      case "UID":
        reply = imapService.handleUid(session, tag, args);
        break;
      case "NOOP":
        reply = tag + " OK NOOP";
      case "EXPUNGE":
        reply = imapService.handleExpunge(session, tag);
        break;
      default:
        reply = tag + " BAD Unknown or unimplemented command.\r\n";
      }
    } catch (Exception e) {
      reply = tag + " BAD Internal server error.\r\n";
      if (e instanceof ActiveRecordException) {
        ActiveRecordException ae = (ActiveRecordException) e;
        log.error("Error handling IMAP command:{},{},{}", line, ae.getSql(), ae.getParas(), e);
      } else {
        log.error("Error handling IMAP command: " + line, e);
      }
    }

    if (reply != null) {
      Tio.send(ctx, new ImapPacket(reply));
    }
  }

}
  • decode/encode:逐行读写,保证 IMAP 协议的 “CRLF+行” 交互。
  • handler:根据客户端发送的 tag、command、args 三部分,调用 ImapService 对应方法。
  • 异常处理:对 DB 操作异常(ActiveRecordException)做日志输出,并统一返回 BAD 应答。

5. ImapServerConfig

package com.tio.mail.wing.config;

import java.io.IOException;

import com.litongjava.tio.server.ServerTioConfig;
import com.litongjava.tio.server.TioServer;
import com.litongjava.tio.utils.environment.EnvUtils;
import com.tio.mail.wing.handler.ImapServerAioHandler;
import com.tio.mail.wing.listener.ImapServerAioListener;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ImapServerConfig {

  public void startImapServer() {
    ImapServerAioHandler serverHandler   = new ImapServerAioHandler();
    ImapServerAioListener serverListener = new ImapServerAioListener();

    ServerTioConfig serverTioConfig = new ServerTioConfig("imap-server");
    serverTioConfig.setServerAioHandler(serverHandler);
    serverTioConfig.setServerAioListener(serverListener);
    serverTioConfig.setHeartbeatTimeout(-1);
    serverTioConfig.checkAttacks    = false;
    serverTioConfig.ignoreDecodeFail = true;
    serverTioConfig.setWorkerThreads(4);

    TioServer tioServer = new TioServer(serverTioConfig);

    try {
      int port = EnvUtils.getInt("mail.server.imap.port", 143);
      tioServer.start(null, port);
      log.info("Started IMAP server on port: {}", port);
    } catch (IOException e) {
      log.error("Failed to start IMAP server", e);
    }
  }
}
  • EnvUtils:从环境变量或配置文件读取 mail.server.imap.port,默认 143。
  • TioServer:利用 ServerTioConfig 启动 TCP 服务,实现 IMAP 协议监听。

6. ImapService

package com.tio.mail.wing.service;

import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import com.litongjava.db.activerecord.Row;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.tio.utils.base64.Base64Utils;
import com.tio.mail.wing.consts.MailBoxName;
import com.tio.mail.wing.handler.ImapSessionContext;
import com.tio.mail.wing.model.Email;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ImapService {

  private final MwUserService userService = Aop.get(MwUserService.class);
  private final MailboxService mailboxService = Aop.get(MailboxService.class);

  /**
   * EXPUNGE: 逻辑删除并通知客户端
   */
  public String handleExpunge(ImapSessionContext session, String tag) {
    String username = session.getUsername();
    String mailbox = session.getSelectedMailbox();
    StringBuilder sb = new StringBuilder();

    // 查询所有待 EXPUNGE 的 seq_num
    List<Integer> seqs = mailboxService.getExpungeSeqNums(username, mailbox);
    // 逻辑删除数据
    mailboxService.expunge(username, mailbox);

    // 通知客户端
    for (int seq : seqs) {
      sb.append("* ").append(seq).append(" EXPUNGE").append("\r\n");
    }
    sb.append(tag).append(" OK EXPUNGE completed.").append("\r\n");
    return sb.toString();
  }

  /**
   * CREATE: 在数据库中创建新邮箱目录
   */
  public String handleCreate(ImapSessionContext session, String tag, String args) {
    String mailboxName = unquote(args);
    mailboxService.createMailbox(session.getUsername(), mailboxName);
    return tag + " OK CREATE completed." + "\r\n";
  }

  /**
   * LIST: 从数据库中获取所有用户邮箱目录
   */
  public String handleList(ImapSessionContext session, String tag, String args) {
    String username = session.getUsername();
    List<String> mailboxes = mailboxService.listMailboxes(username);
    StringBuilder sb = new StringBuilder();
    for (String m : mailboxes) {
      if (m.equalsIgnoreCase(MailBoxName.TRASH)) {
        sb.append("* LIST (\\HasNoChildren) \"/\" ").append("Trash").append("\r\n");
      } else {
        sb.append("* LIST (\\HasNoChildren) \"/\" ").append(m).append("\r\n");
      }

    }
    sb.append(tag).append(" OK LIST completed.").append("\r\n");
    return sb.toString();
  }

  public String handleSubscribe(String tag) {
    return tag + " OK SUBSCRIBE" + "\r\n";
  }

  public String handleCapability(String tag) {
    StringBuilder sb = new StringBuilder();
    sb.append("* CAPABILITY IMAP4rev1 AUTH=LOGIN IDLE UIDPLUS ID LITERAL+ MOVE").append("\r\n");
    sb.append(tag).append(" OK CAPABILITY").append("\r\n");
    return sb.toString();
  }

  public String handleId(String tag) {
    StringBuilder sb = new StringBuilder();
    sb.append("* ID (\"name\" \"tio-mail-wing\")").append("\r\n");
    sb.append(tag).append(" OK ID completed.").append("\r\n");
    return sb.toString();
  }

  public String handleIdle() {
    return "+ idling" + "\r\n";
  }

  public String handleAuthenticate(ImapSessionContext session, String tag, String mech) {
    StringBuilder sb = new StringBuilder();
    if (!"LOGIN".equalsIgnoreCase(mech) && !"PLAIN".equalsIgnoreCase(mech)) {
      sb.append(tag).append(" BAD Unsupported authentication mechanism").append("\r\n");
      return sb.toString();
    }
    session.setCurrentCommandTag(tag);
    if ("LOGIN".equalsIgnoreCase(mech)) {
      session.setState(ImapSessionContext.State.AUTH_WAIT_USERNAME);
      String chal = Base64Utils.encodeToString("Username:".getBytes(StandardCharsets.UTF_8));
      sb.append("+ ").append(chal).append("\r\n");
    } else {
      session.setState(ImapSessionContext.State.AUTH_WAIT_PASSWORD);
      sb.append("+ ").append("\r\n");
    }
    return sb.toString();
  }

  public String handleAuthData(ImapSessionContext session, String data) {
    String tag = session.getCurrentCommandTag();
    StringBuilder sb = new StringBuilder();
    try {
      String decoded = Base64Utils.decodeToString(data);
      if (session.getState() == ImapSessionContext.State.AUTH_WAIT_USERNAME) {
        session.setUsername(decoded);
        session.setState(ImapSessionContext.State.AUTH_WAIT_PASSWORD);
        String chal = Base64Utils.encodeToString("Password:".getBytes(StandardCharsets.UTF_8));
        sb.append("+ ").append(chal).append("\r\n");

      } else if (session.getState() == ImapSessionContext.State.AUTH_WAIT_PASSWORD) {
        String user, pass;
        if (decoded.contains("\0")) {
          String[] parts = decoded.split("\0");
          user = parts.length > 1 ? parts[1] : "";
          pass = parts.length > 2 ? parts[2] : "";
        } else {
          user = session.getUsername();
          pass = decoded;
        }
        Long userId = userService.authenticate(user, pass);
        if (userId != null) {
          session.setUsername(user);
          session.setUserId(userId);
          session.setState(ImapSessionContext.State.AUTHENTICATED);
          sb.append(tag).append(" OK AUTHENTICATE completed.").append("\r\n");
        } else {
          session.setState(ImapSessionContext.State.NON_AUTHENTICATED);
          sb.append(tag).append(" NO AUTHENTICATE failed: Authentication failed").append("\r\n");
        }
        session.setCurrentCommandTag(null);
      }
    } catch (IllegalArgumentException e) {
      session.setState(ImapSessionContext.State.NON_AUTHENTICATED);
      sb.append(tag).append(" BAD Invalid base64 data").append("\r\n");
      session.setCurrentCommandTag(null);
    }
    return sb.toString();
  }

  public String handleLogin(ImapSessionContext session, String tag, String args) {
    String[] parts = args.split("\\s+", 2);
    if (parts.length < 2) {
      return tag + " BAD login arguments invalid" + "\r\n";
    }
    String user = unquote(parts[0]);
    String pass = unquote(parts[1]);
    Long userId = userService.authenticate(user, pass);
    if (userId != null) {
      session.setUsername(user);
      session.setUserId(userId);

      session.setState(ImapSessionContext.State.AUTHENTICATED);
      return tag + " OK LOGIN completed." + "\r\n";
    } else {
      return tag + " NO LOGIN failed: Authentication failed" + "\r\n";
    }
  }

  public String handleLogout(ImapSessionContext session, String tag) {
    if (session.getState() == ImapSessionContext.State.SELECTED) {
      mailboxService.expunge(session.getUsername(), session.getSelectedMailbox());
      session.setSelectedMailbox(null);
      session.setSelectedMailboxId(null);
    }
    StringBuilder sb = new StringBuilder();
    sb.append("* BYE tio-mail-wing IMAP4rev1 server signing off").append("\r\n");
    sb.append(tag).append(" OK LOGOUT").append("\r\n");
    return sb.toString();
  }

  public String handleSelect(ImapSessionContext session, String tag, String args) {
    String mailbox = unquote(args);
    StringBuilder sb = new StringBuilder();
    Long userId = session.getUserId();
    String username = session.getUsername();

    boolean userExists = userService.userExists(userId);
    if (!userExists) {
      return tag + " NO SELECT failed: user not found: " + username + "\r\n";
    }
    Long mailBoxId = mailboxService.queryMailBoxId(userId, mailbox);
    if (mailBoxId == null || mailBoxId < 1) {
      return tag + " NO SELECT failed: mailbox not found: " + mailbox + "\r\n";
    }
    session.setSelectedMailbox(mailbox);
    session.setSelectedMailboxId(mailBoxId);
    session.setState(ImapSessionContext.State.SELECTED);

    Row meta = mailboxService.getMailboxById(userId, mailBoxId);
    if (meta == null) {
      return tag + " NO SELECT failed: mailbox not found: " + mailbox + "\r\n";
    }
    List<Email> all = mailboxService.getActiveMessages(mailBoxId);
    mailboxService.clearRecentFlags(username, mailbox);
    long exists = all.size();
    int recent = 0;
    for (Email e : all) {
      Set<String> flags = e.getFlags();
      if (flags.size() > 0) {
        if (flags.contains("\\Recent")) {
          recent++;
        }
      }

    }

    long uv = meta.getLong("uid_next");
    long un = meta.getLong("uid_validity");
    log.info("exists:{},recent:{},uv{},un:{}", exists, recent, uv, un);
    sb.append("* FLAGS (\\Answered \\Flagged \\Deleted \\Seen \\Draft)").append("\r\n");
    sb.append("* OK [PERMANENTFLAGS (\\Answered \\Flagged \\Deleted \\Seen \\Draft \\*)] Flags permitted.").append("\r\n");
    sb.append("* ").append(exists).append(" EXISTS").append("\r\n");
    sb.append("* ").append(recent).append(" RECENT").append("\r\n");
    sb.append("* OK [UIDVALIDITY ").append(un).append("] UIDs valid.").append("\r\n");
    sb.append("* OK [UIDNEXT ").append(uv).append("] Predicted next UID.").append("\r\n");
    sb.append(tag).append(" OK [READ-WRITE] SELECT completed.").append("\r\n");

    return sb.toString();
  }

  public String handleStore(ImapSessionContext session, String tag, String args, boolean isUid) {
    if (session.getState() != ImapSessionContext.State.SELECTED) {
      return tag + " NO STORE failed: No mailbox selected" + "\r\n";
    }
    String[] p = args.split("\\s+", 3);
    if (p.length < 3) {
      return tag + " BAD Invalid STORE arguments" + "\r\n";
    }
    String set = p[0];
    String op = p[1];
    String flagsStr = p[2].replaceAll("[()]", "");
    boolean add = op.startsWith("+");
    Set<String> flags = new HashSet<>(Arrays.asList(flagsStr.split("\\s+")));

    Long selectedMailboxId = session.getSelectedMailboxId();

    List<Email> toUpd = null;
    if (isUid) {
      toUpd = mailboxService.findEmailsByUidSet(selectedMailboxId, set);
    } else {
      toUpd = mailboxService.findEmailsBySeqSet(selectedMailboxId, set);
    }

    StringBuilder sb = new StringBuilder();
    for (Email e : toUpd) {
      mailboxService.storeFlags(e, flags, add);
      if (!op.contains(".SILENT")) {
        String f = String.join(" ", e.getFlags());
        int seq = toUpd.indexOf(e) + 1;
        sb.append("* ").append(seq).append(" FETCH (FLAGS (" + f + ") UID " + e.getUid() + ")").append("\r\n");
      }
    }
    sb.append(tag).append(" OK STORE completed.").append("\r\n");
    return sb.toString();
  }

  public String handleUid(ImapSessionContext session, String tag, String args) {
    if (session.getState() != ImapSessionContext.State.SELECTED) {
      return tag + " NO UID failed: No mailbox selected" + "\r\n";
    }
    String[] parts = args.split("\\s+", 2);
    String cmd = parts[0].toUpperCase();
    String sub = parts.length > 1 ? parts[1] : "";
    switch (cmd) {
    case "FETCH":
      ImapFetchService imapFetchService = Aop.get(ImapFetchService.class);
      return imapFetchService.handleFetch(session, tag, sub, true);
    case "STORE":
      return handleStore(session, tag, sub, true);
    case "COPY":
      return handleCopy(session, tag, sub, true);
    case "MOVE":
      return handleMove(session, tag, sub, true);
    default:
      return tag + " BAD Unsupported UID command: " + cmd + "\r\n";
    }
  }

  /**
   * UID MOVE <set> "<mailbox>"
   */
  public String handleMove(ImapSessionContext session, String tag, String args, boolean isUid) {
    if (session.getState() != ImapSessionContext.State.SELECTED) {
      return tag + " NO MOVE failed: No mailbox selected\r\n";
    }
    String[] p = args.split("\\s+", 2);
    if (p.length < 2) {
      return tag + " BAD MOVE arguments invalid\r\n";
    }
    String set = p[0];
    String destMailbox = unquote(p[1]);
    Long userId = session.getUserId();
    String srcMailbox = session.getSelectedMailbox();
    try {
      mailboxService.moveEmailsByUidSet(userId, srcMailbox, set, destMailbox);
      return tag + " OK MOVE completed.\r\n";
    } catch (Exception e) {
      return tag + " NO MOVE failed: " + e.getMessage() + "\r\n";
    }
  }

  private String handleCopy(ImapSessionContext session, String tag, String args, boolean b) {
    if (session.getState() != ImapSessionContext.State.SELECTED) {
      return tag + " NO COPY failed: No mailbox selected\r\n";
    }
    // 拆分出消息集和目标 mailbox
    String[] p = args.split("\\s+", 2);
    if (p.length < 2) {
      return tag + " BAD COPY arguments invalid\r\n";
    }
    String set = p[0];
    String destMailbox = unquote(p[1]);
    String user = session.getUsername();
    String srcMailbox = session.getSelectedMailbox();

    try {
      // 调用新加的接口
      mailboxService.copyEmailsByUidSet(user, srcMailbox, set, destMailbox);
      return tag + " OK COPY completed.\r\n";
    } catch (Exception e) {
      return tag + " NO COPY failed: " + e.getMessage() + "\r\n";
    }
  }

  /**
  * CLOSE: 关闭当前 mailbox,并对所有 \Deleted 标记的邮件做 EXPUNGE
  */
  public String handleClose(ImapSessionContext session, String tag) {
    if (session.getState() != ImapSessionContext.State.SELECTED) {
      return tag + " BAD CLOSE failed: No mailbox selected\r\n";
    }

    String user = session.getUsername();
    String box = session.getSelectedMailbox();

    // 1) 找出待 expunge 的 seq nums,发出 untagged EXPUNGE
    List<Integer> seqs = mailboxService.getExpungeSeqNums(user, box);
    StringBuilder sb = new StringBuilder();
    for (int seq : seqs) {
      sb.append("* ").append(seq).append(" EXPUNGE").append("\r\n");
    }

    // 2) 真正逻辑删除
    mailboxService.expunge(user, box);

    // 3) 取消 selected state
    session.setSelectedMailbox(null);
    session.setSelectedMailboxId(null);
    session.setState(ImapSessionContext.State.AUTHENTICATED);

    // 4) 返回 OK
    sb.append(tag).append(" OK CLOSE completed").append("\r\n");
    return sb.toString();
  }

  public String unquote(String s) {
    if (s != null) {
      if (s.startsWith("\"") && s.endsWith("\"")) {
        return s.substring(1, s.length() - 1).toLowerCase();
      } else {
        return s.toLowerCase();
      }

    }
    return s;
  }

}

核心业务逻辑集中在 ImapService,负责所有 IMAP 命令的具体实现,并与数据库交互。主要方法包括:

  • 身份验证:

    • handleCapability、handleId、handleIdle:返回无认证即可执行的命令列表与服务器标识。
    • handleAuthenticate、handleAuthData:支持 AUTHENTICATE LOGIN/PLAIN 多步 Base64 交互。
    • handleLogin:一次性 LOGIN 命令验证。
  • 会话管理:

    • handleLogout:在 SELECT 状态下先执行 EXPUNGE,再关闭会话。
  • 邮箱管理:

    • handleCreate:在数据库中新建目录。
    • handleList / handleSubscribe:列出目录并应答 SUBSCRIBE。
  • 邮箱操作:

    • handleSelect:选中邮箱后,返回 FLAGS、EXISTS、RECENT、UIDVALIDITY、UIDNEXT 等元信息。
    • handleClose:关闭当前选中邮箱并对 \Deleted 标记邮件执行 EXPUNGE。
  • 消息访问:

    • handleFetch:支持按序号或 UID 集合获取邮件,返回 UID、RFC822.SIZE、FLAGS,可按需返回全文或头部。
    • handleStore:对邮件设置或清除标记,支持带或不带 .SILENT 的通知。
  • UID 延伸命令:

    • handleUid:对 UID FETCH/STORE/COPY/MOVE 进行分发。
    • handleCopy / handleMove:在数据库层面完成复制或移动操作。
  • EXPUNGE:

    • handleExpunge:列出待 EXPUNGE 的序号,逻辑删除后反馈给客户端。

内部大量调用 mailboxService、userService 等 AOP 注入的业务组件,与数据库完成 CRUD。


7.ImapFetchService

package com.tio.mail.wing.service;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.litongjava.jfinal.aop.Aop;
import com.tio.mail.wing.handler.ImapSessionContext;
import com.tio.mail.wing.model.Email;

public class ImapFetchService {
  private static final String[] EMAIL_HEADER_FIELDS = new String[] { "From", "To", "Cc", "Bcc", "Subject", "Date", "Message-ID", "Priority", "X-Priority", "References", "Newsgroups", "In-Reply-To",
      "Content-Type", "Reply-To" };
  private static final Pattern BODY_FETCH_PATTERN = Pattern.compile("BODY(?:\\.PEEK)?\\[(.*?)\\]", Pattern.CASE_INSENSITIVE);
  private static final Pattern UID_FETCH_PATTERN = Pattern.compile("([\\d\\*:,\\-]+)\\s+\\((.*)\\)", Pattern.CASE_INSENSITIVE);

  private final MailboxService mailboxService = Aop.get(MailboxService.class);
  
  public String handleFetch(ImapSessionContext session, String tag, String args, boolean isUid) {
    if (session.getState() != ImapSessionContext.State.SELECTED) {
      return tag + " NO FETCH failed: No mailbox selected\r\n";
    }
    Matcher m = UID_FETCH_PATTERN.matcher(args);
    if (!m.find()) {
      return tag + " BAD Invalid FETCH arguments: " + args + "\r\n";
    }

    String user = session.getUsername();
    String box = session.getSelectedMailbox();
    String set = m.group(1);
    String items = m.group(2).toUpperCase();

    List<Email> toFetch = null;
    if (isUid) {
      toFetch = mailboxService.findEmailsByUidSet(user, box, set);
    } else {
      toFetch = mailboxService.findEmailsBySeqSet(user, box, set);
    }

    StringBuilder sb = new StringBuilder();
    if (toFetch == null || toFetch.isEmpty()) {
      sb.append(tag).append(" OK FETCH completed.\r\n");
      return sb.toString();
    }

    if (items.equalsIgnoreCase("FLAGS")) {
      //UID fetch 1:* (FLAGS)
      sb = fetchFlags(user, box, items, isUid, toFetch);

    } else if (items.contains("BODY.PEEK[]")) {
      //UID fetch 4 (UID RFC822.SIZE BODY[])
      sb = fetchBodyPeek(user, box, items, isUid, toFetch);

    } else if (items.contains("BODY[]")) {
      sb = fetchBody(user, box, items, isUid, toFetch);
    } else {
      Matcher b = BODY_FETCH_PATTERN.matcher(items);
      if (b.find()) {
        //UID fetch 1:6 (UID RFC822.SIZE FLAGS BODY.PEEK[HEADER.FIELDS (From To Cc Bcc Subject Date Message-ID Priority X-Priority References Newsgroups In-Reply-To Content-Type Reply-To)])
        String partToken = b.group(0);
        partToken = partToken.replace("BODY.PEEK", "BODY");
        sb = fetchHeader(user, box, items, isUid, partToken, toFetch);
      }
    }

    sb.append(tag).append(" OK FETCH completed.\r\n");
    return sb.toString();
  }

  private StringBuilder fetchFlags(String user, String box, String items, boolean isUid, List<Email> toFetch) {

    StringBuilder sb = new StringBuilder();

    for (int i = 0; i < toFetch.size(); i++) {
      int seq = i + 1;
      Email e = toFetch.get(i);

      List<String> parts = new ArrayList<>();
      parts.add("UID " + e.getUid());
      
      Set<String> flags = e.getFlags();
      if (flags != null) {
        parts.add("FLAGS (" + String.join(" ", flags) + ")");
      } else {
        parts.add("FLAGS ()");
      }

      String prefix = "* " + seq + " FETCH (" + String.join(" ", parts) + ")\r\n";
      sb.append(prefix);
    }
    return sb;
  }

  private StringBuilder fetchHeader(String user, String box, String items, boolean isUid, String partToken, List<Email> toFetch) {
    StringBuilder sb = new StringBuilder();

    for (int i = 0; i < toFetch.size(); i++) {
      int seq = i + 1;

      Email e = toFetch.get(i);
      // 先把整封 raw byte[] 读出来,用于大小计算
      String rawContent = e.getRawContent();
      byte[] raw = rawContent.getBytes(StandardCharsets.UTF_8);
      int fullSize = raw.length;

      String prefix = prefixLine(seq, isUid, items, fullSize, e);

      String hdr = parseHeaderFields(rawContent, EMAIL_HEADER_FIELDS);
      byte[] hdrBytes = hdr.getBytes(StandardCharsets.UTF_8);
      sb.append(prefix).append(" ").append(partToken);
      sb.append(" {").append(hdrBytes.length).append("}\r\n");
      sb.append(hdr);
      sb.append(hdr).append("\r\n)\r\n");
    }
    return sb;
  }

  private StringBuilder fetchBody(String user, String box, String items, boolean isUid, List<Email> toFetch) {
    StringBuilder sb = new StringBuilder();

    for (int i = 0; i < toFetch.size(); i++) {
      int seq = i + 1;

      Email e = toFetch.get(i);
      // 先把整封 raw byte[] 读出来,用于大小计算
      String rawContent = e.getRawContent();
      byte[] raw = rawContent.getBytes(StandardCharsets.UTF_8);
      int fullSize = raw.length;

      String prefix = prefixLine(seq, isUid, items, fullSize, e);

      mailboxService.storeFlags(e, Collections.singleton("\\Seen"), true);
      sb.append(prefix);
      sb.append(" BODY[] {").append(fullSize).append("}\r\n");
      sb.append(rawContent);
      sb.append("\r\n)\r\n");

    }
    return sb;
  }

  private StringBuilder fetchBodyPeek(String user, String box, String items, boolean isUid, List<Email> toFetch) {
    StringBuilder sb = new StringBuilder();

    for (int i = 0; i < toFetch.size(); i++) {
      int seq = i + 1;

      Email e = toFetch.get(i);
      // 先把整封 raw byte[] 读出来,用于大小计算
      String rawContent = e.getRawContent();
      byte[] raw = rawContent.getBytes(StandardCharsets.UTF_8);
      int fullSize = raw.length;

      String prefix = prefixLine(seq, isUid, items, fullSize, e);

      sb.append(prefix);
      sb.append(" BODY[] {").append(fullSize).append("}\r\n");
      sb.append(rawContent);
      sb.append("\r\n)\r\n");
    }
    return sb;
  }

  //* 1 FETCH (UID 1 RFC822.SIZE 262 FLAGS (\Seen) BODY[HEADER.FIELDS (FROM TO CC BCC SUBJECT DATE MESSAGE-ID PRIORITY X-PRIORITY REFERENCES NEWSGROUPS IN-REPLY-TO CONTENT-TYPE REPLY-TO)] {211}
  private String prefixLine(int seq, boolean isUid, String items, int fullSize, Email email) {
    // 按 固定顺序 UID → RFC822.SIZE → FLAGS 构造 parts 列表
    List<String> parts = new ArrayList<>();
    if (isUid || items.contains("UID")) {
      parts.add("UID " + email.getUid());
    }
    if (items.contains("RFC822.SIZE")) {
      parts.add("RFC822.SIZE " + fullSize);
    }
    if (items.contains("FLAGS")) {
      Set<String> flags = email.getFlags();
      if (flags != null) {
        parts.add("FLAGS (" + String.join(" ", flags) + ")");
      } else {
        parts.add("FLAGS ()");
      }
    }

    String prefix = "* " + seq + " FETCH (" + String.join(" ", parts);
    return prefix;
  }


  public String parseHeaderFields(String content, String[] fields) {
    Map<String, String> hdr = new HashMap<>();
    for (String line : content.split("\\r?\\n")) {
      if (line.isEmpty()) {
        break;
      }

      int i = line.indexOf(":");
      if (i > 0) {
        hdr.put(line.substring(0, i).toUpperCase(), line.substring(i + 1).trim());
      }
    }

    StringBuilder sb = new StringBuilder();
    for (String f : fields) {
      String v = hdr.get(f.toUpperCase());
      if (v != null) {
        sb.append(f).append(": ").append(v).append("\r\n");
      }

    }
    return sb.toString();
  }
}

--

小结

本方案通过 T-IO 框架实现 IMAP 协议的基础交互,结合 ActiveRecord 与自定义业务服务,实现了从连接、认证、目录管理、消息读写到标记与删除的全流程 IMAP 支持。各组件职责分离,后续可按需扩展更多 IMAP 扩展命令和性能优化。

Edit this page
Last Updated:
Contributors: Tong Li
Prev
IMAP 协议
Next
IMAP实现讲解