pytbox 0.1.2__tar.gz → 0.1.3__tar.gz

{pytbox-0.1.2/src/pytbox.egg-info → pytbox-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytbox
-Version: 0.1.2
+Version: 0.1.3
 Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
 Author-email: mingming hou <houm01@foxmail.com>
 License-Expression: MIT
@@ -16,6 +16,8 @@ Requires-Dist: rich>=12.0.0
 Requires-Dist: jinja2>=3.0.0
 Requires-Dist: toml>=0.10.0
 Requires-Dist: ldap3>=2.9.1
+Requires-Dist: imap-tools>=1.11.0
+Requires-Dist: yagmail>=0.15.293
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: black; extra == "dev"

{pytbox-0.1.2 → pytbox-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytbox"
-version = "0.1.2"
+version = "0.1.3"
 description = "A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)"
 authors = [{ name = "mingming hou", email = "houm01@foxmail.com" }]
 license = "MIT"
@@ -24,6 +24,8 @@ dependencies = [
     "jinja2>=3.0.0",                # 模板渲染
     "toml>=0.10.0",                 # TOML 输出支持
     "ldap3>=2.9.1",                 # LDAP 支持
+    "imap-tools>=1.11.0",
+    "yagmail>=0.15.293"
 ]
 
 [project.scripts]

{pytbox-0.1.2 → pytbox-0.1.3}/src/pytbox/base.py

@@ -12,6 +12,8 @@ from pytbox.win.ad import ADClient
 from pytbox.network.meraki import Meraki
 from pytbox.utils.env import get_env_by_os_environment
 from pytbox.vmware import VMwareClient
+from pytbox.pyjira import PyJira
+from pytbox.mail.client import MailClient
 
 config = load_config_by_file(path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id=os.environ.get('oc_vault_id'))
 
@@ -73,4 +75,12 @@ vmware_test = VMwareClient(
     password=config['vmware']['test']['password'],
     version=config['vmware']['test']['version'],
     proxies=config['vmware']['test']['proxies']
-)
+)
+
+pyjira = PyJira(
+    base_url=config['jira']['base_url'],
+    token=config['jira']['token']
+)
+
+mail_163 = MailClient(mail_address=config['mail']['163']['mail_address'], password=config['mail']['163']['password'])
+mail_qq = MailClient(mail_address=config['mail']['qq']['mail_address'], password=config['mail']['qq']['password'])

{pytbox-0.1.2 → pytbox-0.1.3}/src/pytbox/database/victoriametrics.py

@@ -73,6 +73,16 @@ class VictoriaMetrics:
     def check_ping_result(self, target: str, last_minute: int=10, env: str='prod', dev_file: str='') -> ReturnResponse:
         '''
         检查ping结果
+
+        Args:
+            target (str): 目标地址
+            last_minute (int, optional): 最近多少分钟. Defaults to 10.
+            env (str, optional): 环境. Defaults to 'prod'.
+            dev_file (str, optional): 开发文件. Defaults to ''.
+
+        Returns:
+            ReturnResponse: 
+                code = 0 正常, code = 1 异常, code = 2 没有查询到数据, 建议将其判断为正常
         '''
         if target:
             # 这里需要在字符串中保留 {}，同时插入 target，可以用双大括号转义

{pytbox-0.1.2 → pytbox-0.1.3}/src/pytbox/feishu/endpoints.py

@@ -254,9 +254,9 @@ class MessageEndpoint(Endpoint):
             body=payload
         )
         if r.code == 0:
-            return ReturnResponse(code=0, message=f"{message_id} 回复 emoji [{emoji_type}] 成功")
+            return ReturnResponse(code=0, msg=f"{message_id} 回复 emoji [{emoji_type}] 成功")
         else:
-            return ReturnResponse(code=1, message=f"{message_id} 回复 emoji [{emoji_type}] 失败")
+            return ReturnResponse(code=1, msg=f"{message_id} 回复 emoji [{emoji_type}] 失败")
 
 class BitableEndpoint(Endpoint):
     
@@ -432,10 +432,10 @@ class BitableEndpoint(Endpoint):
             resp = self.parent.request(path=f'/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}',
                                         method='PUT',
                                         body=payload)
-            return ReturnResponse(code=resp.code, message=f"记录已存在, 进行更新", data=resp.data)
+            return ReturnResponse(code=resp.code, msg=f"记录已存在, 进行更新", data=resp.data)
         else:
             resp = self.add_record(app_token, table_id, fields)
-            return ReturnResponse(code=resp.code, message=f"记录不存在, 进行创建", data=resp.data)
+            return ReturnResponse(code=resp.code, msg=f"记录不存在, 进行创建", data=resp.data)
 
     def query_name_by_record_id(self, app_token: str=None, table_id: str=None, field_names: list=None, record_id: str='', name: str=''):
         response = self.query_record(app_token=app_token, table_id=table_id, field_names=field_names)
@@ -967,9 +967,9 @@ class ExtensionsEndpoint(Endpoint):
                                    body=payload)
         if response.code == 0:
             if get == 'open_id':
-                return ReturnResponse(code=0, message=f'根据用户输入的 {user_input}, 获取用户信息成功', data=response.data['user_list'][0]['user_id'])
+                return ReturnResponse(code=0, msg=f'根据用户输入的 {user_input}, 获取用户信息成功', data=response.data['user_list'][0]['user_id'])
         else:
-            return ReturnResponse(code=response.code, message=f"获取时失败, 报错请见 data 字段", data=response.data)
+            return ReturnResponse(code=response.code, msg=f"获取时失败, 报错请见 data 字段", data=response.data)
     
     def format_rich_text(self, text: str, color: Literal['red', 'green', 'yellow', 'blue'], bold: bool=False):
         if bold:

pytbox-0.1.3/src/pytbox/mail/client.py

@@ -0,0 +1,167 @@
+#!/usr/bin/env python3
+
+
+from contextlib import contextmanager
+import yagmail
+from imap_tools import MailBox, MailMessageFlags, AND
+from .mail_detail import MailDetail
+from ..utils.response import ReturnResponse
+
+
+class MailClient:
+    '''
+    _summary_
+    '''
+    def __init__(self, 
+                 mail_address: str=None,
+                 password: str=None
+                ):
+        
+        self.mail_address = mail_address
+        self.password = password
+
+        if '163.com' in mail_address:
+            self.smtp_address = 'smtp.163.com'
+            self.imap_address = 'imap.163.com'
+            # self.imbox_client = self._create_imbox_object()
+        elif 'foxmail.com' in mail_address:
+            self.smtp_address = 'smtp.qq.com'
+            self.imap_address = 'imap.qq.com'
+            
+        else:
+            raise ValueError(f'不支持的邮箱地址: {mail_address}')
+    
+    @contextmanager
+    def get_mailbox(self, readonly=False):
+        """
+        创建并返回一个已登录的 MailBox 上下文管理器。
+        
+        使用方式:
+            with self.get_mailbox() as mailbox:
+                # 使用 mailbox 进行操作
+                pass
+        
+        Args:
+            readonly (bool): 是否以只读模式打开邮箱，只读模式下不会将邮件标记为已读
+        
+        Yields:
+            MailBox: 已登录的邮箱对象
+        """
+        mailbox = MailBox(self.imap_address).login(self.mail_address, self.password)
+        if readonly:
+            # 以只读模式选择收件箱，防止邮件被标记为已读
+            mailbox.folder.set('INBOX', readonly=True)
+        try:
+            yield mailbox
+        finally:
+            mailbox.logout()
+
+    def send_mail(self, receiver: list=None, cc: list=None, subject: str='', contents: str='', attachments: list=None, tips: str=None):
+        '''
+        _summary_
+
+        Args:
+            receiver (list, optional): _description_. Defaults to None.
+            cc (list, optional): _description_. Defaults to None.
+            subject (str, optional): _description_. Defaults to ''.
+            contents (str, optional): _description_. Defaults to ''.
+            attachments (list, optional): _description_. Defaults to None.
+        '''
+        with yagmail.SMTP(user=self.mail_address, password=self.password, port=465, host=self.smtp_address) as yag:
+            try:
+                if tips:
+                    contents = contents + '\n' + '<p style="color: red;">本邮件为系统自动发送</p>'
+                yag.send(to=receiver, cc=cc, subject=subject, contents=contents, attachments=attachments)
+                return True
+            except Exception as e:
+                return False
+            
+    def get_mail_list(self, seen: bool=False, readonly: bool=True):
+        '''
+        获取邮件
+
+        Args:
+            seen (bool, optional): 默认获取未读邮件, 如果为 True, 则获取已读邮件
+            readonly (bool, optional): 是否以只读模式获取邮件，默认为 True，防止邮件被标记为已读
+
+        Yields:
+            MailDetail: 邮件详情
+        '''
+        with self.get_mailbox(readonly=readonly) as mailbox:
+            for msg in mailbox.fetch(AND(seen=seen)):
+                yield MailDetail(
+                    uid=msg.uid,
+                    sent_from=msg.from_,
+                    sent_to=msg.to,
+                    date=msg.date,
+                    cc=msg.cc,
+                    subject=msg.subject,
+                    body_plain=msg.text,
+                    body_html=msg.html
+                )     
+            
+    def mark_as_read(self, uid):
+        """
+        标记邮件为已读。
+        
+        Args:
+            uid (str): 邮件的唯一标识符
+        """
+        try:
+            with self.get_mailbox() as mailbox:
+                # 使用 imap_tools 的 flag 方法标记邮件为已读
+                # 第一个参数是 uid，第二个参数是要设置的标志，第三个参数 True 表示添加标志
+                mailbox.flag(uid, [MailMessageFlags.SEEN], True)
+        except Exception as e:
+            return ReturnResponse(code=1, msg='邮件删除失败', data=e)
+    
+    def delete(self, uid):
+        """
+        删除邮件。
+        
+        Args:
+            uid (str): 邮件的唯一标识符
+        """
+        try:
+            with self.get_mailbox() as mailbox:
+                # 使用 imap_tools 的 delete 方法删除邮件
+                mailbox.delete(uid)
+                # log.info(f'删除邮件{uid}')
+        except Exception as e:
+            # log.error(f'删除邮件{uid}失败: {e}')
+            raise
+    
+    def move(self, uid: str, destination_folder: str) -> ReturnResponse:
+        """
+        移动邮件到指定文件夹。
+
+        注意：部分 IMAP 服务商（如 QQ 邮箱）在移动邮件时，实际上是"复制到目标文件夹并从原文件夹删除"，
+        这会导致邮件在原文件夹中消失，表现为"被删除"。但邮件会在目标文件夹中存在，并未彻底丢失。
+
+        Args:
+            uid (str): 邮件的唯一标识符。
+            destination_folder (str): 目标文件夹名称。
+
+        Returns:
+            ReturnResponse: 移动邮件结果
+
+        Raises:
+            Exception: 移动过程中底层 imap 库抛出的异常。
+        """
+        try:
+            with self.get_mailbox() as mailbox:
+                # 使用 imap_tools 的 move 方法移动邮件
+                mailbox.move(uid, destination_folder)
+                return ReturnResponse(code=0, msg=f'邮件 {uid} 移动到 {destination_folder} 成功', data=None)
+        except Exception as e:
+            return ReturnResponse(code=1, msg=f'邮件 {uid} 移动到 {destination_folder} 失败', data=e)
+
+    def get_folder_list(self):
+        '''
+        获取文件夹列表
+        '''
+        with self.get_mailbox() as mailbox:
+            return ReturnResponse(code=0, msg='获取文件夹列表成功', data=mailbox.folder.list())
+
+if __name__ == '__main__':
+    pass

pytbox-0.1.3/src/pytbox/mail/mail_detail.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+
+
+from dataclasses import dataclass
+
+@dataclass
+class MailDetail:
+    """
+    邮件详情数据类。
+    
+    Attributes:
+        uid: 邮件唯一标识符
+        send_from: 发件人邮箱地址
+        send_to: 收件人邮箱地址列表
+        cc: 抄送人邮箱地址列表
+        subject: 邮件主题
+        body_plain: 纯文本正文
+        body_html: HTML格式正文
+        attachment: 附件完整保存路径列表
+    """
+    uid: str=None
+    sent_from: str=None
+    sent_to: list=None
+    date: str=None
+    cc: list=None
+    subject: str=None
+    body_plain: str=None
+    body_html: str=None
+    attachment: list=None
+    has_attachments: bool=False