ErisPulse 2.1.11__tar.gz → 2.1.13rc1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. {erispulse-2.1.11 → erispulse-2.1.13rc1}/PKG-INFO +1 -1
  2. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AIDocs/ErisPulse-AdapterDev.md +20 -20
  3. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AIDocs/ErisPulse-Core.md +137 -16
  4. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AIDocs/ErisPulse-Full.md +141 -20
  5. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AIDocs/ErisPulse-ModuleDev.md +141 -20
  6. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/CHANGELOG.md +30 -0
  7. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/PlatformFeatures.md +121 -0
  8. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/adapter.md +2 -2
  9. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/config.md +2 -2
  10. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/env.md +2 -2
  11. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/logger.md +2 -2
  12. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/mods.md +2 -2
  13. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/raiserr.md +2 -2
  14. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/server.md +2 -2
  15. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/Core/util.md +2 -2
  16. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/__init__.md +2 -2
  17. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/ErisPulse/__main__.md +2 -2
  18. {erispulse-2.1.11 → erispulse-2.1.13rc1}/pyproject.toml +1 -1
  19. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/logger.py +1 -1
  20. erispulse-2.1.13rc1/src/ErisPulse/__main__.py +933 -0
  21. erispulse-2.1.11/src/ErisPulse/__main__.py +0 -677
  22. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.github/assets/erispulse_logo.png +0 -0
  23. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.github/tools/merge_md.py +0 -0
  24. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.github/tools/update-api-docs.py +0 -0
  25. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.github/workflows/auto-tag-release.yml +0 -0
  26. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.github/workflows/pypi-publish.yml +0 -0
  27. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.gitignore +0 -0
  28. {erispulse-2.1.11 → erispulse-2.1.13rc1}/.python-version +0 -0
  29. {erispulse-2.1.11 → erispulse-2.1.13rc1}/CODE_OF_CONDUCT.md +0 -0
  30. {erispulse-2.1.11 → erispulse-2.1.13rc1}/LICENSE +0 -0
  31. {erispulse-2.1.11 → erispulse-2.1.13rc1}/README.md +0 -0
  32. {erispulse-2.1.11 → erispulse-2.1.13rc1}/devs/test.py +0 -0
  33. {erispulse-2.1.11 → erispulse-2.1.13rc1}/devs/test_adapter.py +0 -0
  34. {erispulse-2.1.11 → erispulse-2.1.13rc1}/devs/test_files/test.docx +0 -0
  35. {erispulse-2.1.11 → erispulse-2.1.13rc1}/devs/test_files/test.jpg +0 -0
  36. {erispulse-2.1.11 → erispulse-2.1.13rc1}/devs/test_files/test.mp4 +0 -0
  37. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AIDocs/README.md +0 -0
  38. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AIModuleGeneration.md +0 -0
  39. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AdapterStandards/APIResponse.md +0 -0
  40. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AdapterStandards/EventConversion.md +0 -0
  41. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/AdapterStandards/README.md +0 -0
  42. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/CHANGELOG_1.x.md +0 -0
  43. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/CLI.md +0 -0
  44. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/Development/Adapter.md +0 -0
  45. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/Development/CLI.md +0 -0
  46. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/Development/Module.md +0 -0
  47. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/Development/README.md +0 -0
  48. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/UseCore.md +0 -0
  49. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/api/README.md +0 -0
  50. {erispulse-2.1.11 → erispulse-2.1.13rc1}/docs/quick-start.md +0 -0
  51. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-adapter/LICENSE +0 -0
  52. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-adapter/MyAdapter/Core.py +0 -0
  53. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-adapter/MyAdapter/__init__.py +0 -0
  54. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-adapter/README.md +0 -0
  55. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-adapter/pyproject.toml +0 -0
  56. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-cli-module/LICENSE +0 -0
  57. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-cli-module/README.md +0 -0
  58. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-cli-module/my_cli_module/__init__.py +0 -0
  59. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-cli-module/my_cli_module/cli.py +0 -0
  60. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-cli-module/pyproject.toml +0 -0
  61. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-module/LICENSE +0 -0
  62. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-module/MyModule/Core.py +0 -0
  63. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-module/MyModule/__init__.py +0 -0
  64. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-module/README.md +0 -0
  65. {erispulse-2.1.11 → erispulse-2.1.13rc1}/examples/example-module/pyproject.toml +0 -0
  66. {erispulse-2.1.11 → erispulse-2.1.13rc1}/scripts/install/install.ps1 +0 -0
  67. {erispulse-2.1.11 → erispulse-2.1.13rc1}/scripts/install/install.sh +0 -0
  68. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/__init__.py +0 -0
  69. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/adapter.py +0 -0
  70. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/config.py +0 -0
  71. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/env.py +0 -0
  72. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/mods.py +0 -0
  73. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/raiserr.py +0 -0
  74. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/server.py +0 -0
  75. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/Core/util.py +0 -0
  76. {erispulse-2.1.11 → erispulse-2.1.13rc1}/src/ErisPulse/__init__.py +0 -0
  77. {erispulse-2.1.11 → erispulse-2.1.13rc1}/style_guide/DOCSTRING_SPEC.md +0 -0
  78. {erispulse-2.1.11 → erispulse-2.1.13rc1}/style_guide/README.md +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ErisPulse
3
- Version: 2.1.11
3
+ Version: 2.1.13rc1
4
4
  Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架,主要用于构建高效、可维护的机器人应用程序。
5
5
  Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>, runoneall <runoobsteve@gmail.com>
6
6
  License: MIT License
@@ -919,7 +919,7 @@ def generate_message_id(platform: str, raw_id: str) -> str:
919
919
 
920
920
  # 📦 `ErisPulse.__init__` 模块
921
921
 
922
- *自动生成于 2025-07-21 03:51:24*
922
+ *自动生成于 2025-07-21 17:57:00*
923
923
 
924
924
  ---
925
925
 
@@ -1250,13 +1250,13 @@ SDK初始化入口
1250
1250
  ---
1251
1251
 
1252
1252
 
1253
- *文档最后更新于 2025-07-21 03:51:24*
1253
+ *文档最后更新于 2025-07-21 17:57:00*
1254
1254
 
1255
1255
  ## ErisPulse\__main__.md
1256
1256
 
1257
1257
  # 📦 `ErisPulse.__main__` 模块
1258
1258
 
1259
- *自动生成于 2025-07-21 03:51:24*
1259
+ *自动生成于 2025-07-21 17:57:00*
1260
1260
 
1261
1261
  ---
1262
1262
 
@@ -1386,13 +1386,13 @@ PyPI包管理器
1386
1386
  ---
1387
1387
 
1388
1388
 
1389
- *文档最后更新于 2025-07-21 03:51:24*
1389
+ *文档最后更新于 2025-07-21 17:57:00*
1390
1390
 
1391
1391
  ## ErisPulse\Core\adapter.md
1392
1392
 
1393
1393
  # 📦 `ErisPulse.Core.adapter` 模块
1394
1394
 
1395
- *自动生成于 2025-07-21 03:51:24*
1395
+ *自动生成于 2025-07-21 17:57:00*
1396
1396
 
1397
1397
  ---
1398
1398
 
@@ -1737,13 +1737,13 @@ OneBot12协议事件监听装饰器
1737
1737
  ---
1738
1738
 
1739
1739
 
1740
- *文档最后更新于 2025-07-21 03:51:24*
1740
+ *文档最后更新于 2025-07-21 17:57:00*
1741
1741
 
1742
1742
  ## ErisPulse\Core\config.md
1743
1743
 
1744
1744
  # 📦 `ErisPulse.Core.config` 模块
1745
1745
 
1746
- *自动生成于 2025-07-21 03:51:24*
1746
+ *自动生成于 2025-07-21 17:57:00*
1747
1747
 
1748
1748
  ---
1749
1749
 
@@ -1801,13 +1801,13 @@ ErisPulse 配置中心
1801
1801
  ---
1802
1802
 
1803
1803
 
1804
- *文档最后更新于 2025-07-21 03:51:24*
1804
+ *文档最后更新于 2025-07-21 17:57:00*
1805
1805
 
1806
1806
  ## ErisPulse\Core\env.md
1807
1807
 
1808
1808
  # 📦 `ErisPulse.Core.env` 模块
1809
1809
 
1810
- *自动生成于 2025-07-21 03:51:24*
1810
+ *自动生成于 2025-07-21 17:57:00*
1811
1811
 
1812
1812
  ---
1813
1813
 
@@ -2093,13 +2093,13 @@ ErisPulse 环境配置模块
2093
2093
  ---
2094
2094
 
2095
2095
 
2096
- *文档最后更新于 2025-07-21 03:51:24*
2096
+ *文档最后更新于 2025-07-21 17:57:00*
2097
2097
 
2098
2098
  ## ErisPulse\Core\logger.md
2099
2099
 
2100
2100
  # 📦 `ErisPulse.Core.logger` 模块
2101
2101
 
2102
- *自动生成于 2025-07-21 03:51:24*
2102
+ *自动生成于 2025-07-21 17:57:00*
2103
2103
 
2104
2104
  ---
2105
2105
 
@@ -2190,13 +2190,13 @@ ErisPulse 日志系统
2190
2190
  ---
2191
2191
 
2192
2192
 
2193
- *文档最后更新于 2025-07-21 03:51:24*
2193
+ *文档最后更新于 2025-07-21 17:57:00*
2194
2194
 
2195
2195
  ## ErisPulse\Core\mods.md
2196
2196
 
2197
2197
  # 📦 `ErisPulse.Core.mods` 模块
2198
2198
 
2199
- *自动生成于 2025-07-21 03:51:24*
2199
+ *自动生成于 2025-07-21 17:57:00*
2200
2200
 
2201
2201
  ---
2202
2202
 
@@ -2378,13 +2378,13 @@ ErisPulse 模块管理器
2378
2378
  ---
2379
2379
 
2380
2380
 
2381
- *文档最后更新于 2025-07-21 03:51:24*
2381
+ *文档最后更新于 2025-07-21 17:57:00*
2382
2382
 
2383
2383
  ## ErisPulse\Core\raiserr.md
2384
2384
 
2385
2385
  # 📦 `ErisPulse.Core.raiserr` 模块
2386
2386
 
2387
- *自动生成于 2025-07-21 03:51:24*
2387
+ *自动生成于 2025-07-21 17:57:00*
2388
2388
 
2389
2389
  ---
2390
2390
 
@@ -2477,13 +2477,13 @@ ErisPulse 错误管理系统
2477
2477
  ---
2478
2478
 
2479
2479
 
2480
- *文档最后更新于 2025-07-21 03:51:24*
2480
+ *文档最后更新于 2025-07-21 17:57:00*
2481
2481
 
2482
2482
  ## ErisPulse\Core\server.md
2483
2483
 
2484
2484
  # 📦 `ErisPulse.Core.server` 模块
2485
2485
 
2486
- *自动生成于 2025-07-21 03:51:24*
2486
+ *自动生成于 2025-07-21 17:57:00*
2487
2487
 
2488
2488
  ---
2489
2489
 
@@ -2604,13 +2604,13 @@ ErisPulse Adapter Server
2604
2604
  ---
2605
2605
 
2606
2606
 
2607
- *文档最后更新于 2025-07-21 03:51:24*
2607
+ *文档最后更新于 2025-07-21 17:57:00*
2608
2608
 
2609
2609
  ## ErisPulse\Core\util.md
2610
2610
 
2611
2611
  # 📦 `ErisPulse.Core.util` 模块
2612
2612
 
2613
- *自动生成于 2025-07-21 03:51:24*
2613
+ *自动生成于 2025-07-21 17:57:00*
2614
2614
 
2615
2615
  ---
2616
2616
 
@@ -2704,6 +2704,6 @@ ErisPulse 工具函数集合
2704
2704
  ---
2705
2705
 
2706
2706
 
2707
- *文档最后更新于 2025-07-21 03:51:24*
2707
+ *文档最后更新于 2025-07-21 17:57:00*
2708
2708
 
2709
2709
  <!--- End of API文档 -->
@@ -657,6 +657,127 @@ OneBot11事件转换到OneBot12协议,其中标准字段完全遵守OneBot12
657
657
 
658
658
  ---
659
659
 
660
+ ### 4. MailAdapter
661
+ MailAdapter 是基于SMTP/IMAP协议的邮件适配器,支持邮件发送、接收和处理。
662
+
663
+ #### 支持的消息发送类型
664
+ 所有发送方法均通过链式语法实现,例如:
665
+ ```python
666
+ from ErisPulse.Core import adapter
667
+ mail = adapter.get("email")
668
+
669
+ # 简单文本邮件
670
+ await mail.Send.Using("from@example.com").To("to@example.com").Subject("测试").Text("内容")
671
+
672
+ # 带附件的HTML邮件
673
+ await mail.Send.Using("from@example.com") \
674
+ .To("to@example.com") \
675
+ .Subject("HTML邮件") \
676
+ .Cc(["cc1@example.com", "cc2@example.com"]) \
677
+ .Attachment("report.pdf") \
678
+ .Html("<h1>HTML内容</h1>")
679
+
680
+ # 注意:使用链式语法时,参数方法必须在发送方法(Text,Html)之前设置
681
+ ```
682
+
683
+ 支持的发送类型包括:
684
+ - `.Text(text: str)`:发送纯文本邮件
685
+ - `.Html(html: str)`:发送HTML格式邮件
686
+ - `.Attachment(file: str, filename: str = None)`:添加附件
687
+ - `.Cc(emails: Union[str, List[str]])`:设置抄送
688
+ - `.Bcc(emails: Union[str, List[str]])`:设置密送
689
+ - `.ReplyTo(email: str)`:设置回复地址
690
+
691
+ #### 特有参数说明
692
+ | 参数 | 类型 | 说明 |
693
+ |------------|--------------------|-----------------------------|
694
+ | Subject | str | 邮件主题 |
695
+ | From | str | 发件人地址(通过Using设置) |
696
+ | To | str | 收件人地址 |
697
+ | Cc | str 或 List[str] | 抄送地址列表 |
698
+ | Bcc | str 或 List[str] | 密送地址列表 |
699
+ | Attachment | str 或 Path | 附件文件路径 |
700
+
701
+ #### 事件格式
702
+ 邮件接收事件格式:
703
+ ```python
704
+ {
705
+ "type": "message",
706
+ "detail_type": "private", # 邮件默认为私聊
707
+ "platform": "email",
708
+ "self": {"platform": "email", "user_id": account_id},
709
+ "message": [
710
+ {
711
+ "type": "text",
712
+ "data": {
713
+ "text": f"Subject: {subject}\nFrom: {from_}\n\n{text_content}"
714
+ }
715
+ }
716
+ ],
717
+ "email_raw": {
718
+ "subject": subject,
719
+ "from": from_,
720
+ "to": to,
721
+ "date": date,
722
+ "text_content": text_content,
723
+ "html_content": html_content,
724
+ "attachments": [att["filename"] for att in attachments]
725
+ },
726
+ "attachments": [ # 附件数据列表
727
+ {
728
+ "filename": "document.pdf",
729
+ "content_type": "application/pdf",
730
+ "size": 1024,
731
+ "data": b"..." # 附件二进制数据
732
+ }
733
+ ]
734
+ }
735
+ ```
736
+
737
+ #### OneBot12协议转换说明
738
+ 邮件事件转换到OneBot12协议,主要差异点:
739
+
740
+ 1. 特有字段:
741
+ - `email_raw`: 包含原始邮件数据
742
+ - `attachments`: 附件数据列表
743
+
744
+ 2. 特殊处理:
745
+ - 邮件主题和发件人信息会包含在消息文本中
746
+ - 附件数据会以二进制形式提供
747
+ - HTML内容会保留在email_raw字段中
748
+
749
+ 3. 示例:
750
+ ```python
751
+ {
752
+ "type": "message",
753
+ "platform": "email",
754
+ "message": [
755
+ {
756
+ "type": "text",
757
+ "data": {
758
+ "text": "Subject: 会议通知\nFrom: sender@example.com\n\n请查收附件"
759
+ }
760
+ }
761
+ ],
762
+ "email_raw": {
763
+ "subject": "会议通知",
764
+ "from": "sender@example.com",
765
+ "to": "receiver@example.com",
766
+ "html_content": "<p>请查收附件</p>",
767
+ "attachments": ["document.pdf"]
768
+ },
769
+ "attachments": [
770
+ {
771
+ "filename": "document.pdf",
772
+ "data": b"...", # 附件二进制数据
773
+ "size": 1024
774
+ }
775
+ ]
776
+ }
777
+ ```
778
+
779
+ ---
780
+
660
781
  ## 参考链接
661
782
  ErisPulse 项目:
662
783
  - [主库](https://github.com/ErisPulse/ErisPulse/)
@@ -690,7 +811,7 @@ ErisPulse 项目:
690
811
 
691
812
  # 📦 `ErisPulse.Core.adapter` 模块
692
813
 
693
- *自动生成于 2025-07-21 03:51:24*
814
+ *自动生成于 2025-07-21 17:57:00*
694
815
 
695
816
  ---
696
817
 
@@ -1035,13 +1156,13 @@ OneBot12协议事件监听装饰器
1035
1156
  ---
1036
1157
 
1037
1158
 
1038
- *文档最后更新于 2025-07-21 03:51:24*
1159
+ *文档最后更新于 2025-07-21 17:57:00*
1039
1160
 
1040
1161
  ## config.md
1041
1162
 
1042
1163
  # 📦 `ErisPulse.Core.config` 模块
1043
1164
 
1044
- *自动生成于 2025-07-21 03:51:24*
1165
+ *自动生成于 2025-07-21 17:57:00*
1045
1166
 
1046
1167
  ---
1047
1168
 
@@ -1099,13 +1220,13 @@ ErisPulse 配置中心
1099
1220
  ---
1100
1221
 
1101
1222
 
1102
- *文档最后更新于 2025-07-21 03:51:24*
1223
+ *文档最后更新于 2025-07-21 17:57:00*
1103
1224
 
1104
1225
  ## env.md
1105
1226
 
1106
1227
  # 📦 `ErisPulse.Core.env` 模块
1107
1228
 
1108
- *自动生成于 2025-07-21 03:51:24*
1229
+ *自动生成于 2025-07-21 17:57:00*
1109
1230
 
1110
1231
  ---
1111
1232
 
@@ -1391,13 +1512,13 @@ ErisPulse 环境配置模块
1391
1512
  ---
1392
1513
 
1393
1514
 
1394
- *文档最后更新于 2025-07-21 03:51:24*
1515
+ *文档最后更新于 2025-07-21 17:57:00*
1395
1516
 
1396
1517
  ## logger.md
1397
1518
 
1398
1519
  # 📦 `ErisPulse.Core.logger` 模块
1399
1520
 
1400
- *自动生成于 2025-07-21 03:51:24*
1521
+ *自动生成于 2025-07-21 17:57:00*
1401
1522
 
1402
1523
  ---
1403
1524
 
@@ -1488,13 +1609,13 @@ ErisPulse 日志系统
1488
1609
  ---
1489
1610
 
1490
1611
 
1491
- *文档最后更新于 2025-07-21 03:51:24*
1612
+ *文档最后更新于 2025-07-21 17:57:00*
1492
1613
 
1493
1614
  ## mods.md
1494
1615
 
1495
1616
  # 📦 `ErisPulse.Core.mods` 模块
1496
1617
 
1497
- *自动生成于 2025-07-21 03:51:24*
1618
+ *自动生成于 2025-07-21 17:57:00*
1498
1619
 
1499
1620
  ---
1500
1621
 
@@ -1676,13 +1797,13 @@ ErisPulse 模块管理器
1676
1797
  ---
1677
1798
 
1678
1799
 
1679
- *文档最后更新于 2025-07-21 03:51:24*
1800
+ *文档最后更新于 2025-07-21 17:57:00*
1680
1801
 
1681
1802
  ## raiserr.md
1682
1803
 
1683
1804
  # 📦 `ErisPulse.Core.raiserr` 模块
1684
1805
 
1685
- *自动生成于 2025-07-21 03:51:24*
1806
+ *自动生成于 2025-07-21 17:57:00*
1686
1807
 
1687
1808
  ---
1688
1809
 
@@ -1775,13 +1896,13 @@ ErisPulse 错误管理系统
1775
1896
  ---
1776
1897
 
1777
1898
 
1778
- *文档最后更新于 2025-07-21 03:51:24*
1899
+ *文档最后更新于 2025-07-21 17:57:00*
1779
1900
 
1780
1901
  ## server.md
1781
1902
 
1782
1903
  # 📦 `ErisPulse.Core.server` 模块
1783
1904
 
1784
- *自动生成于 2025-07-21 03:51:24*
1905
+ *自动生成于 2025-07-21 17:57:00*
1785
1906
 
1786
1907
  ---
1787
1908
 
@@ -1902,13 +2023,13 @@ ErisPulse Adapter Server
1902
2023
  ---
1903
2024
 
1904
2025
 
1905
- *文档最后更新于 2025-07-21 03:51:24*
2026
+ *文档最后更新于 2025-07-21 17:57:00*
1906
2027
 
1907
2028
  ## util.md
1908
2029
 
1909
2030
  # 📦 `ErisPulse.Core.util` 模块
1910
2031
 
1911
- *自动生成于 2025-07-21 03:51:24*
2032
+ *自动生成于 2025-07-21 17:57:00*
1912
2033
 
1913
2034
  ---
1914
2035
 
@@ -2002,6 +2123,6 @@ ErisPulse 工具函数集合
2002
2123
  ---
2003
2124
 
2004
2125
 
2005
- *文档最后更新于 2025-07-21 03:51:24*
2126
+ *文档最后更新于 2025-07-21 17:57:00*
2006
2127
 
2007
2128
  <!--- End of API文档 -->
@@ -661,6 +661,127 @@ OneBot11事件转换到OneBot12协议,其中标准字段完全遵守OneBot12
661
661
 
662
662
  ---
663
663
 
664
+ ### 4. MailAdapter
665
+ MailAdapter 是基于SMTP/IMAP协议的邮件适配器,支持邮件发送、接收和处理。
666
+
667
+ #### 支持的消息发送类型
668
+ 所有发送方法均通过链式语法实现,例如:
669
+ ```python
670
+ from ErisPulse.Core import adapter
671
+ mail = adapter.get("email")
672
+
673
+ # 简单文本邮件
674
+ await mail.Send.Using("from@example.com").To("to@example.com").Subject("测试").Text("内容")
675
+
676
+ # 带附件的HTML邮件
677
+ await mail.Send.Using("from@example.com") \
678
+ .To("to@example.com") \
679
+ .Subject("HTML邮件") \
680
+ .Cc(["cc1@example.com", "cc2@example.com"]) \
681
+ .Attachment("report.pdf") \
682
+ .Html("<h1>HTML内容</h1>")
683
+
684
+ # 注意:使用链式语法时,参数方法必须在发送方法(Text,Html)之前设置
685
+ ```
686
+
687
+ 支持的发送类型包括:
688
+ - `.Text(text: str)`:发送纯文本邮件
689
+ - `.Html(html: str)`:发送HTML格式邮件
690
+ - `.Attachment(file: str, filename: str = None)`:添加附件
691
+ - `.Cc(emails: Union[str, List[str]])`:设置抄送
692
+ - `.Bcc(emails: Union[str, List[str]])`:设置密送
693
+ - `.ReplyTo(email: str)`:设置回复地址
694
+
695
+ #### 特有参数说明
696
+ | 参数 | 类型 | 说明 |
697
+ |------------|--------------------|-----------------------------|
698
+ | Subject | str | 邮件主题 |
699
+ | From | str | 发件人地址(通过Using设置) |
700
+ | To | str | 收件人地址 |
701
+ | Cc | str 或 List[str] | 抄送地址列表 |
702
+ | Bcc | str 或 List[str] | 密送地址列表 |
703
+ | Attachment | str 或 Path | 附件文件路径 |
704
+
705
+ #### 事件格式
706
+ 邮件接收事件格式:
707
+ ```python
708
+ {
709
+ "type": "message",
710
+ "detail_type": "private", # 邮件默认为私聊
711
+ "platform": "email",
712
+ "self": {"platform": "email", "user_id": account_id},
713
+ "message": [
714
+ {
715
+ "type": "text",
716
+ "data": {
717
+ "text": f"Subject: {subject}\nFrom: {from_}\n\n{text_content}"
718
+ }
719
+ }
720
+ ],
721
+ "email_raw": {
722
+ "subject": subject,
723
+ "from": from_,
724
+ "to": to,
725
+ "date": date,
726
+ "text_content": text_content,
727
+ "html_content": html_content,
728
+ "attachments": [att["filename"] for att in attachments]
729
+ },
730
+ "attachments": [ # 附件数据列表
731
+ {
732
+ "filename": "document.pdf",
733
+ "content_type": "application/pdf",
734
+ "size": 1024,
735
+ "data": b"..." # 附件二进制数据
736
+ }
737
+ ]
738
+ }
739
+ ```
740
+
741
+ #### OneBot12协议转换说明
742
+ 邮件事件转换到OneBot12协议,主要差异点:
743
+
744
+ 1. 特有字段:
745
+ - `email_raw`: 包含原始邮件数据
746
+ - `attachments`: 附件数据列表
747
+
748
+ 2. 特殊处理:
749
+ - 邮件主题和发件人信息会包含在消息文本中
750
+ - 附件数据会以二进制形式提供
751
+ - HTML内容会保留在email_raw字段中
752
+
753
+ 3. 示例:
754
+ ```python
755
+ {
756
+ "type": "message",
757
+ "platform": "email",
758
+ "message": [
759
+ {
760
+ "type": "text",
761
+ "data": {
762
+ "text": "Subject: 会议通知\nFrom: sender@example.com\n\n请查收附件"
763
+ }
764
+ }
765
+ ],
766
+ "email_raw": {
767
+ "subject": "会议通知",
768
+ "from": "sender@example.com",
769
+ "to": "receiver@example.com",
770
+ "html_content": "<p>请查收附件</p>",
771
+ "attachments": ["document.pdf"]
772
+ },
773
+ "attachments": [
774
+ {
775
+ "filename": "document.pdf",
776
+ "data": b"...", # 附件二进制数据
777
+ "size": 1024
778
+ }
779
+ ]
780
+ }
781
+ ```
782
+
783
+ ---
784
+
664
785
  ## 参考链接
665
786
  ErisPulse 项目:
666
787
  - [主库](https://github.com/ErisPulse/ErisPulse/)
@@ -1599,7 +1720,7 @@ def generate_message_id(platform: str, raw_id: str) -> str:
1599
1720
 
1600
1721
  # 📦 `ErisPulse.__init__` 模块
1601
1722
 
1602
- *自动生成于 2025-07-21 03:51:24*
1723
+ *自动生成于 2025-07-21 17:57:00*
1603
1724
 
1604
1725
  ---
1605
1726
 
@@ -1930,13 +2051,13 @@ SDK初始化入口
1930
2051
  ---
1931
2052
 
1932
2053
 
1933
- *文档最后更新于 2025-07-21 03:51:24*
2054
+ *文档最后更新于 2025-07-21 17:57:00*
1934
2055
 
1935
2056
  ## ErisPulse\__main__.md
1936
2057
 
1937
2058
  # 📦 `ErisPulse.__main__` 模块
1938
2059
 
1939
- *自动生成于 2025-07-21 03:51:24*
2060
+ *自动生成于 2025-07-21 17:57:00*
1940
2061
 
1941
2062
  ---
1942
2063
 
@@ -2066,13 +2187,13 @@ PyPI包管理器
2066
2187
  ---
2067
2188
 
2068
2189
 
2069
- *文档最后更新于 2025-07-21 03:51:24*
2190
+ *文档最后更新于 2025-07-21 17:57:00*
2070
2191
 
2071
2192
  ## ErisPulse\Core\adapter.md
2072
2193
 
2073
2194
  # 📦 `ErisPulse.Core.adapter` 模块
2074
2195
 
2075
- *自动生成于 2025-07-21 03:51:24*
2196
+ *自动生成于 2025-07-21 17:57:00*
2076
2197
 
2077
2198
  ---
2078
2199
 
@@ -2417,13 +2538,13 @@ OneBot12协议事件监听装饰器
2417
2538
  ---
2418
2539
 
2419
2540
 
2420
- *文档最后更新于 2025-07-21 03:51:24*
2541
+ *文档最后更新于 2025-07-21 17:57:00*
2421
2542
 
2422
2543
  ## ErisPulse\Core\config.md
2423
2544
 
2424
2545
  # 📦 `ErisPulse.Core.config` 模块
2425
2546
 
2426
- *自动生成于 2025-07-21 03:51:24*
2547
+ *自动生成于 2025-07-21 17:57:00*
2427
2548
 
2428
2549
  ---
2429
2550
 
@@ -2481,13 +2602,13 @@ ErisPulse 配置中心
2481
2602
  ---
2482
2603
 
2483
2604
 
2484
- *文档最后更新于 2025-07-21 03:51:24*
2605
+ *文档最后更新于 2025-07-21 17:57:00*
2485
2606
 
2486
2607
  ## ErisPulse\Core\env.md
2487
2608
 
2488
2609
  # 📦 `ErisPulse.Core.env` 模块
2489
2610
 
2490
- *自动生成于 2025-07-21 03:51:24*
2611
+ *自动生成于 2025-07-21 17:57:00*
2491
2612
 
2492
2613
  ---
2493
2614
 
@@ -2773,13 +2894,13 @@ ErisPulse 环境配置模块
2773
2894
  ---
2774
2895
 
2775
2896
 
2776
- *文档最后更新于 2025-07-21 03:51:24*
2897
+ *文档最后更新于 2025-07-21 17:57:00*
2777
2898
 
2778
2899
  ## ErisPulse\Core\logger.md
2779
2900
 
2780
2901
  # 📦 `ErisPulse.Core.logger` 模块
2781
2902
 
2782
- *自动生成于 2025-07-21 03:51:24*
2903
+ *自动生成于 2025-07-21 17:57:00*
2783
2904
 
2784
2905
  ---
2785
2906
 
@@ -2870,13 +2991,13 @@ ErisPulse 日志系统
2870
2991
  ---
2871
2992
 
2872
2993
 
2873
- *文档最后更新于 2025-07-21 03:51:24*
2994
+ *文档最后更新于 2025-07-21 17:57:00*
2874
2995
 
2875
2996
  ## ErisPulse\Core\mods.md
2876
2997
 
2877
2998
  # 📦 `ErisPulse.Core.mods` 模块
2878
2999
 
2879
- *自动生成于 2025-07-21 03:51:24*
3000
+ *自动生成于 2025-07-21 17:57:00*
2880
3001
 
2881
3002
  ---
2882
3003
 
@@ -3058,13 +3179,13 @@ ErisPulse 模块管理器
3058
3179
  ---
3059
3180
 
3060
3181
 
3061
- *文档最后更新于 2025-07-21 03:51:24*
3182
+ *文档最后更新于 2025-07-21 17:57:00*
3062
3183
 
3063
3184
  ## ErisPulse\Core\raiserr.md
3064
3185
 
3065
3186
  # 📦 `ErisPulse.Core.raiserr` 模块
3066
3187
 
3067
- *自动生成于 2025-07-21 03:51:24*
3188
+ *自动生成于 2025-07-21 17:57:00*
3068
3189
 
3069
3190
  ---
3070
3191
 
@@ -3157,13 +3278,13 @@ ErisPulse 错误管理系统
3157
3278
  ---
3158
3279
 
3159
3280
 
3160
- *文档最后更新于 2025-07-21 03:51:24*
3281
+ *文档最后更新于 2025-07-21 17:57:00*
3161
3282
 
3162
3283
  ## ErisPulse\Core\server.md
3163
3284
 
3164
3285
  # 📦 `ErisPulse.Core.server` 模块
3165
3286
 
3166
- *自动生成于 2025-07-21 03:51:24*
3287
+ *自动生成于 2025-07-21 17:57:00*
3167
3288
 
3168
3289
  ---
3169
3290
 
@@ -3284,13 +3405,13 @@ ErisPulse Adapter Server
3284
3405
  ---
3285
3406
 
3286
3407
 
3287
- *文档最后更新于 2025-07-21 03:51:24*
3408
+ *文档最后更新于 2025-07-21 17:57:00*
3288
3409
 
3289
3410
  ## ErisPulse\Core\util.md
3290
3411
 
3291
3412
  # 📦 `ErisPulse.Core.util` 模块
3292
3413
 
3293
- *自动生成于 2025-07-21 03:51:24*
3414
+ *自动生成于 2025-07-21 17:57:00*
3294
3415
 
3295
3416
  ---
3296
3417
 
@@ -3384,6 +3505,6 @@ ErisPulse 工具函数集合
3384
3505
  ---
3385
3506
 
3386
3507
 
3387
- *文档最后更新于 2025-07-21 03:51:24*
3508
+ *文档最后更新于 2025-07-21 17:57:00*
3388
3509
 
3389
3510
  <!--- End of API文档 -->