Elasticsearch IMAP 导入器指南

项目介绍

本项目名为“Elasticsearch IMAP”，是一个用于将电子邮件从IMAP服务器导入Elasticsearch的工具。它不再依赖于已被弃用的River插件架构。通过这个工具，你可以定期扫描IMAP文件夹（默认为INBOX），并将读取的消息移动到垃圾箱。项目支持增量索引、附件处理、UTF-7编码邮件解析，并且兼容SSL/TLS及SASL认证。对于IMAP协议，用户还可以指定要索引的文件夹模式并遍历子文件夹。

版本: v3.2.1
发布日期: 2023-10-03
支持: ECS兼容性模式下的明智默认配置。

项目快速启动

快速启动此项目，首先确保你已经安装了适当的Java环境，Elasticsearch以及Logstash，因为通常IMAP导入功能是通过Logstash来实现的。以下是基本步骤：

1. 克隆项目:

   git clone https://github.com/salyh/elasticsearch-imap.git
   

2. 配置Logstash: 在Logstash的配置目录下创建一个新的配置文件，例如imap_input.conf，并填入以下示例配置：

   input {
     imap {
       host => "your.imap.server"
       user => "username"
       password => "password"
       port => 993 # 默认SSL端口
       folder => "INBOX" # 可以更改为其他文件夹
       ssl => true
     }
   }
   
   output {
     elasticsearch {
       hosts => ["localhost:9200"]
       index => "emails-%{+YYYY.MM.dd}" # 索引命名规则
     }
   }
   

3. 运行Logstash:

   bin/logstash -f path/to/imap_input.conf
   

请注意，实际使用时你需要替换相应的IMAP服务器地址、用户名、密码等信息。

应用案例和最佳实践

电子邮件归档系统

• 在企业中建立一个长期邮件存档解决方案。
• 利用Elasticsearch强大的搜索能力，轻松检索历史邮件。
• 结合ECS（Elastic Common Schema）规范，保证数据结构的一致性和可分析性。

监控通知和自动化处理

• 自动索引监控系统发送的重要电子邮件，如错误报告或状态更新。
• 实现基于邮件内容的自动响应或者工单创建。

安全日志和合规性

• 将含有重要业务交易的邮件自动导入，作为审计和法规遵循的一部分。

典型生态项目结合

• Elasticsearch: 作为核心搜索引擎，存储并提供高效查询邮件的能力。
• Kibana: 用于可视化邮件元数据，比如发件人、收件人、时间分布等。
• Beats: 如Filebeat，可以作为另一种方式收集保存在本地邮件服务器上的.eml文件。
• Logstash: 处理邮件流，包括解析、过滤和转发至Elasticsearch。
• Elastic Common Schema (ECS): 提供统一的数据模型，便于分析和跨域比较。

记得在生产环境中实施这些实践前进行充分测试，确保所有组件间的兼容性和安全性。