Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History
 
 

email_sender

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
__init__.py
__init__.py
 
 
email_sender.py
email_sender.py
 
 

README.md

EmailSender

EmailSender a command line script and module to sending email. Using either as a command line script or importing as a module in another python script/program

When using EmailSender you can send an email to any recipient using a local or remote SMTP server including authentication. Please consider security for your local system when using.

Requirements

  • Python 3

Usage as a command line script

The command line script has a number of options, some of which are required and some which are not.

usage: email_sender.py [-h] [--subject SUBJECT] [--from_email FROM_EMAIL] [--to_email TO_EMAIL] [--message MESSAGE]
              [--host HOST] [--port PORT] [--starttls] [--ssl] [--username USERNAME] [--password PASSWORD]

EmailSender

optional arguments:
  -h, --help            show this help message and exit
  --subject SUBJECT     Subject to use in the Email message
  --from_email FROM_EMAIL
                        Email address to use as the from address.
  --to_email TO_EMAIL   Email address to used to send emails too.
  --msg MESSAGE     Email message
  --host HOST           SMTP Host
  --port PORT           SMTP Port
  --username USERNAME   SMTP username
  --password PASSWORD   SMTP password

When running as a command line script we have two sets of options, options for SMTP/Authentication and then the email message options.

Examples

  • Sending an email to a local SMTP server without any authentication
python email_sender.py --subject "Test Email" --from_email sam@example.com --to_email tom@example.com
  • Sending an email using Gmail

You can specify the smtp host/port along with the username/password if required by the smtp server.

python app.py --subject test-sunday-1 --from_email sam@gmail.com --to_email tom@gmail.com --host smtp.gmail.com --port 587 --username sam@gmail.com --password PASSWORD

Usage as a Module

You can use this in your own code

from email_sender.email_sender import EmailSender

# setup the object
email_sender = EmailSender()

# send an email
email_sender.send_email(subject="Test Email",
                        from_email=sam@example.com,
                        to_email=tom@example.com,
                        msg="This is a test email")