Qmail


NameQmail JSON
Version 0.0.1 PyPI version JSON
download
home_page
SummarySending Mails Made Easy
upload_time2023-09-02 20:37:33
maintainer
docs_urlNone
authorAkmal Riyas
requires_python
license
keywords python mail email easymail gmail send_mail otp passwordgen
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
![Qmail](https://document-export.canva.com/VriQM/DAFtJZVriQM/6/thumbnail/0001.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYCGKMUHWDTJW6UD%2F20230902%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230902T025303Z&X-Amz-Expires=63287&X-Amz-Signature=bc0fc9df17ebc416eefb9d9a7af03ebc65fff9eed1030d5e9f4c0fa00227a1d5&X-Amz-SignedHeaders=host&response-expires=Sat%2C%2002%20Sep%202023%2020%3A27%3A50%20GMT)



###



## In this documentation πŸ‘‡



- #### [Features](#features)

- #### [Usage](#usage)

  - ##### [Install Qmail](#installation)

  - ##### [SMTP](#smtp)

  - ##### [Qmail MSG Class](#qmail-msg-class)

  - ##### [Qmail HTML MSG Class](#qmail-html-msg-class)

  - ##### [Qmail OTP](#qmail-otp-services)

 

- #### [Authors](#authors)

- #### [Modules Used](#modules-used)



###



## Features



Qmail makes sending emails Quick and easy:



#### πŸ“¨ Email Smtp:

  - Supports all email providers supported with Python. (Defaulted at  smtp.gmail.com)

  - Email Spam Bot 

  - HTML, PLAIN, Attachments

  



#### πŸ”‘ OTP Services:

  - OTP Msg class used with Email Smtp

  - OTP Generator (Alpha Numerical & Numerical)

  - 3 HTML Themes

 

####  πŸ‘€ Email Addr That Anyone Can Use:

  - Qmail uses emailsender437@gmail.com as a default account if you don't enter your own email.

  - Perfect for testing





###



## USAGE



### Installation



1. Python 3.8 or newer environment recommended





2.  Install Qmail



    *Open up terminal and type*



    ```

    pip install Qmail

    ```

    *For mac*



    ```

    pip3 install Qmail

    ```







### SMTP



##### Create Qmail Smtp class.

#

1. import the Qmail library

    ```python

    import Qmail

    ```



2.  Create Qmail Class



    ```python

    sender = Qmail.SMTP(\

        EMAIL='yourmail@yourdomain.com', # Default: emailsender437@gmail.com

    

        PASSWORD= 'Your App Password', # Default: emailsender437 pass

        

        smtp= "smtp.domain.com", # Ex: smtp.gmail.com, Default : smtp.gmail.com

    

        reciever_emails= ["Mail To send1", "Mail To Send2", 'etc.'],  # Emails that will be receiving mail.

    

        port='port to send email in', # Optional

    

        cc='cc email address', # Give this value if cc is needed in the email

    

        bcc= 'bcc email address', # Give this value if bcc is needed in the email

    )  

    

    ```

    

    #### SMTP Class Parameters In DetailπŸ‘‡

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### EMAIL

    #####

    Your Email Goes Here

    Strings Are Only Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### PASSWORD

    #####

    The app password of the email you gave in EMAIL parameter.

    Strings __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### smtp

    #####

    The SMTP server of your email's domain

    Ex: smtp.gmail.com for  __gmail.com__ domain

   Strings __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### reciever_emails

    #####

    Emails of the people your sending to goes here

    Ex: ['email1@gmail.com', 'email2@outlook.com', 'email3@yahoo.com']

    Lists accepted __ONLY__

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### port *|Optional|*

    #####

    The Port Number goes here (for SSL connections)

    Default: 465

    3 Digit Integers __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### cc *|Add this value if you want an email to be sent as CC|*

    #####

    CC Email goes here

    Strings __ONLY__ accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### bcc *|Add this value if you want an email to be sent as BCC|*

    #####

    BCC Email goes here

    Strings __ONLY__ accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ###

    #### More Creation Examples

    ```python

    import Qmail

    

    sender = Qmail.SMTP(reciever_emails= ['email1@gmail.com']) # Create a default Qmail smtp server 



    sender2 = Qmail.SMTP(\

        EMAIL='Your Mail Goes Here', 

        PASSWORD= "Your EMAIL'S app password goes here.", 

        reciever_emails=['receicermail@yourdomain.com'], 

        smtp= 'Your Emails Smtp Server

    

    ) # Create a Qmail smtp server with your email. 



    ```

###



##### Send Emails

#####

1. Invoke the send_mail function on Qmail SMTP class

    ```python

    import Qmail

    

    sender = Qmail.SMTP('parameters πŸ‘†')

    

    # To send

    sender.send_mail(message= 'Any Qmail MSG Class. (OTP, MSG, HTML_MSG)' )

    ```



2. Qmail Smtp class spammer

    ```python

    import Qmail

    

    sender = Qmail.SMTP('parameters πŸ‘†')

    

    # To Spam

    sender.spam_mail(message= 'Any Qmail MSG Class. (OTP, MSG, HTML_MSG)', num = 10 )

    # num= ammount of mails to send (Integer ONLY)

    ```

    



###

### Qmail Msg Class



##### Create Qmail MSG Class

####

1. import the Qmail library

    ```python

    import Qmail

    ```



2.  Create Qmail MSG Class



    ```python

    

    message = Qmail.MSG(\

        subject= 'Subject Of Email',

        txt= 'txt in the email',

        attachments=['file1', 'file2'] # Add Attachment Filepaths here 

    )

    

    ```

    

    #### Qmail MSG class Parameters In DetailπŸ‘‡

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### subject

    #####

    subject of the email goes here

    Strings Are Only Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### txt

    #####

    What you want to include in your email goes here

    Strings __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### attachments

    #####

    Put filenames here if you want to add them into the email.

   Strings __ONLY__ Accepted for 1 file, Lists __ONLY__ Accepted for mutiple

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### Once you create this you can add it to the send_mail and spam_mail functions.





###



### Qmail Html Msg Class

##### Create Qmail HTML MSG Class

####



1. import the Qmail library

    ```python

    import Qmail

    ```



2.  Create Qmail HTML_MSG Class



    ```python

    

    message = Qmail.HTML_MSG(\

        subject= 'Subject Of Email',

        html= '<h1>Enter Html Here</h1>',

        attachments=['file1', 'file2'] # Add Attachment Filepaths here 

    )

    

    ```

    

    #### Qmail HTML MSG class Parameters In DetailπŸ‘‡

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### subject

    #####

    the subject of the email goes here

    Strings Are Only Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### html

    #####

    Html goes here

    Strings __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### attachments

    #####

    Put filenames here if you want to add them to the email.

   Strings __ONLY__ Accepted for 1 file, Lists __ONLY__ Accepted for mutiple

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### Once you create this you can add it to the send_mail and spam_mail functions.



###

### Qmail Otp Services

##### Generate OTP

####



1. import the Qmail.OTP library

    ```python

    from Qmail import OTP

    ```



2.  generate OTP function



    ```python

    

    otp = OTP.generateOTP(lenght=4, type='numeric')

    # generateOTP returns OTP as string

    

    #### Types ####

    ## numeric

    # ex: 198745

    

    ## alphanumeric

    # ex: YRjliMZLx4 

    ```

    

    #### generateOTP() Parameters In DetailπŸ‘‡

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### lenght

    #####

    Lenght of OTP goes here

    Integers Are __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### type

    #####

    OTP type:  numeric or alphanumeric

    Strings __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

##### Create OTP MSG Class

####



1. import the Qmail.OTP library

    ```python

    from Qmail import OTP

    ```



2.  Create Qmail OTP_EMAIL Class



    ```python

    

    from Qmail import OTP

    

    one_time_password = OTP.generateOTP(lenght=10, type='alphanumeric')

    NAME = 'Qmail'

    themes_available = ['simple', 'default', 'modern']



    message = OTP.OTP_EMAIL(subject='OTP MAIl', otp=one_time_password, brand_name=NAME, theme='default')

    

    ```

    

    #### Qmail HTML MSG class Parameters In DetailπŸ‘‡

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### subject

    #####

    the subject of the email goes here

    Strings Are __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### otp

    #####

    OTP goes here

    Strings __ONLY__ Accepted

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### brand_name

    #####

    your companies name or project name goes here.

    Strings __ONLY__ Accepted 

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### theme

    #####

    choose one of the 3 themes

    default, simple, modern

    Strings __ONLY__ Accepted 

    ###### βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–βž–

    

    ##### Once you create this you can add it to the send_mail and spam_mail functions.



###

## Authors



##### Akmal Riyas



## Modules Used

##### - email

##### - smtplib

##### - ssl

##### - random

##### - math

##### - Qmail



####

## Thanks For Using My Module

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Qmail",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python,mail,email,easymail,gmail,send_mail,otp,passwordgen",
    "author": "Akmal Riyas",
    "author_email": "akmalriyas@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ba/70/c1021b4fe10e04ab53222a938365bbf99712a283e6d1f7884eecd95a1b5d/Qmail-0.0.1.tar.gz",
    "platform": null,
    "description": "\r\n![Qmail](https://document-export.canva.com/VriQM/DAFtJZVriQM/6/thumbnail/0001.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQYCGKMUHWDTJW6UD%2F20230902%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230902T025303Z&X-Amz-Expires=63287&X-Amz-Signature=bc0fc9df17ebc416eefb9d9a7af03ebc65fff9eed1030d5e9f4c0fa00227a1d5&X-Amz-SignedHeaders=host&response-expires=Sat%2C%2002%20Sep%202023%2020%3A27%3A50%20GMT)\r\r\n\r\r\n###\r\r\n\r\r\n## In this documentation \ud83d\udc47\r\r\n\r\r\n- #### [Features](#features)\r\r\n- #### [Usage](#usage)\r\r\n  - ##### [Install Qmail](#installation)\r\r\n  - ##### [SMTP](#smtp)\r\r\n  - ##### [Qmail MSG Class](#qmail-msg-class)\r\r\n  - ##### [Qmail HTML MSG Class](#qmail-html-msg-class)\r\r\n  - ##### [Qmail OTP](#qmail-otp-services)\r\r\n \r\r\n- #### [Authors](#authors)\r\r\n- #### [Modules Used](#modules-used)\r\r\n\r\r\n###\r\r\n\r\r\n## Features\r\r\n\r\r\nQmail makes sending emails Quick and easy:\r\r\n\r\r\n#### \ud83d\udce8 Email Smtp:\r\r\n  - Supports all email providers supported with Python. (Defaulted at  smtp.gmail.com)\r\r\n  - Email Spam Bot \r\r\n  - HTML, PLAIN, Attachments\r\r\n  \r\r\n\r\r\n#### \ud83d\udd11 OTP Services:\r\r\n  - OTP Msg class used with Email Smtp\r\r\n  - OTP Generator (Alpha Numerical & Numerical)\r\r\n  - 3 HTML Themes\r\r\n \r\r\n####  \ud83d\udc64 Email Addr That Anyone Can Use:\r\r\n  - Qmail uses emailsender437@gmail.com as a default account if you don't enter your own email.\r\r\n  - Perfect for testing\r\r\n\r\r\n\r\r\n###\r\r\n\r\r\n## USAGE\r\r\n\r\r\n### Installation\r\r\n\r\r\n1. Python 3.8 or newer environment recommended\r\r\n\r\r\n\r\r\n2.  Install Qmail\r\r\n\r\r\n    *Open up terminal and type*\r\r\n\r\r\n    ```\r\r\n    pip install Qmail\r\r\n    ```\r\r\n    *For mac*\r\r\n\r\r\n    ```\r\r\n    pip3 install Qmail\r\r\n    ```\r\r\n\r\r\n\r\r\n\r\r\n### SMTP\r\r\n\r\r\n##### Create Qmail Smtp class.\r\r\n#\r\r\n1. import the Qmail library\r\r\n    ```python\r\r\n    import Qmail\r\r\n    ```\r\r\n\r\r\n2.  Create Qmail Class\r\r\n\r\r\n    ```python\r\r\n    sender = Qmail.SMTP(\\\r\r\n        EMAIL='yourmail@yourdomain.com', # Default: emailsender437@gmail.com\r\r\n    \r\r\n        PASSWORD= 'Your App Password', # Default: emailsender437 pass\r\r\n        \r\r\n        smtp= \"smtp.domain.com\", # Ex: smtp.gmail.com, Default : smtp.gmail.com\r\r\n    \r\r\n        reciever_emails= [\"Mail To send1\", \"Mail To Send2\", 'etc.'],  # Emails that will be receiving mail.\r\r\n    \r\r\n        port='port to send email in', # Optional\r\r\n    \r\r\n        cc='cc email address', # Give this value if cc is needed in the email\r\r\n    \r\r\n        bcc= 'bcc email address', # Give this value if bcc is needed in the email\r\r\n    )  \r\r\n    \r\r\n    ```\r\r\n    \r\r\n    #### SMTP Class Parameters In Detail\ud83d\udc47\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### EMAIL\r\r\n    #####\r\r\n    Your Email Goes Here\r\r\n    Strings Are Only Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### PASSWORD\r\r\n    #####\r\r\n    The app password of the email you gave in EMAIL parameter.\r\r\n    Strings __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### smtp\r\r\n    #####\r\r\n    The SMTP server of your email's domain\r\r\n    Ex: smtp.gmail.com for  __gmail.com__ domain\r\r\n   Strings __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### reciever_emails\r\r\n    #####\r\r\n    Emails of the people your sending to goes here\r\r\n    Ex: ['email1@gmail.com', 'email2@outlook.com', 'email3@yahoo.com']\r\r\n    Lists accepted __ONLY__\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### port *|Optional|*\r\r\n    #####\r\r\n    The Port Number goes here (for SSL connections)\r\r\n    Default: 465\r\r\n    3 Digit Integers __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### cc *|Add this value if you want an email to be sent as CC|*\r\r\n    #####\r\r\n    CC Email goes here\r\r\n    Strings __ONLY__ accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### bcc *|Add this value if you want an email to be sent as BCC|*\r\r\n    #####\r\r\n    BCC Email goes here\r\r\n    Strings __ONLY__ accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ###\r\r\n    #### More Creation Examples\r\r\n    ```python\r\r\n    import Qmail\r\r\n    \r\r\n    sender = Qmail.SMTP(reciever_emails= ['email1@gmail.com']) # Create a default Qmail smtp server \r\r\n\r\r\n    sender2 = Qmail.SMTP(\\\r\r\n        EMAIL='Your Mail Goes Here', \r\r\n        PASSWORD= \"Your EMAIL'S app password goes here.\", \r\r\n        reciever_emails=['receicermail@yourdomain.com'], \r\r\n        smtp= 'Your Emails Smtp Server\r\r\n    \r\r\n    ) # Create a Qmail smtp server with your email. \r\r\n\r\r\n    ```\r\r\n###\r\r\n\r\r\n##### Send Emails\r\r\n#####\r\r\n1. Invoke the send_mail function on Qmail SMTP class\r\r\n    ```python\r\r\n    import Qmail\r\r\n    \r\r\n    sender = Qmail.SMTP('parameters \ud83d\udc46')\r\r\n    \r\r\n    # To send\r\r\n    sender.send_mail(message= 'Any Qmail MSG Class. (OTP, MSG, HTML_MSG)' )\r\r\n    ```\r\r\n\r\r\n2. Qmail Smtp class spammer\r\r\n    ```python\r\r\n    import Qmail\r\r\n    \r\r\n    sender = Qmail.SMTP('parameters \ud83d\udc46')\r\r\n    \r\r\n    # To Spam\r\r\n    sender.spam_mail(message= 'Any Qmail MSG Class. (OTP, MSG, HTML_MSG)', num = 10 )\r\r\n    # num= ammount of mails to send (Integer ONLY)\r\r\n    ```\r\r\n    \r\r\n\r\r\n###\r\r\n### Qmail Msg Class\r\r\n\r\r\n##### Create Qmail MSG Class\r\r\n####\r\r\n1. import the Qmail library\r\r\n    ```python\r\r\n    import Qmail\r\r\n    ```\r\r\n\r\r\n2.  Create Qmail MSG Class\r\r\n\r\r\n    ```python\r\r\n    \r\r\n    message = Qmail.MSG(\\\r\r\n        subject= 'Subject Of Email',\r\r\n        txt= 'txt in the email',\r\r\n        attachments=['file1', 'file2'] # Add Attachment Filepaths here \r\r\n    )\r\r\n    \r\r\n    ```\r\r\n    \r\r\n    #### Qmail MSG class Parameters In Detail\ud83d\udc47\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### subject\r\r\n    #####\r\r\n    subject of the email goes here\r\r\n    Strings Are Only Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### txt\r\r\n    #####\r\r\n    What you want to include in your email goes here\r\r\n    Strings __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### attachments\r\r\n    #####\r\r\n    Put filenames here if you want to add them into the email.\r\r\n   Strings __ONLY__ Accepted for 1 file, Lists __ONLY__ Accepted for mutiple\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### Once you create this you can add it to the send_mail and spam_mail functions.\r\r\n\r\r\n\r\r\n###\r\r\n\r\r\n### Qmail Html Msg Class\r\r\n##### Create Qmail HTML MSG Class\r\r\n####\r\r\n\r\r\n1. import the Qmail library\r\r\n    ```python\r\r\n    import Qmail\r\r\n    ```\r\r\n\r\r\n2.  Create Qmail HTML_MSG Class\r\r\n\r\r\n    ```python\r\r\n    \r\r\n    message = Qmail.HTML_MSG(\\\r\r\n        subject= 'Subject Of Email',\r\r\n        html= '<h1>Enter Html Here</h1>',\r\r\n        attachments=['file1', 'file2'] # Add Attachment Filepaths here \r\r\n    )\r\r\n    \r\r\n    ```\r\r\n    \r\r\n    #### Qmail HTML MSG class Parameters In Detail\ud83d\udc47\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### subject\r\r\n    #####\r\r\n    the subject of the email goes here\r\r\n    Strings Are Only Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### html\r\r\n    #####\r\r\n    Html goes here\r\r\n    Strings __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### attachments\r\r\n    #####\r\r\n    Put filenames here if you want to add them to the email.\r\r\n   Strings __ONLY__ Accepted for 1 file, Lists __ONLY__ Accepted for mutiple\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### Once you create this you can add it to the send_mail and spam_mail functions.\r\r\n\r\r\n###\r\r\n### Qmail Otp Services\r\r\n##### Generate OTP\r\r\n####\r\r\n\r\r\n1. import the Qmail.OTP library\r\r\n    ```python\r\r\n    from Qmail import OTP\r\r\n    ```\r\r\n\r\r\n2.  generate OTP function\r\r\n\r\r\n    ```python\r\r\n    \r\r\n    otp = OTP.generateOTP(lenght=4, type='numeric')\r\r\n    # generateOTP returns OTP as string\r\r\n    \r\r\n    #### Types ####\r\r\n    ## numeric\r\r\n    # ex: 198745\r\r\n    \r\r\n    ## alphanumeric\r\r\n    # ex: YRjliMZLx4 \r\r\n    ```\r\r\n    \r\r\n    #### generateOTP() Parameters In Detail\ud83d\udc47\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### lenght\r\r\n    #####\r\r\n    Lenght of OTP goes here\r\r\n    Integers Are __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### type\r\r\n    #####\r\r\n    OTP type:  numeric or alphanumeric\r\r\n    Strings __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n##### Create OTP MSG Class\r\r\n####\r\r\n\r\r\n1. import the Qmail.OTP library\r\r\n    ```python\r\r\n    from Qmail import OTP\r\r\n    ```\r\r\n\r\r\n2.  Create Qmail OTP_EMAIL Class\r\r\n\r\r\n    ```python\r\r\n    \r\r\n    from Qmail import OTP\r\r\n    \r\r\n    one_time_password = OTP.generateOTP(lenght=10, type='alphanumeric')\r\r\n    NAME = 'Qmail'\r\r\n    themes_available = ['simple', 'default', 'modern']\r\r\n\r\r\n    message = OTP.OTP_EMAIL(subject='OTP MAIl', otp=one_time_password, brand_name=NAME, theme='default')\r\r\n    \r\r\n    ```\r\r\n    \r\r\n    #### Qmail HTML MSG class Parameters In Detail\ud83d\udc47\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### subject\r\r\n    #####\r\r\n    the subject of the email goes here\r\r\n    Strings Are __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### otp\r\r\n    #####\r\r\n    OTP goes here\r\r\n    Strings __ONLY__ Accepted\r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### brand_name\r\r\n    #####\r\r\n    your companies name or project name goes here.\r\r\n    Strings __ONLY__ Accepted \r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### theme\r\r\n    #####\r\r\n    choose one of the 3 themes\r\r\n    default, simple, modern\r\r\n    Strings __ONLY__ Accepted \r\r\n    ###### \u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\u2796\r\r\n    \r\r\n    ##### Once you create this you can add it to the send_mail and spam_mail functions.\r\r\n\r\r\n###\r\r\n## Authors\r\r\n\r\r\n##### Akmal Riyas\r\r\n\r\r\n## Modules Used\r\r\n##### - email\r\r\n##### - smtplib\r\r\n##### - ssl\r\r\n##### - random\r\r\n##### - math\r\r\n##### - Qmail\r\r\n\r\r\n####\r\r\n## Thanks For Using My Module\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Sending Mails Made Easy",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [
        "python",
        "mail",
        "email",
        "easymail",
        "gmail",
        "send_mail",
        "otp",
        "passwordgen"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba70c1021b4fe10e04ab53222a938365bbf99712a283e6d1f7884eecd95a1b5d",
                "md5": "0c81aeaae099b616c9d390c8f7c01bce",
                "sha256": "7f350800a58ad32a6b169a369fef61f5a61b84cd3c1fa70374af3c44a59b1bd9"
            },
            "downloads": -1,
            "filename": "Qmail-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0c81aeaae099b616c9d390c8f7c01bce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12018,
            "upload_time": "2023-09-02T20:37:33",
            "upload_time_iso_8601": "2023-09-02T20:37:33.377652Z",
            "url": "https://files.pythonhosted.org/packages/ba/70/c1021b4fe10e04ab53222a938365bbf99712a283e6d1f7884eecd95a1b5d/Qmail-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-02 20:37:33",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "qmail"
}
        
Elapsed time: 0.26069s