ErisPulse 2.1.10__tar.gz → 2.1.12__tar.gz

{erispulse-2.1.10 → erispulse-2.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.1.10
+Version: 2.1.12
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>, runoneall <runoobsteve@gmail.com>
 License: MIT License

{erispulse-2.1.10 → erispulse-2.1.12}/docs/AIDocs/ErisPulse-AdapterDev.md

@@ -919,7 +919,7 @@ def generate_message_id(platform: str, raw_id: str) -> str:
 
 # 📦 `ErisPulse.__init__` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1250,13 +1250,13 @@ SDK初始化入口
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\__main__.md
 
 # 📦 `ErisPulse.__main__` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1386,13 +1386,13 @@ PyPI包管理器
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\adapter.md
 
 # 📦 `ErisPulse.Core.adapter` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1737,13 +1737,77 @@ OneBot12协议事件监听装饰器
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
+
+## ErisPulse\Core\config.md
+
+# 📦 `ErisPulse.Core.config` 模块
+
+*自动生成于 2025-07-21 17:57:00*
+
+---
+
+## 模块概述
+
+ErisPulse 配置中心
+
+集中管理所有配置项，避免循环导入问题
+提供自动补全缺失配置项的功能
+
+---
+
+## 🛠️ 函数
+
+### `_ensure_config_structure`
+
+确保配置结构完整，补全缺失的配置项
+
+:param config: 当前配置
+:return: 补全后的完整配置
+
+---
+
+### `get_config`
+
+获取当前配置，自动补全缺失的配置项并保存
+
+:return: 完整的配置字典
+
+---
+
+### `update_config`
+
+更新配置，自动补全缺失的配置项
+
+:param new_config: 新的配置字典
+:return: 是否更新成功
+
+---
+
+### `get_server_config`
+
+获取服务器配置，确保结构完整
+
+:return: 服务器配置字典
+
+---
+
+### `get_logger_config`
+
+获取日志配置，确保结构完整
+
+:return: 日志配置字典
+
+---
+
+
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\env.md
 
 # 📦 `ErisPulse.Core.env` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -2029,13 +2093,13 @@ ErisPulse 环境配置模块
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\logger.md
 
 # 📦 `ErisPulse.Core.logger` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -2070,6 +2134,15 @@ ErisPulse 日志系统
 
 #### 🧰 方法
 
+##### `set_memory_limit`
+
+设置日志内存存储上限
+
+:param limit: 日志存储上限
+:return: bool 设置是否成功
+
+---
+
 ##### `set_level`
 
 设置全局日志级别
@@ -2117,13 +2190,13 @@ ErisPulse 日志系统
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\mods.md
 
 # 📦 `ErisPulse.Core.mods` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -2305,13 +2378,13 @@ ErisPulse 模块管理器
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\raiserr.md
 
 # 📦 `ErisPulse.Core.raiserr` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -2404,13 +2477,13 @@ ErisPulse 错误管理系统
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\server.md
 
 # 📦 `ErisPulse.Core.server` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -2531,13 +2604,13 @@ ErisPulse Adapter Server
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## ErisPulse\Core\util.md
 
 # 📦 `ErisPulse.Core.util` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -2631,6 +2704,6 @@ ErisPulse 工具函数集合
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 <!--- End of API文档 -->

{erispulse-2.1.10 → erispulse-2.1.12}/docs/AIDocs/ErisPulse-Core.md

@@ -82,7 +82,7 @@ ep-init
 你可以通过 CLI 安装所需模块：
 
 ```bash
-epsdk install Yunhu OneBot AIChat
+epsdk install Yunhu AIChat
 ```
 
 你也可以手动编写模块逻辑，参考开发者文档进行模块开发。
@@ -657,6 +657,127 @@ OneBot11事件转换到OneBot12协议，其中标准字段完全遵守OneBot12
 
 ---
 
+### 4. MailAdapter
+MailAdapter 是基于SMTP/IMAP协议的邮件适配器，支持邮件发送、接收和处理。
+
+#### 支持的消息发送类型
+所有发送方法均通过链式语法实现，例如：
+```python
+from ErisPulse.Core import adapter
+mail = adapter.get("email")
+
+# 简单文本邮件
+await mail.Send.Using("from@example.com").To("to@example.com").Subject("测试").Text("内容")
+
+# 带附件的HTML邮件
+await mail.Send.Using("from@example.com") \
+    .To("to@example.com") \
+    .Subject("HTML邮件") \
+    .Cc(["cc1@example.com", "cc2@example.com"]) \
+    .Attachment("report.pdf") \
+    .Html("<h1>HTML内容</h1>")
+
+# 注意：使用链式语法时，参数方法必须在发送方法（Text，Html）之前设置
+```
+
+支持的发送类型包括：
+- `.Text(text: str)`：发送纯文本邮件
+- `.Html(html: str)`：发送HTML格式邮件
+- `.Attachment(file: str, filename: str = None)`：添加附件
+- `.Cc(emails: Union[str, List[str]])`：设置抄送
+- `.Bcc(emails: Union[str, List[str]])`：设置密送
+- `.ReplyTo(email: str)`：设置回复地址
+
+#### 特有参数说明
+| 参数       | 类型               | 说明                          |
+|------------|--------------------|-----------------------------|
+| Subject    | str                | 邮件主题                      |
+| From       | str                | 发件人地址(通过Using设置)      |
+| To         | str                | 收件人地址                    |
+| Cc         | str 或 List[str]   | 抄送地址列表                  |
+| Bcc        | str 或 List[str]   | 密送地址列表                  |
+| Attachment | str 或 Path        | 附件文件路径                 |
+
+#### 事件格式
+邮件接收事件格式：
+```python
+{
+  "type": "message",
+  "detail_type": "private",  # 邮件默认为私聊
+  "platform": "email",
+  "self": {"platform": "email", "user_id": account_id},
+  "message": [
+    {
+      "type": "text",
+      "data": {
+        "text": f"Subject: {subject}\nFrom: {from_}\n\n{text_content}"
+      }
+    }
+  ],
+  "email_raw": {
+    "subject": subject,
+    "from": from_,
+    "to": to,
+    "date": date,
+    "text_content": text_content,
+    "html_content": html_content,
+    "attachments": [att["filename"] for att in attachments]
+  },
+  "attachments": [  # 附件数据列表
+    {
+      "filename": "document.pdf",
+      "content_type": "application/pdf",
+      "size": 1024,
+      "data": b"..."  # 附件二进制数据
+    }
+  ]
+}
+```
+
+#### OneBot12协议转换说明
+邮件事件转换到OneBot12协议，主要差异点：
+
+1. 特有字段：
+   - `email_raw`: 包含原始邮件数据
+   - `attachments`: 附件数据列表
+
+2. 特殊处理：
+   - 邮件主题和发件人信息会包含在消息文本中
+   - 附件数据会以二进制形式提供
+   - HTML内容会保留在email_raw字段中
+
+3. 示例：
+```python
+{
+  "type": "message",
+  "platform": "email",
+  "message": [
+    {
+      "type": "text",
+      "data": {
+        "text": "Subject: 会议通知\nFrom: sender@example.com\n\n请查收附件"
+      }
+    }
+  ],
+  "email_raw": {
+    "subject": "会议通知",
+    "from": "sender@example.com",
+    "to": "receiver@example.com",
+    "html_content": "<p>请查收附件</p>",
+    "attachments": ["document.pdf"]
+  },
+  "attachments": [
+    {
+      "filename": "document.pdf",
+      "data": b"...",  # 附件二进制数据
+      "size": 1024
+    }
+  ]
+}
+```
+
+---
+
 ## 参考链接
 ErisPulse 项目：
 - [主库](https://github.com/ErisPulse/ErisPulse/)
@@ -690,7 +811,7 @@ ErisPulse 项目：
 
 # 📦 `ErisPulse.Core.adapter` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1035,13 +1156,77 @@ OneBot12协议事件监听装饰器
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
+
+## config.md
+
+# 📦 `ErisPulse.Core.config` 模块
+
+*自动生成于 2025-07-21 17:57:00*
+
+---
+
+## 模块概述
+
+ErisPulse 配置中心
+
+集中管理所有配置项，避免循环导入问题
+提供自动补全缺失配置项的功能
+
+---
+
+## 🛠️ 函数
+
+### `_ensure_config_structure`
+
+确保配置结构完整，补全缺失的配置项
+
+:param config: 当前配置
+:return: 补全后的完整配置
+
+---
+
+### `get_config`
+
+获取当前配置，自动补全缺失的配置项并保存
+
+:return: 完整的配置字典
+
+---
+
+### `update_config`
+
+更新配置，自动补全缺失的配置项
+
+:param new_config: 新的配置字典
+:return: 是否更新成功
+
+---
+
+### `get_server_config`
+
+获取服务器配置，确保结构完整
+
+:return: 服务器配置字典
+
+---
+
+### `get_logger_config`
+
+获取日志配置，确保结构完整
+
+:return: 日志配置字典
+
+---
+
+
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## env.md
 
 # 📦 `ErisPulse.Core.env` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1327,13 +1512,13 @@ ErisPulse 环境配置模块
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## logger.md
 
 # 📦 `ErisPulse.Core.logger` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1368,6 +1553,15 @@ ErisPulse 日志系统
 
 #### 🧰 方法
 
+##### `set_memory_limit`
+
+设置日志内存存储上限
+
+:param limit: 日志存储上限
+:return: bool 设置是否成功
+
+---
+
 ##### `set_level`
 
 设置全局日志级别
@@ -1415,13 +1609,13 @@ ErisPulse 日志系统
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## mods.md
 
 # 📦 `ErisPulse.Core.mods` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1603,13 +1797,13 @@ ErisPulse 模块管理器
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## raiserr.md
 
 # 📦 `ErisPulse.Core.raiserr` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1702,13 +1896,13 @@ ErisPulse 错误管理系统
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## server.md
 
 # 📦 `ErisPulse.Core.server` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1829,13 +2023,13 @@ ErisPulse Adapter Server
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 ## util.md
 
 # 📦 `ErisPulse.Core.util` 模块
 
-*自动生成于 2025-07-19 19:31:39*
+*自动生成于 2025-07-21 17:57:00*
 
 ---
 
@@ -1929,6 +2123,6 @@ ErisPulse 工具函数集合
 ---
 
 
-*文档最后更新于 2025-07-19 19:31:39*
+*文档最后更新于 2025-07-21 17:57:00*
 
 <!--- End of API文档 -->