pytbox 0.0.7__py3-none-any.whl → 0.3.1__py3-none-any.whl

pytbox/mail/alimail.py

@@ -0,0 +1,142 @@
+#!/usr/bin/env python3
+
+from typing import Literal
+from datetime import datetime, timedelta
+
+import requests
+from ..utils.response import ReturnResponse
+from .mail_detail import MailDetail
+from ..utils.timeutils import TimeUtils
+
+
+
+class AliMail:
+    '''
+    _summary_
+    '''
+    def __init__(self, mail_address: str=None, client_id: str=None, client_secret: str=None, timeout: int=3):
+        self.email_address = mail_address
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.base_url = "https://alimail-cn.aliyuncs.com/v2"
+        self.timeout = timeout
+        self.headers = {
+                "Content-Type": "application/json",
+                "Authorization": f"bearer {self._get_access_token_by_request()}"
+            }
+        self.session = requests.Session()
+        self.session.headers.update(self.headers)
+        
+    
+    def _get_access_token_by_request(self):
+        '''
+        https://mailhelp.aliyun.com/openapi/index.html#/markdown/authorization.md
+
+        Raises:
+            ValueError: _description_
+
+        Returns:
+            _type_: _description_
+        '''
+        # 定义接口URL
+        interface_url = "https://alimail-cn.aliyuncs.com/oauth2/v2.0/token"
+        # 设置请求头，指定内容类型
+        headers = {'Content-Type': 'application/x-www-form-urlencoded'}
+        # 准备请求数据
+        data = {
+            "grant_type": "client_credentials",
+            "client_id": self.client_id,
+            "client_secret": self.client_secret
+        }
+        try:
+            response = requests.post(interface_url, headers=headers, data=data, timeout=self.timeout)
+            response_json = response.json()
+            current_time = datetime.now()
+            data = {
+                'token_type': response_json["token_type"],
+                'access_token': response_json["access_token"],
+                'expires_in':  response_json["expires_in"],
+                'expiration_time': current_time + timedelta(seconds=response_json["expires_in"])
+            }
+            return data.get("access_token")
+        except requests.RequestException as e:
+            # 处理请求失败异常
+            raise e
+        except (KeyError, ValueError) as e:
+            # 处理解析响应失败异常
+            raise e
+
+    def get_mail_folders(self):
+        response = self.session.get(
+            url=f"{self.base_url}/users/{self.email_address}/mailFolders",
+            headers=self.headers
+        )
+        return response.json().get('folders')
+
+    def get_folder_id(self, folder_name: Literal['inbox']='inbox'):
+        folders = self.get_mail_folders()
+        for folder in folders:
+            if folder.get('displayName') == folder_name:
+                return folder.get('id')
+        return None
+
+    def get_mail_detail(self, mail_id: str):
+        params = {
+            "$select": "body,toRecipients,internetMessageId,internetMessageHeaders"
+        }
+        response = self.session.get(
+            url=f"{self.base_url}/users/{self.email_address}/messages/{mail_id}",
+            headers=self.headers,
+            params=params,
+            timeout=3
+        )
+        return response.json().get('message')
+
+    def get_mail_list(self, folder_name: str='inbox', size: int=100):
+        folder_id = self.get_folder_id(folder_name=folder_name)
+        params = {
+            "size": size,
+            # "$select": "toRecipients"
+        }
+        response = self.session.get(
+            url=f"{self.base_url}/users/{self.email_address}/mailFolders/{folder_id}/messages",
+            headers=self.headers,
+            params=params,
+            timeout=3
+        )
+        messages = response.json().get("messages")
+        sent_to_list = []
+        for message in messages:
+            mail_id = message.get("id")
+            detail = self.get_mail_detail(mail_id=mail_id)
+            
+            for to_recipient in detail.get('toRecipients'):
+                sent_to_list.append(to_recipient.get('email'))
+            
+            yield MailDetail(
+                uid=message.get('id'),
+                sent_from=message.get('from').get('email'),
+                sent_to=sent_to_list,
+                date=TimeUtils.convert_str_to_datetime(time_str=message.get('sentDateTime'), app='alimail'),
+                cc="",
+                subject=message.get('subject'),
+                body_plain=message.get('summary'),
+                body_html=""
+            )
+
+    def move(self, uid: str, destination_folder: str) -> ReturnResponse:
+        params = {
+            "ids": [uid],
+            "destinationFolderId": self.get_folder_id(destination_folder)
+        }
+        r = self.session.post(
+            url=f"{self.base_url}/users/{self.email_address}/messages/move",
+            params=params
+        )
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f'邮件移动到 {destination_folder} 成功', data=None)
+        else:
+            return ReturnResponse(code=1, msg=f'邮件移动到 {destination_folder} 失败', data=r.json())
+
+if __name__ == '__main__':
+    ali_mail = AliMail()

pytbox/mail/client.py

@@ -0,0 +1,171 @@
+#!/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'
+        
+        elif 'mail' in mail_address and 'cn' in mail_address:
+            self.smtp_address = "smtpdm.aliyun.com"
+            self.imap_address = ""
+            
+        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/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

pytbox/mingdao.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+
+from typing import Literal, Type
+
+import requests
+
+from .utils.response import ReturnResponse
+
+
+class Mingdao:
+    '''
+    _summary_
+    '''
+    def __init__(self, app_key: str=None, sign: str=None, timeout: int=5):
+        self.base_url = "https://api.mingdao.com"
+        self.headers = {
+            'Content-Type': 'application/json;charset=UTF-8',
+            'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36'
+        }
+        self.timeout = timeout
+        self.app_key = app_key
+        self.sign = sign
+
+    def _build_api_request(self, api_url: str, method: Literal['GET', 'POST'], params: dict=None, body: dict=None, api_version: Literal['v1', 'v2']='v2'):
+        body['appKey'] = self.app_key
+        body['sign'] = self.sign
+        if not api_url.startswith('/'):
+            url = f'{self.base_url}/{api_version}/{api_url}'
+        else:
+            url = f'{self.base_url}/{api_version}{api_url}'
+        params = {
+            "appKey": self.app_key,
+            "sign": self.sign,
+        }
+        return requests.request(method, url, params=params, headers=self.headers, json=body, timeout=self.timeout)
+    
+    def get_app_info(self) -> ReturnResponse:
+        '''
+        _summary_
+
+        Returns:
+            ReturnResponse: _description_
+        '''
+        r = self._build_api_request(api_url='/open/app/get', method='GET', body={}, api_version='v1')
+        return ReturnResponse(code=0, msg='获取应用信息成功', data=r.json())
+    
+    def get_work_sheet_info(self, worksheet_id: str=None, table_name: str=None, worksheet_name: str=None):
+        if worksheet_name:
+            worksheet_id = self.get_work_sheet_id_by_name(table_name=table_name, worksheet_name=worksheet_name)
+        
+        r = self._build_api_request(
+            api_url='open/worksheet/getWorksheetInfo',
+            method='POST',
+            body={
+                "worksheetId": worksheet_id,
+            }
+        )
+        return r.json()
+    
+    def get_project_info(self, worksheet_id: str, keywords: str):
+        r = self._build_api_request(
+            api_url='open/worksheet/getFilterRows',
+            method='POST',
+            body={
+                "pageIndex": 1,
+                "pageSize": 100,
+                "worksheetId": worksheet_id,
+                "keyWords": keywords,
+            }
+        )
+        return r.json()
+    
+    def get_work_sheet_id_by_name(self, table_name: str, worksheet_name: str, child_section: bool=False):
+        r = self.get_app_info()        
+        for i in r.data['data']['sections']:
+            if table_name == i['name']:
+                if child_section:
+                    for child in i['childSections'][0]['items']:
+                        if child['name'] == worksheet_name:
+                            return child['id']
+                else:
+                    for item in i['items']:
+                        if item['name'] == worksheet_name:
+                            return item['id']
+
+    def get_control_id(self, table_name: str=None, worksheet_name: str=None, control_name: str=None):
+        r = self.get_work_sheet_info(table_name=table_name, worksheet_name=worksheet_name)
+        for control in r['data']['controls']:
+            if control['controlName'] == control_name:
+                return control['controlId']
+        return None
+    
+    def get_value(self, table_name: str=None, worksheet_name: str=None, control_name: str=None, value_name: str=None):
+        control_id = self.get_control_id(table_name=table_name, worksheet_name=worksheet_name, control_name=control_name)
+  
+        r = self._build_api_request(
+            api_url='open/worksheet/getFilterRows',
+            method='POST',
+            body={
+                "pageIndex": 1,
+                "pageSize": 100,
+                "worksheetId": self.get_work_sheet_id_by_name(table_name=table_name, worksheet_name=worksheet_name),
+                # "filters": filters
+            }
+        )
+        for row in r.json()['data']['rows']:
+            if row[control_id] == value_name:
+                return row['rowid']
+
+    def get_work_record(self, 
+                        worksheet_id: str=None,
+                        project_control_id: str=None,
+                        project_value: str=None,
+                        complete_date_control_id: str=None,
+                        complete_date: Literal['Today', '上个月', 'Last7Day', 'Last30Day']=None,
+                        parse_control_id: bool=False,
+                        page_size: int=100,
+                    ):
+        
+        filters = []
+        if project_value:
+            filters.append({
+                "controlId": project_control_id,
+                "dataType": 29,
+                "spliceType": 1,
+                "filterType": 24,
+                "dateRange": 0,
+                "dateRangeType": 0,
+                "value": "",
+                "values": [
+                    project_value
+                ],
+                "minValue": "",
+                "maxValue": ""
+            })
+        
+        if complete_date:
+            if complete_date == '上个月':
+                data_range = 8
+            elif complete_date == 'Today':
+                data_range = 1
+            elif complete_date == 'Last7Day':
+                data_range = 21
+            else:
+                data_range = 1
+            
+            filters.append({
+                "controlId": complete_date_control_id,
+                "dataType": 15,
+                "spliceType": 1,
+                "filterType": 17,
+                "dateRange": data_range,
+            })
+        r = self._build_api_request(
+            api_url='open/worksheet/getFilterRows',
+            method='POST',
+            body={
+                "pageIndex": 1,
+                "pageSize": page_size,
+                "worksheetId": worksheet_id,
+                "filters": filters
+            }
+        )
+        return r.json()