Metadata-Version: 2.1
Name: sremail
Version: 1.0.0
Summary: Python package to make it easier to handle email.
Home-page: https://github.com/glasswall-sre/sremail
Author: Sam Gibson
Author-email: sgibson@glasswallsolutions.com
License: UNKNOWN
Description: # sremail
        
        'SRE Mail' is a Python package designed to make sending email in MIME 
        format a lot easier.
        
        ## Basic usage
        
        ```python
        from datetime import datetime
        
        from sremail import message, smtp
        
        msg = message.Message(to=["Sam Gibson <sgibson@glasswallsolutions.com>", "a@b.com"],
                              from_addresses=["another@email.com"],
                              date=datetime.now(),
                              another_header="test")
                     .attach("attachment.pdf")
        
        smtp.send(msg, "smtp.some_server.com:25")
        ```
        
        ## Gotchas
        - You can't add the `X-FileTrust-Tenant` header to a `Message` with a kwarg, as there's no way to format it in a general way due to the capitalised 'T' in 'Trust'. To get around this you have to add the header manually:
            ```python
            msg = message.Message(to=["Sam Gibson <sgibson@glasswallsolutions.com>", "a@b.com"],
                              from_addresses=["another@email.com"],
                              date=datetime.now())
            msg.headers["X-FileTrust-Tenant"] = "<guid>"
            ```
        
        ## Development
        
        ### Prerequisites
        - Python 3.6+
        - Pipenv
        
        ### Quick start
        1. Clone this repo.
        2. Run `pipenv sync --dev`.
        3. You're good to go. You can run commands using the package inside a
           `pipenv shell`, and modify the code with your IDE.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.6
Description-Content-Type: text/markdown
