Metadata-Version: 2.1
Name: gmail-connector
Version: 0.2.3
Summary: Python module to, send SMS, emails and read unread emails.
Home-page: https://github.com/thevickypedia/gmail-connector
Author: Vignesh Sivanandha Rao
Author-email: svignesh1793@gmail.com
License: UNKNOWN
Description: [![Pypi-version](https://img.shields.io/pypi/v/gmail-connector)](https://pypi.org/project/gmail-connector)
        [![Pypi-py-version](https://img.shields.io/pypi/pyversions/gmail-connector)](https://pypi.org/project/gmail-connector)
        
        ![docs](https://github.com/thevickypedia/gmail-connector/actions/workflows/docs.yml/badge.svg)
        ![pypi](https://github.com/thevickypedia/gmail-connector/actions/workflows/python-publish.yml/badge.svg)
        
        [![Pypi-format](https://img.shields.io/pypi/format/gmail-connector)](https://pypi.org/project/gmail-connector/#files)
        [![Pypi-status](https://img.shields.io/pypi/status/gmail-connector)](https://pypi.org/project/gmail-connector)
        
        ![Maintained](https://img.shields.io/maintenance/yes/2021)
        [![GitHub Repo created](https://img.shields.io/date/1599432310)](https://api.github.com/repos/thevickypedia/gmail-connector)
        [![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/gmail-connector)](https://api.github.com/repos/thevickypedia/gmail-connector)
        [![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/gmail-connector)](https://api.github.com/repos/thevickypedia/gmail-connector)
        
        # Gmail Connector
        Python module to, send SMS, emails and read `unread` emails in `inbox` folder.
        
        ###### Uses the default python modules:
        - `email` - Format emails as `MIMEMultipart` object, read emails from `bytes` and `str` and decode headers.
        - `smtplib` - `SMTP` Simple Mail Transfer Protocol to connect to `gmail` server, do `auth` and perform outgoing tasks.
        - `imaplib` - `IMAP` Internet Message Access Protocol to access messages in an email mailbox.
        - `datetime` - Uses `datetime` module to skim the date and time when the email arrived.
        
        ## Pypi Module
        https://pypi.org/project/gmail-connector/
        
        ### Usage
        `pip install gmail-connector`
        
        <br>
        
        [Send SMS](https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_sms.py)
        ```python
        from gmailconnector.send_sms import Messenger
        
        messenger = Messenger(
            gmail_user='username@gmail.com',
            gmail_pass='<ACCOUNT_PASSWORD>',
            phone_number='+11234567890',
            message='Test SMS using gmail-connector'
        )
        print(messenger.send_sms())
        ```
        
        [Send Email](https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_email.py)
        ```python
        from gmailconnector.send_email import SendEmail
        
        email_obj = SendEmail(
                gmail_user='username@gmail.com',
                gmail_pass='<ACCOUNT_PASSWORD>',
                recipient='another_username@gmail.com',
                subject='Howdy!'
            )
        print(email_obj.send_email())
        ```
        <details>
        <summary><strong>More on <a href="https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/send_email.py">SendEmail</a></strong></summary>
        
        ###### Additional args:
        - **body:** Body of the email. Defaults to blank.
        - **attachment:** Filename that has to be attached.
        - **cc:** Email address of the recipient to whom the email has to be CC'd.
        - **bcc:** Email address of the recipient to whom the email has to be BCC'd.
        
        > Note: To send email to more than one recipient, wrap `recipient`/`cc`/`bcc` in a list.
        >
        > `recipient=['username1@gmail.com', 'username2@gmail.com']`
        </details>
        
        [Read Email](https://github.com/thevickypedia/gmail-connector/blob/master/gmailconnector/read_email.py)
        ```python
        from gmailconnector.read_email import ReadEmail
        
        ReadEmail(
            gmail_user='username@gmail.com',
            gmail_pass='<ACCOUNT_PASSWORD>'
        ).read_email()
        ```
        
        ### Pre-Commit
        Install `pre-commit` to run `flake8` and `isort` for linting and `sphinx` for documentation generator.
        
        `pip3 install pre-commit==2.13.0 Sphinx==4.1.1`
        
        `pre-commit run --all-files`
        
        ### Runbook
        https://thevickypedia.github.io/gmail-connector/
        
        ## License & copyright
        
        &copy; Vignesh Sivanandha Rao, Gmail Connector
        
        Licensed under the [MIT License](https://github.com/thevickypedia/gmail-connector/blob/master/LICENSE)
        
        
        Change Log
        ==========
        
        0.0.14 (07/18/2021)
        -------------------
        - Delete broken releases
        - Modify and update CHANGELOG
        - Change URL for HomePage
        
        0.0.15 (07/18/2021)
        -------------------
        - Update project description and README.md
        
        0.0.16 (07/19/2021)
        -------------------
        - Add module usage in description
        - Fix broken hyperlinks in README.md
        - Setup github actions for pypi publish
        
        0.0.17 (07/19/2021)
        -------------------
        - Bump version.
        - Supports github action to auto upload to pypi.
        
        0.0.18 (07/19/2021)
        -------------------
        - Add logger module.
        - Remove print statements.
        
        0.1.9 (07/19/2021)
        ------------------
        - Allow users to add multiple recipients while sending email.
        - Add CC and BCC options.
        - Check if attachment file is available before trying to attach.
        - Wrap recipient, cc and bcc items in a single list before email kick off.
        - Remove sender arg and default to the user login email address.
        - Fix version number format.
        
        0.2.0 (07/22/2021)
        ------------------
        - Return a dictionary element after sending an email/SMS.
        - Add status code and description to return dict.
        - Update docs and CHANGELOG
        - Bump version.
        
        0.2.1 (07/24/2021)
        ------------------
        - Remove logger module.
        - Add exception handlers for Messenger class.
        - Update docs and CHANGELOG
        - Bump version.
        
        0.2.2 (08/02/2021)
        ------------------
        - Fix incorrect HTTP return codes
        
        0.2.3 (08/11/2021)
        ------------------
        - Add new lines to the message start to separate subject and body of the SMS
        - Update sphinx documentation to 4.1.2
Keywords: gmail,smtp,imap,tls
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Operating System :: MacOS :: MacOS X
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Communications :: Email :: Post-Office :: IMAP
Description-Content-Type: text/markdown; charset=UTF-8
