Quickstart with pyautomail

This guide will help you get up and running with pyautomail Python package in no time.

Important

If you are not a Python developer, don’t worry! You don’t need to write any Python code to use pyautomail. You can use the command-line interface (CLI) tool to send emails without writing any code. Please refer to the pyautomail command-line interface (CLI) tool

If you are new to the command line, you can check out this tutorial.

Important

Additionally a graphical user interface will be provided in the future.

Note

If you are new to Python, you can check out the official Python tutorial here.

Before you begin, make sure you have Python installed on your system, preferably Python 3.9 or higher.

Installation

To install pyautomail, you can use pip to install the package directly from PyPI:

$ pip install pyautomail

Or you can use pip and git to install the latest version directly from GitHub:

$ pip install git+https://github.com/msinamsina/pyautomail.git

This will download and install the latest version of automail along with its dependencies.

You can also install any specific version using the following command:

$ pip install git+https://github.com/msinamsina/pyautomail.git@<develop>

Alternatively, you can clone the repository and install the package from source:

$ git clone git@github.com:msinamsina/pyautomail.git
$ cd pyautomail
$ pip install .

How to Use

There are two ways to use pyautomail to send emails. You can either use the most powerful command-line interface (CLI) tool without writing any Python code, or you can use the Python package in your custom scripts. We’ll cover a quick overview of both of these options in this guide. For more details, please refer to the Tutorial section and the API reference.

1. Pyautomail command-line interface (CLI) tool

When you install pyautomail, you will also get a command-line interface (CLI) tool called pyautomail. This tool can be used to send emails from the command line, without writing any Python code. So if you want to send a quick email without writing a script, you can use the CLI tool.

Note

To see more example please see the cli best practices

To use the CLI tool, you will need to provide your contact list in a CSV file. The CSV file should contain the email column and other columns like name can be added as contact information which will be used in the email template.

Here’s an example of a CSV file containing a list of contacts:

email,name,data1,cpdf
contact1@gmail.com,contact1,ali,/path/to/pdf1
contact2@gmail.com,contact2,mohammad,/path/to/pdf2
contact3@gmail.com,contact3,soheila,/path/to/pdf3

And, here’s an example of HTML template:

<html>
  <body>
    <p>Hi,{{ name }}<br>
        you can see more example <br>
	<a href="https://realpython.com/python-send-email/">here </a> 
	and last version of my code is 
        <a href="https://github.com/msinamsina/auto_Gmail_sending">here </a> 
        .
    </p>
  </body>
</html>

To send emails using the CLI tool, you should do the following steps:

  1. At first you should init project using the following commands:

pyautomail init -db PAM-workspace -ss smtp.gmail.com -sp 465 -e example@gmail.com
cd PAM-workspace

  1. In the next step you should register a process

    • The process contains the email template and the contact list data and some other configurations.

    • You can register a process by running the following command:

      $ pyautomail register contacts.csv\
-e youremail@email.com\
-t template.html\
-s "Hello from automail!"
-T "list1"

    • This command will register a process with the given email, contacts and template and give you a process id.

    • You can see all the registered processes by running the following command:

      $ pyautomail list

  2. Now to start a process the following command should be run:

    $ pyautomail start <process_id>

    • This command will start the process with the given id and send the emails.

    • You also can stop a process by running the following command in another terminal:

      $ pyautomail stop <process_id>

    • And you can resume a stopped process by running the following command:

      $ pyautomail resume <process_id>

2. Writing your own python script

If you want to automate your email sending process, you can also use the Python package in your custom scripts. This will give you more flexibility and control over the email sending process. You can use the Python package to send emails to multiple recipients, use custom email templates, and customize other settings according to your needs.

You can also use pyautomail in your custom Python scripts to send emails. Here’s two basic examples of sending an email to a single recipient:

  • First example
    from pyautomail import EmailSender

# Initialize automail with your email credentials and configurations
automailer = EmailSender(email='your_email@gmail.com', password='your_email_password')

# Send a single email
sender.set_template('body.txt')
data = {'name': 'Jon', 'age': 30}
sender.send('msinamsina@gmail.com', 'sub1', data)
  • Second example
    from pyautomail import EmailSender

# Creating a sender object
sender = EmailSender(cfg="./assets/config.cfg")
# Set the template
sender.set_template('./templates/body.txt')
# Custom data
data = {'name': 'Jon', 'age': 30}
# Send the email to 'contact1@gmail.com' with Subject 'sub1' and custom date
sender.send('contact1@gmail.com', 'sub1', data)
# Repeat the above steps but using a '.html' template
data = {'name': 'Mike', 'age': 30}
sender.set_template('./templates/html.html')
sender.send('contact2@gmail.com', 'sub2', data)
# plain_temp
data = {'name': 'Mike', 'age': 30}
sender.set_template(plain_temp="{{ name }}-{{ age }}")
sender.send('contact2@gmail.com', 'sub2', data)

Configuration

Before you start sending emails, you may need to set up some configurations for pyautomail. This includes providing your email address, password and so on. You can do this by editing the config.cfg file. An example of config file is given below:

[smtp]
host = smtp.gmail.com
port = 465
is_test = True

[account]
user = example@gmail.com
password = 12345678

[log]
file-path = ./log.log
level = 10

For more advanced usage, such as sending emails with attachments file please refer to the tutorial sections in the documentation.

Conclusion

You’ve completed the getting started guide for pyautomail! You should now be ready to automate your email communication with ease. Feel free to explore the extensive documentation for more features, examples, and best practices.

Keywords: automail, Getting Started, Installation, Python Package, Automated Email Sending, Email Configuration, Email Credentials, Gmail Integration, SMTP Server, Custom Email Templates, Send Email.