simtoolsz 0.1.0__tar.gz

simtoolsz-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv

simtoolsz-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12.4

simtoolsz-0.1.0/LICENSE

@@ -0,0 +1,134 @@
+木兰宽松许可证, 第2版
+
+木兰宽松许可证， 第2版
+
+2020年1月 http://license.coscl.org.cn/MulanPSL2
+
+您对“软件”的复制、使用、修改及分发受木兰宽松许可证，第2版（“本许可证”）的如下条款的约束：
+
+0.   定义
+
+“软件” 是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
+
+“贡献” 是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
+
+“贡献者” 是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
+
+“法人实体” 是指提交贡献的机构及其“关联实体”。
+
+“关联实体” 是指，对“本许可证”下的行为方而言，控制、受控制或与其共同受控制的机构，此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
+
+1.   授予版权许可
+
+每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可，您可以复制、使用、修改、分发其“贡献”，不论修改与否。
+
+2.   授予专利许可
+
+每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的（根据本条规定撤销除外）专利许可，供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求，不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地，就“软件”或其中的“贡献”对任何人发起专利侵权诉讼（包括反诉或交叉诉讼）或其他专利维权行动，指控其侵犯专利权，则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
+
+3.   无商标许可
+
+“本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可，但您为满足第4条规定的声明义务而必须使用除外。
+
+4.   分发限制
+
+您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发，不论修改与否，但您必须向接收者提供“本许可证”的副本，并保留“软件”中的版权、商标、专利及免责声明。
+
+5.   免责声明与责任限制
+
+“软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下，“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任，不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。
+
+6.   语言
+
+“本许可证”以中英文双语表述，中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致，以中文版为准。
+
+条款结束
+
+如何将木兰宽松许可证，第2版，应用到您的软件
+
+如果您希望将木兰宽松许可证，第2版，应用到您的新软件，为了方便接收者查阅，建议您完成如下三步：
+
+1， 请您补充如下声明中的空白，包括软件名、软件的首次发表年份以及您作为版权人的名字；
+
+2， 请您在软件包的一级目录下创建以“LICENSE”为名的文件，将整个许可证文本放入该文件中；
+
+3， 请将如下声明文本放入每个源文件的头部注释中。
+
+Copyright (c) 2025 Sidney Zhang
+simtoolsz is licensed under Mulan PSL v2.
+
+You can use this software according to the terms and conditions of the Mulan PSL v2.
+You may obtain a copy of Mulan PSL v2 at:
+         http://license.coscl.org.cn/MulanPSL2
+THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+See the Mulan PSL v2 for more details.
+
+
+Mulan Permissive Software License，Version 2
+
+Mulan Permissive Software License，Version 2 (Mulan PSL v2)
+
+January 2020 http://license.coscl.org.cn/MulanPSL2
+
+Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions:
+
+0. Definition
+
+Software means the program and related documents which are licensed under this License and comprise all Contribution(s).
+
+Contribution means the copyrightable work licensed by a particular Contributor under this License.
+
+Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
+
+Legal Entity means the entity making a Contribution and all its Affiliates.
+
+Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
+
+1. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
+
+2. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
+
+3. No Trademark License
+
+No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4.
+
+4. Distribution Restriction
+
+You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
+
+5. Disclaimer of Warranty and Limitation of Liability
+
+THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+6. Language
+
+THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
+
+END OF THE TERMS AND CONDITIONS
+
+How to Apply the Mulan Permissive Software License，Version 2 (Mulan PSL v2) to Your Software
+
+To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
+
+Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner;
+
+Create a file named "LICENSE" which contains the whole context of this License in the first directory of your software package;
+
+Attach the statement to the appropriate annotated syntax at the beginning of each source file.
+
+Copyright (c) 2025 Sidney Zhang
+simtoolsz is licensed under Mulan PSL v2.
+
+You can use this software according to the terms and conditions of the Mulan PSL v2.
+You may obtain a copy of Mulan PSL v2 at:
+         http://license.coscl.org.cn/MulanPSL2
+THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+See the Mulan PSL v2 for more details.

simtoolsz-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: simtoolsz
+Version: 0.1.0
+Summary: A simple tool collection.
+Author-email: Sidney Zhang <liangyi@me.com>
+License: MulanPSL-2.0
+Keywords: collection,tool
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# simtoolsz
+
+[English](README_EN.md) | 中文
+
+
+一个简单、方便的工具集合，包含一些好用的函数、类、方法。
+
+计划把我之前写的[工具包](https://github.com/SidneyLYZhang/pytoolsz)做一些精简，之前的包被我塞了太多的东西。
+现在做一些精简，保留最常用的哪些工具，以及一些常用的函数。
+
+

simtoolsz-0.1.0/README.md

@@ -0,0 +1,11 @@
+# simtoolsz
+
+[English](README_EN.md) | 中文
+
+
+一个简单、方便的工具集合，包含一些好用的函数、类、方法。
+
+计划把我之前写的[工具包](https://github.com/SidneyLYZhang/pytoolsz)做一些精简，之前的包被我塞了太多的东西。
+现在做一些精简，保留最常用的哪些工具，以及一些常用的函数。
+
+

simtoolsz-0.1.0/README_EN.md

@@ -0,0 +1,9 @@
+# simtoolsz
+
+English | [中文](README.md)
+
+A simple and convenient toolkit containing useful functions, classes, and methods.
+
+Planning to streamline my previously written [toolkit](https://github.com/SidneyLYZhang/pytoolsz), 
+as the previous package had accumulated too many things. 
+Now doing some simplification, keeping only the most commonly used tools and some frequently used functions.

simtoolsz-0.1.0/docs/mail_usage_guide.md

@@ -0,0 +1,284 @@
+# 邮件功能使用指南
+
+本指南介绍如何使用优化后的邮件发送和接收功能。
+
+## 📧 发送邮件 - send_email
+
+### 基本功能
+- 发送纯文本或HTML格式邮件
+- 支持多个收件人、抄送、密送
+- 支持附件和内嵌图片
+- 自动识别主流邮箱SMTP配置
+- 详细的错误处理和返回信息
+
+### 参数说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| email_account | str | ✅ | 邮箱账号（如：user@qq.com） |
+| password | str | ✅ | 邮箱密码或授权码 |
+| subject | str | ✅ | 邮件主题 |
+| content | str | ✅ | 邮件正文内容 |
+| recipients | str/list | ✅ | 收件人邮箱（支持单个邮箱字符串或多个邮箱列表） |
+| attachments | list | ❌ | 附件文件路径列表 |
+| cc_recipients | list | ❌ | 抄送邮箱列表 |
+| bcc_recipients | list | ❌ | 密送邮箱列表 |
+| sender_name | str | ❌ | 发件人显示名称 |
+| html_mode | bool | ❌ | 是否使用HTML格式（默认False） |
+| inline_images | dict | ❌ | 内嵌图片（{cid: filepath}格式） |
+| signature | str | ❌ | 邮件签名 |
+| smtp_config | dict | ❌ | 自定义SMTP配置 |
+| timeout | int | ❌ | 超时时间（秒，默认30） |
+
+### 返回值格式
+
+```python
+{
+    "success": bool,           # 是否成功
+    "message": str,            # 状态信息
+    "recipient_count": int,    # 成功发送的收件人数量
+    "failed_recipients": list  # 发送失败的收件人列表
+}
+```
+
+### 使用示例
+
+#### 1. 发送简单文本邮件
+```python
+from simtoolsz.mail import send_email
+
+result = send_email(
+    email_account="user@qq.com",
+    password="your_password",
+    subject="测试邮件",
+    content="这是一封测试邮件",
+    recipients="recipient@example.com"
+)
+```
+
+#### 2. 发送带附件的邮件
+```python
+result = send_email(
+    email_account="user@163.com",
+    password="auth_code",
+    subject="工作报告",
+    content="请查收本周工作报告",
+    recipients=["boss@company.com", "colleague@company.com"],
+    attachments=["report.pdf", "data.xlsx"],
+    cc_recipients=["manager@company.com"]
+)
+```
+
+#### 3. 发送HTML格式邮件
+```python
+result = send_email(
+    email_account="user@gmail.com",
+    password="app_password",
+    subject="产品通知",
+    content="""
+    <h1>新产品发布</h1>
+    <p>我们很高兴地通知您，新产品已上线！</p>
+    <img src="cid:product_image" style="width: 300px;">
+    """,
+    recipients="client@example.com",
+    html_mode=True,
+    inline_images={"product_image": "product.jpg"}
+)
+```
+
+#### 4. 使用自定义SMTP配置
+```python
+result = send_email(
+    email_account="user@company.com",
+    password="password",
+    subject="系统通知",
+    content="系统维护通知",
+    recipients="all@company.com",
+    smtp_config={
+        "server": "smtp.company.com",
+        "port": 587,
+        "use_ssl": True
+    }
+)
+```
+
+## 📥 获取邮件 - fetch_emails
+
+### 基本功能
+- 按条件搜索和获取邮件
+- 支持下载邮件附件
+- 支持多种搜索模式（精确、模糊、正则）
+- 自动识别主流邮箱IMAP配置
+- 详细的邮件信息返回
+
+### 参数说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| email_account | str | ✅ | 邮箱账号 |
+| password | str | ✅ | 邮箱密码或授权码 |
+| subject | str | ❌ | 搜索主题关键词 |
+| sender | str | ❌ | 发件人邮箱 |
+| date_range | tuple | ❌ | 日期范围（(start_date, end_date)） |
+| search_mode | str | ❌ | 搜索模式：exact/fuzzy/regex |
+| max_emails | int | ❌ | 最大获取邮件数量 |
+| download_attachments | bool | ❌ | 是否下载附件 |
+| attachment_dir | str | ❌ | 附件保存目录 |
+| imap_config | dict | ❌ | 自定义IMAP配置 |
+
+### 返回值格式
+
+```python
+{
+    "success": bool,           # 是否成功
+    "message": str,            # 状态信息
+    "email_count": int,        # 获取的邮件数量
+    "emails": [                # 邮件列表
+        {
+            "subject": str,        # 主题
+            "from": str,           # 发件人
+            "to": str,             # 收件人
+            "date": str,           # 日期
+            "text_body": str,      # 纯文本内容
+            "html_body": str,      # HTML内容
+            "size": int,           # 邮件大小（字节）
+            "attachments": [       # 附件列表
+                {
+                    "filename": str,     # 文件名
+                    "size": int,        # 文件大小
+                    "filepath": str     # 保存路径
+                }
+            ]
+        }
+    ],
+    "attachments_dir": str     # 附件保存目录
+}
+```
+
+### 使用示例
+
+#### 1. 获取最新邮件
+```python
+from simtoolsz.mail import fetch_emails
+from datetime import datetime, timedelta
+
+result = fetch_emails(
+    email_account="user@qq.com",
+    password="password",
+    max_emails=10
+)
+
+if result["success"]:
+    for email in result["emails"]:
+        print(f"主题: {email['subject']}")
+        print(f"发件人: {email['from']}")
+        print(f"日期: {email['date']}")
+```
+
+#### 2. 按主题搜索邮件
+```python
+result = fetch_emails(
+    email_account="user@163.com",
+    password="auth_code",
+    subject="工作报告",
+    search_mode="fuzzy",
+    date_range=(datetime.now() - timedelta(days=7), datetime.now())
+)
+```
+
+#### 3. 获取特定发件人的邮件
+```python
+result = fetch_emails(
+    email_account="user@gmail.com",
+    password="app_password",
+    sender="reports@company.com",
+    max_emails=5
+)
+```
+
+#### 4. 下载邮件附件
+```python
+result = fetch_emails(
+    email_account="user@company.com",
+    password="password",
+    subject="数据报告",
+    download_attachments=True,
+    attachment_dir="./downloads",
+    max_emails=3
+)
+
+if result["success"]:
+    for email in result["emails"]:
+        if email["attachments"]:
+            print(f"邮件 '{email['subject']}' 包含附件:")
+            for att in email["attachments"]:
+                print(f"  - {att['filename']} -> {att['filepath']}")
+```
+
+## 🔧 邮箱配置参考
+
+### 常用邮箱SMTP/IMAP设置
+
+| 邮箱服务商 | SMTP服务器 | SMTP端口 | IMAP服务器 | IMAP端口 | 备注 |
+|---|---|---|---|---|---|
+| QQ邮箱 | smtp.qq.com | 465/587 | imap.qq.com | 993 | 需使用授权码 |
+| 163邮箱 | smtp.163.com | 465/994 | imap.163.com | 993 | 需使用授权码 |
+| Gmail | smtp.gmail.com | 465/587 | imap.gmail.com | 993 | 需使用应用专用密码 |
+| Outlook | smtp-mail.outlook.com | 587 | imap-mail.outlook.com | 993 | 需使用应用密码 |
+| 126邮箱 | smtp.126.com | 465/994 | imap.126.com | 993 | 需使用授权码 |
+
+### 获取授权码方法
+
+#### QQ邮箱授权码
+1. 登录QQ邮箱网页版
+2. 进入 设置 > 账户
+3. 找到 "POP3/SMTP服务" 并开启
+4. 生成授权码
+
+#### 163邮箱授权码
+1. 登录163邮箱网页版
+2. 进入 设置 > POP3/SMTP/IMAP
+3. 开启SMTP/IMAP服务
+4. 获取授权码
+
+#### Gmail应用专用密码
+1. 登录Google账户
+2. 进入 安全性 > 两步验证
+3. 找到 "应用专用密码"
+4. 生成用于邮件的密码
+
+## ⚠️ 注意事项
+
+1. **安全性**
+   - 不要将密码硬编码在代码中
+   - 使用环境变量或配置文件存储敏感信息
+   - 定期更换授权码
+
+2. **性能**
+   - 大量邮件获取时设置合理的max_emails值
+   - 大附件下载时注意磁盘空间
+   - 设置合适的timeout值避免网络超时
+
+3. **错误处理**
+   - 始终检查返回值的success字段
+   - 查看message字段获取详细错误信息
+   - 网络异常时重试机制
+
+4. **兼容性**
+   - 旧函数名quick_send_email和load_email_by_subject仍可使用
+   - 新函数提供更好的错误处理和返回值
+
+## 🚀 快速开始
+
+1. 安装依赖：确保已安装所需Python包
+2. 获取授权码：根据邮箱类型获取相应的授权码
+3. 运行示例：参考examples/mail_examples.py中的示例代码
+4. 集成项目：将函数集成到你的项目中
+
+## 📞 技术支持
+
+如遇到问题，请检查：
+- 网络连接是否正常
+- 邮箱账号和密码是否正确
+- 邮箱服务是否已开启SMTP/IMAP
+- 防火墙是否阻止了相应端口