ezKit 1.7.1__py3-none-any.whl → 1.7.3__py3-none-any.whl

ezKit/sendemail.py

@@ -1,29 +1,62 @@
-'''
-https://stackoverflow.com/questions/882712/sending-html-email-using-python
-'''
+"""
+发送邮件
+"""
+# https://stackoverflow.com/questions/882712/sending-html-email-using-python
+# pylint: disable=E0611
+# pylint: disable=R0911
+# pylint: disable=R0912
+# pylint: disable=R0913
+# pylint: disable=R0914
+# pylint: disable=R0915
+# pylint: disable=R1710
 import smtplib
 from email.header import Header
 from email.mime.image import MIMEImage
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from email.utils import formataddr, parseaddr
+from typing import Optional, TypedDict, cast
 
 from loguru import logger
 
 from . import utils
 
 
+class TypedSMTP(TypedDict):
+    """smtp type"""
+    server: str
+    port: int
+    tls: bool
+
+class TypedSender(TypedDict):
+    """sender type"""
+    name: str
+    address: str
+    password: str
+
+class TypedBody(TypedDict, total=False):
+    """body type"""
+    content: str
+    type: Optional[str]
+
 def format_parse(s):
     _name, _addr = parseaddr(s)
-    return formataddr((Header(_name, 'utf-8').encode(), _addr))
-
-def related_html(smtp=None, sender=None, recipients=None, subject=None, html_file=None, images=None):
-    '''
+    return formataddr((Header(_name, "utf-8").encode(), _addr))
+
+def sendemail(
+    smtp: TypedSMTP,
+    sender: TypedSender,
+    recipients: str | list,
+    subject: str,
+    body: TypedBody,
+    images: None | list = None
+) -> bool:
+    """
     smtp SMTP信息
 
-        server SMTP地址
-        port   SMTP端口
-        ssl    是否使用SSL
+        server  SMTP地址
+        port    SMTP端口
+        tls     是否使用TLS
 
     sender 发件人信息
 
@@ -31,15 +64,20 @@ def related_html(smtp=None, sender=None, recipients=None, subject=None, html_fil
         address  发件人邮箱地址
         password 发件人邮箱密码(SMTP)
 
-    recipients 收件人列表
-    subject 邮件主题
-    html_file HTML文件
+    recipients  收件人(或列表)
+
+    subject     邮件主题
+
+    body        邮件主体
+
+        content 内容
+        type    类型 (默认 plain, 或者 file, 或者 html)
 
     images 图片列表(可选)
 
         cid  图片CID
         path 图片路径
-    '''
+    """
 
     # 参数判断
     # match True:
@@ -59,88 +97,172 @@ def related_html(smtp=None, sender=None, recipients=None, subject=None, html_fil
     #         logger.error('ERROR!! {} is not string or none'.format('html_file'))
     #         return False
 
-    logger.success('sendemail start')
+    logger.success("sendemail start")
 
     try:
 
-        _message = MIMEMultipart('related')
+        # 邮件主体
+
+        if utils.v_true(body, dict) is False:
+            logger.error("body error")
+            return False
 
-        with open(html_file, 'r') as _html_file:
+        message: MIMEMultipart = MIMEMultipart()
 
-            _message.attach(MIMEText(_html_file.read(), 'html', 'utf-8'))
+        body_content = cast(str, body.get("content"))
 
-            if utils.v_true(images, list):
+        if utils.v_true(body_content, str) is False:
+            logger.error(f"body content error: {body_content}")
+            return False
 
-                for _image in images:
+        body_type = cast(str, body.get("type"))
 
-                    try:
+        # 从文本文件读取内容
+        if body_type == "file":
+            with open(body_content, "r", encoding="utf-8") as file:
+                message.attach(MIMEText(file.read(), "plain", "utf-8"))
 
-                        if utils.check_file_type(_image.get('path', ''), 'file'):
+        # 从HTML文件读取内容
+        elif body_type == "html":
+            message = MIMEMultipart("related")
+            with open(body_content, "r", encoding="utf-8") as file:
+                message.attach(MIMEText(file.read(), "html", "utf-8"))
 
-                            '''
-                            添加图片
-                            with open(image_path, 'rb') as image_file:
-                                mime_image = MIMEImage(image_file.read())
-                                # Define the image's ID as referenced above
-                                mime_image.add_header('Content-ID', '<CID>')
-                                message.attach(mime_image)
-                            '''
+        # 纯文本内容
+        else:
+            message.attach(MIMEText(body_content, "plain", "utf-8"))
 
-                            with open(_image['path'], 'rb') as _image_file:
-                                _mime_image = MIMEImage(_image_file.read())
-                                _mime_image.add_header('Content-ID', '<{}>'.format(_image['cid']))
-                                _message.attach(_mime_image)
+        # ------------------------------------------------------------------------------------------
 
-                        else:
+        # SMTP
 
-                            next
+        if utils.v_true(smtp, dict) is False:
+            logger.error("smtp error")
+            return False
 
-                    except Exception as e:
-                        logger.exception(e)
-                        next
+        smtp_host = cast(str, smtp.get("server"))
+        smtp_port = cast(int, smtp.get("port"))
+        smtp_tls = cast(bool, smtp.get("tls"))
 
-        # 发件人
-        _message['From'] = formataddr([sender.get('name'), sender.get('address')])
+        if utils.v_true(smtp_host, str) is False:
+            logger.error(f"smtp host error: {smtp_host}")
+            return False
+
+        if utils.v_true(smtp_port, int) is False:
+            logger.error(f"smtp port error: {smtp_port}")
+            return False
+
+        smtp_tls = utils.v_true(smtp_tls, bool)
+
+        # ------------------------------------------------------------------------------------------
+
+        # 发件人信息
+
+        if utils.v_true(sender, dict) is False:
+            logger.error("sender error")
+            return False
+
+        sender_name = cast(str, sender.get("name"))
+        sender_address = cast(str, sender.get("address"))
+        sender_password = cast(str, sender.get("password"))
+
+        if utils.v_true(sender_name, str) is False:
+            logger.error(f"sender name error: {sender_name}")
+            return False
+
+        if utils.v_true(sender_address, str) is False:
+            logger.error(f"sender address error: {sender_address}")
+            return False
+
+        if utils.v_true(sender_password, str) is False:
+            logger.error(f"sender password error: {sender_password}")
+            return False
+
+        message["From"] = formataddr((sender_name, sender_address))
+
+        # ------------------------------------------------------------------------------------------
+
+        # 收件人(或列表)
 
-        # 收件人
         if utils.v_true(recipients, str):
-            _message['To'] = format_parse(recipients)
+            message["To"] = format_parse(recipients)
         elif utils.v_true(recipients, list):
-            _message['To'] = ", ".join(list(map(format_parse, recipients)))
+            message["To"] = ", ".join(list(map(format_parse, recipients)))
         else:
-            logger.error('recipients error')
+            logger.error("recipients error")
             return False
 
-        # 主题
-        _message['Subject'] = subject
+        # ------------------------------------------------------------------------------------------
 
-        '''
-        发送邮件
+        # 邮件主题
 
-        SMTP.sendmail(from_addr, to_addrs, msg, mail_options=(), rcpt_options=())
+        if utils.v_true(subject, str) is False:
+            logger.error("subject error")
+            return False
 
-            to_addrs = sender_to + sender_cc
-            https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.sendmail
-            https://gist.github.com/AO8/c5a6f747eeeca02351152ae8dc79b537
-        '''
+        message["Subject"] = subject
 
-        if smtp.get('ssl', False) == True:
+        # ------------------------------------------------------------------------------------------
 
-            with smtplib.SMTP_SSL(smtp.get('server'), smtp.get('port')) as _smtp:
-                _smtp.login(sender.get('address'), sender.get('password'))
-                _smtp.sendmail(sender.get('address'), recipients, _message.as_string())
+        if images is not None and utils.v_true(images, list):
 
-        else:
+            for image in images:
+
+                try:
+
+                    if utils.check_file_type(image.get("path", ""), "file"):
 
-            with smtplib.SMTP(smtp.get('server'), smtp.get('port')) as _smtp:
-                _smtp.login(sender.get('address'), sender.get('password'))
-                _smtp.sendmail(sender.get('address'), recipients, _message.as_string())
+                        # 添加图片
+                        # with open(image_path, "rb") as image_file:
+                        #     mime_image = MIMEImage(image_file.read())
+                        #     # Define the image's ID as referenced above
+                        #     mime_image.add_header("Content-ID", "<CID>")
+                        #     message.attach(mime_image)
 
-        logger.success('sendemail success')
+                        with open(image["path"], "rb") as _image_file:
+                            mime_image = MIMEImage(_image_file.read())
+                            mime_image.add_header("Content-ID", f"<{image['cid']}>")
+                            message.attach(mime_image)
 
-        return True
+                except Exception as e:
+                    logger.exception(e)
+                    return False
+
+        # ------------------------------------------------------------------------------------------
+
+        # 发送邮件
+
+        # SMTP.sendmail(from_addr, to_addrs, msg, mail_options=(), rcpt_options=())
+        #
+        #     to_addrs = sender_to + sender_cc
+        #     https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.sendmail
+        #     https://gist.github.com/AO8/c5a6f747eeeca02351152ae8dc79b537
+
+        # if smtp.get('ssl', False) is True:
+
+        #     with smtplib.SMTP_SSL(smtp_host, smtp_port) as _smtp:
+        #         _smtp.login(sender_address, sender_password)
+        #         _smtp.sendmail(sender_address, recipients, _message.as_string())
+
+        # else:
+
+        with smtplib.SMTP(smtp_host, smtp_port) as smtp_server:
+            if smtp_tls is True:
+                smtp_server.starttls()
+            smtp_server.login(sender_address, sender_password)
+            smtp_server.sendmail(sender_address, recipients, message.as_string())
+
+            logger.success("sendemail success")
+
+            return True
 
     except Exception as e:
+
+        # 忽略腾讯邮箱返回的异常
+        if e.args == (-1, b'\x00\x00\x00'):
+            # pass
+            return True
+
         logger.error('sendemail error')
         logger.exception(e)
         return False

{ezKit-1.7.1.dist-info → ezKit-1.7.3.dist-info}/METADATA

@@ -1,9 +1,8 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.7.1
+Version: 1.7.3
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 License-File: LICENSE
-

{ezKit-1.7.1.dist-info → ezKit-1.7.3.dist-info}/RECORD

@@ -10,13 +10,13 @@ ezKit/plots.py,sha256=QUtoVfZ49ZSNcY8gcQ2TYVkMjDDzoW-myMtqTi5WN2U,5322
 ezKit/qywx.py,sha256=7eWrlTLrUj6U6cViEGbT6_LQxFGVqkhGAefBSS6T_-0,6531
 ezKit/redis.py,sha256=pY4SPlcgQ7S8IeY2xoDpxy-xCZxzZQrQJNAoWRsC1dI,1773
 ezKit/reports.py,sha256=dBBggggCCLuk5YD6SjdUPuxTr3wiJojP3lA7dQfg6Pk,8898
-ezKit/sendemail.py,sha256=PItznLBcZ6Om8NU7rep69m3QNZ9YkmOovup7pPGyY58,4840
+ezKit/sendemail.py,sha256=AAdxBvEYN_AJVvBkSAvXzhXC5jkbRsD_8P51h2SdTRw,8413
 ezKit/token.py,sha256=4L6A26KsxvB4WfF8R7SYiBmihJK0PiN5Oh7dgDVJtxU,1382
 ezKit/utils.py,sha256=VkZzKy_jupr25Axa5I0juMsm1XiaimyiPoSITA91jcg,47826
 ezKit/xftp.py,sha256=qbCqFcGe22TDBSisj0Zoz78tnydDWoOfvywWpXdfaGw,6982
 ezKit/zabbix.py,sha256=soM5UEeYMfm7NczbPOVLirmHm3G20dECQ0aCBttZfhQ,28350
-ezKit-1.7.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ezKit-1.7.1.dist-info/METADATA,sha256=KibjySW6aXShA6YkITs9NwhdMG4LCijMTKcAu7-uT50,164
-ezKit-1.7.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-ezKit-1.7.1.dist-info/top_level.txt,sha256=aYLB_1WODsqNTsTFWcKP-BN0KCTKcV-HZJ4zlHkCFw8,6
-ezKit-1.7.1.dist-info/RECORD,,
+ezKit-1.7.3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ezKit-1.7.3.dist-info/METADATA,sha256=KisYwblMheFnzhCtB9WvgESi3-Z8VsnZ8jJPrw1swGQ,163
+ezKit-1.7.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+ezKit-1.7.3.dist-info/top_level.txt,sha256=aYLB_1WODsqNTsTFWcKP-BN0KCTKcV-HZJ4zlHkCFw8,6
+ezKit-1.7.3.dist-info/RECORD,,

{ezKit-1.7.1.dist-info → ezKit-1.7.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.5.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any