Metadata-Version: 2.1
Name: SES-Mailer-3
Version: 0.15.4
Summary: A simple module to send email via AWS SES
Home-page: https://github.com/tclark/ses-mailer
Author: Tom Clark
Author-email: tclark@requisitesystems.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/tclark/ses-mailer/issues
Description: # SES Mailer 3
        This is a fork of a fork, since the other projects haven't been updated.
        This version uses boto3 rather than the out-of-date boto module.
        
        A simple module to send email via AWS SES 
        
        You can use it as standalone or with Flask
        
        Requirements:
        
        - AWS Credentials
        - boto3
        - Jinja
        
        ---
        
        ## Install
        
            pip install ses-mailer-3
        
        ## Usage
        
        ### Setup
        
            from ses_mailer import Mail
        
            mail = Mail(aws_access_key_id="####",
                        aws_secret_access_key="####",
                        region="us-east-1",
                        sender="me@myemail.com",
                        reply_to="me@email.com",
                        template="./email-templates")
        
        Alternatively, if you want to use `botocore`'s default credentials lookup scheme,
        you can pass `aws_boto_auth_lookup=True` instead of providing keys.
                         
        #### Send Basic Email
        
            mail.send(to="you@email.com",
                      subject="My Email subject",
                      body="My message body")
                      
        #### Send Template Email
        
            mail.send_template(template="welcome.txt", 
                               to="you@email.com", 
                               name="Ricky Roze", 
                               user_id=12739)
             
        
        ##API
        
        **Mail.\__init__**
        
        	- aws_access_key_id
        	- aws_secret_access_key
        	- sender
        	- reply_to
        	- template
        	
        **Mail.send**
        
        	- to
        	- subject
        	- body
        	- reply_to
        		
        **Mail.send_template**
        
        	- template
        	- to
        	- reply_to
        	- **context	
             
             
        ### Initiate with Flask
        
            from flask import Flask
            from ses_mailer import Mail
        
            app = Flask(__name__)
        
            mail = Mail()
            mail.init_app(app)
        
        
        ## Templates
        
        You can use pre-made templates to send email
        
        The template must be a Jinja template, containing at least the following blocks:
        
            - subject
            - body
            
        
        welcome.txt
        
            {% block subject %}
                Welcome {{name}} to our site 
            {% endblock %}
        
            {% block body %}
                Dear {{name}} this is the content of the message 
                
                Thank you very much for your visiting us
            {% endblock %}
        
        
        ### File Templates:
        
        Place you template files inside of a directory, let's say: `email-templates`
        
        Inside of `email-templates` we have the following files:
        
            /email-templates
                |
                |_ welcome.txt
                |
                |_ lost-password.txt
                
                
            mail = Mail(aws_access_key_id="####",
                         aws_secret_access_key="####",
                         sender="me@myemail.com",
                         reply_to="me@email.com",
                         template="./email-templates")
        
        ### Dictionary based templates
        
        If you don't want to create files, you can dictionary based templates
        
            templates = {
                "welcome.txt": """
                    {% block subject %}I'm subject{% endblock %}
                    {% block body %}How are you {{name}}?{% endblock %}
                """,
                "lost-password.txt": """
                    {% block subject %}Lost Password{% endblock %}
                    {% block body %}Hello {{ name }}. 
                    Here's your new password: {{ new_password }} 
                    {% endblock %}
                """,    
            }
            
            mail = Mail(aws_access_key_id="####",
                         aws_secret_access_key="####",
                         sender="me@myemail.com",
                         reply_to="me@email.com",
                         template=templates)
        
        To send the email for either files or dictionary based templates:
            
            new_password = "mynewpassword"
            mail.send_template("lost-password.txt", to="x@y.com", name="Lolo", new_password=new_password)
        
        ### Config For Flask
        
        SES-Mailer is configured through the standard Flask config API.
        These are the available options:
        
        **SES_AWS_ACCESS_KEY** : Your AWS access key id
        
        **SES_AWS_SECRET_KEY**: Your AWS secred key
        
        **SES_REGION**: AWS region of the SES
        
        **SES_AWS_BOTO_LOOKUP**: Flag asking to use Boto's default credentials lookup scheme
        
        **SES_SENDER**: The sender email address as string.
        
        **SES_REPLY_TO**: The reply to address
        
        **SES_TEMPLATE**: (mixed) directory or dict of template to use as template
        
        **SES_TEMPLATE_CONTEXT**: A dict of template data to be passed by default
        
            SES_AWS_ACCESS_KEY = ""
            SES_AWS_SECRET_KEY = ""
            SES_REGION = ""
            SES_AWS_BOTO_LOOKUP = False
            SES_SENDER = ""
            SES_REPLY_TO = ""
            SES_TEMPLATE = None
            SES_TEMPLATE_CONTEXT = {}
        
        
        ---
        
        (c) 2015 Mardix
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7
Description-Content-Type: text/markdown
