feat: add sender & recipient name

README.md

@@ -40,9 +40,11 @@ mail.send(receiver='someone@example.com',  # Email From Any service Provider
 
 **Parameters**
 ```py
-receiver: Email Address as String or List.                [Recuired]
+receiver: Email Address as String or List.                [Required]
 cc: Email Address as String or List.  (Carbon Copy)       [Optional]
 bcc: Email Address as String or List. (Blind Carbon Copy) [Optional]
+sender_name: Set Sender name.                             [Optional]
+receiver_name: Set receiver name.                         [Optional]
 no_reply: Set Another Email To Reply                      [Optional]
 subject: Message Title.                                   [Optional]
 message: Your Message.                                    [Optional]
@@ -134,6 +136,11 @@ mail.about()
 
 #### Changelogs
 
+> > 2022.2.22 update:
+> - Add (sender name & receiver name) feature.
+
+<br>
+
 > > 2022.2.10 update:
 > - Fix issue #3 TypeError on python < 3.10
 

docs/index.md

@@ -138,6 +138,168 @@ mail.about()
 > - Fix issue #3 TypeError on python < 3.10
 
 <br>
+![image](https://raw.githubusercontent.com/Al-Taie/quick-mailer/master/images/bsmala.png)
+
+[![Downloads](https://pepy.tech/badge/quick-mailer)](https://pepy.tech/project/quick-mailer)
+[![Downloads](https://pepy.tech/badge/quick-mailer/month)](https://pepy.tech/project/quick-mailer/month)
+[![Downloads](https://pepy.tech/badge/quick-mailer/week)](https://pepy.tech/project/quick-mailer/week)
+<a href="https://www.instagram.com/9_Tay"><img src="https://img.shields.io/badge/instagram-%23E4415F?style=flat&logo=instagram&logoColor=white"/></a>
+
+# Description
+
+This Module help you to send **fast Email. 🌸**
+
+And you can attach **image, audio, and other files easily.**
+
+The Module support **Gmail And Microsoft** right now, but in the nearly future will support other mail services.
+
+# Installation:
+
+```cmd
+pip install quick-mailer
+```
+
+**[-->> pypi Link](https://pypi.org/project/quick-mailer)**
+**[-->> GitHub Link](https://github.com/Al-Taie/quick-mailer)**
+
+# Usage:
+
+**Send Message**
+
+```py
+from mailer import Mailer
+
+mail = Mailer(email='someone@gmail.com',
+              password='your_password')
+
+mail.send(receiver='someone@example.com',  # Email From Any service Provider
+          no_reply='noreplay@example.com', # Redirect receiver to another email when try to reply.
+          subject='TEST',
+          message='HI, This Message From Python :)')
+```
+
+**Parameters**
+
+```py
+receiver: Email Address as String or List.                [Required]
+cc: Email Address as String or List.  (Carbon Copy)       [Optional]
+bcc: Email Address as String or List. (Blind Carbon Copy) [Optional]
+sender_name: Set Sender name.                             [Optional]
+receiver_name: Set receiver name.                         [Optional]
+no_reply: Set Another Email To Reply                      [Optional]
+subject: Message Title.                                   [Optional]
+message: Your Message.                                    [Optional]
+image: Image File Name.               (Image Path)        [Optional]
+audio: Audio File Name.               (Audio Path)        [Optional]
+file: File Name.                      (Any File Path)     [Optional]
+```
+
+**Check Send Status**
+
+```py
+# Using (status) Attribute 
+print(mail.status)
+
+# Example For One Receiver:
+if mail.status:
+  pass
+else:
+  pass
+
+ # Note:
+ # IF You Put List Emails Receivers
+ # Variable Will Return Dictionary Results.
+
+ # IF You Allowed Repeat
+ # The Attribute Will provide Results List.
+```
+
+**Send Multi Files**
+
+```py
+mail.send(receiver='someone@example.com',  # Email From Any service Provider
+          subject='TEST',
+          message='HI, This Message From Python :)',
+          image='img.jpg',      # Image File Path
+          audio='sound.mp3',    # Audio File Path
+          file='file.zip')      # Any File Path
+```
+
+**Settings Method**
+
+```py
+mail.settings(repeat=1,             # To Repeat Sending
+              sleep=0,              # To Sleep After Send Each Message
+              provider=mail.GMAIL,  # Set Maill Service
+              multi=False)          # Default False, If You Set True
+                                    # Message Will Sent 4 Each Email Alone
+                                    # Else Will Sent To All Together
+```
+
+**Send Multi Emails**
+
+```py
+# One By One:
+mail.settings(multi=False)
+
+# In Same Message:
+mail.settings(multi=True)
+
+mail.send(receiver=['someone@example.com', 'someone1@example.com'],
+          subject='TEST',
+          message='HI, This Message From Python :)')
+```
+
+**Counter Variables**
+
+```py
+# CC Receivers Count
+print('CC count:', mail.count_cc)
+
+# BCC Receivers Count
+print('BCC count:', mail.count_bcc)
+
+# Receivers Count
+print('Receivers count:', mail.count_rec)
+
+# Messages Count
+print('Messages count:', mail.count_msg)
+```
+
+**Example Function**
+
+```py
+from mailer import example
+
+example()
+```
+
+**About Method**
+
+```py
+# You Can Use (mail.about) Method for more info.
+mail.about()
+```
+
+#### Changelogs
+
+> > 2022.2.22 update:
+> - Add (sender name & receiver name) feature.
+
+<br>
+
+> > 2022.2.10 update:
+> - Fix issue #3 TypeError on python < 3.10
+
+<br>
+
+> > 2022.2.2 update:
+> - Support Html Message
+> - Fix issue #1 TypeError on python < 3.10
+
+**Follow Me on Instagram: [@9_Tay](https://www.instagram.com/9_tay). 🌸**
+
+# Thank You :) 🌸
 
 > > 2022.2.2 update:
 > - Support Html Message

mailer/__init__.py

@@ -26,4 +26,4 @@
 from mailer.utils import example
 
 __all__ = ['Mailer', '__VERSION__', 'example']
-__VERSION__ = '2022.2.10'
+__VERSION__ = '2022.2.22'

mailer/send.py

@@ -3,6 +3,7 @@
 from email.mime.image import MIMEImage
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
+from email.utils import formataddr
 from time import sleep
 from typing import Text, List, Dict, Union
 
@@ -22,14 +23,16 @@ def __init__(self, email: str, password: str):
         self._msg = MIMEMultipart()
 
     def __prepare_message(self,
-                          receiver,
-                          cc=None,
-                          bcc=None,
+                          receiver: str,
+                          receiver_name: str = '',
+                          sender_name: str = '',
+                          cc: str = None,
+                          bcc: str = None,
                           no_reply: str = None,
                           subject: str = None,
                           message: str = None) -> None:
         self._msg['Subject'] = subject
-        self._msg['From'] = self.email
+        self._msg['From'] = formataddr(pair=(sender_name, self.email))
 
         if message is not None:
             text = MIMEText(message, 'html')
@@ -47,7 +50,7 @@ def __prepare_message(self,
             self.count_bcc = len(bcc)
             bcc: Text = ','.join(i for i in bcc)
 
-        self._msg['To'] = receiver
+        self._msg['To'] = formataddr(pair=(receiver_name, receiver))
         self._msg['CC'] = cc
         self._msg['BCC'] = bcc
         self._msg['Reply-To'] = no_reply
@@ -86,16 +89,20 @@ def __prepare_attachments(self,
 
     # Send Method
     def send(self,
-             receiver,
-             cc=None,
-             bcc=None,
+             receiver: str,
+             receiver_name: str = '',
+             sender_name: str = '',
+             cc: str = None,
+             bcc: str = None,
              no_reply: str = None,
              subject: str = None,
              message: str = None,
              image: str = None,
              audio: str = None,
              file: str = None) -> None:
         """
+        :param receiver_name: Set recipient name
+        :param sender_name: Set sender name
         :param no_reply: Set no-reply email
         :param cc: Email Address as String or List. (Carbon Copy)
         :param bcc: Email Address as String or List. (Blind Carbon Copy)
@@ -111,8 +118,10 @@ def send(self,
         send_info: List = []
         multi_info: Dict = {}
 
-        self.__prepare_message(receiver=receiver, cc=cc,
-                               bcc=bcc, subject=subject,
+        self.__prepare_message(receiver=receiver,
+                               receiver_name=receiver_name,
+                               sender_name=sender_name,
+                               cc=cc, bcc=bcc, subject=subject,
                                message=message, no_reply=no_reply)
 
         self.__prepare_attachments(image=image,

quick_mailer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quick-mailer
-Version: 2022.2.10
+Version: 2022.2.22
 Summary: This Module help you to send fast Email.🌸
 Home-page: https://github.com/Al-Taie/quick-mailer
 Author: Ahmed Al-Taie
@@ -35,7 +35,7 @@ pip install quick-mailer
 ```
 
 [//]: # (**[-->> pypi Link](https://pypi.org/project/quick-mailer)**)
-
+[//]: # ()
 **[-->> GitHub Link](https://github.com/Al-Taie/quick-mailer)**
 
 # Usage:
@@ -56,9 +56,11 @@ mail.send(receiver='someone@example.com',  # Email From Any service Provider
 
 **Parameters**
 ```py
-receiver: Email Address as String or List.                [Recuired]
+receiver: Email Address as String or List.                [Required]
 cc: Email Address as String or List.  (Carbon Copy)       [Optional]
 bcc: Email Address as String or List. (Blind Carbon Copy) [Optional]
+sender_name: Set Sender name.                             [Optional]
+receiver_name: Set receiver name.                         [Optional]
 no_reply: Set Another Email To Reply                      [Optional]
 subject: Message Title.                                   [Optional]
 message: Your Message.                                    [Optional]
@@ -149,6 +151,7 @@ mail.about()
 ```
 
 #### Changelogs
+
 > > 2022.2.10 update:
 > - Fix issue #3 TypeError on python < 3.10