Skip to main content

Automated Email Sending for Large Scale Email and Gmail Automation

Project description

PyAutoMail: A Python package and command-line interface for automation sending email to your contact list

Documentation Status PyPI PyPI - Downloads License: MIT example workflow



Pyautomail, an incredibly powerful Python package meticulously crafted for the purpose of automated email delivery, catering especially to large-scale Email or Gmail automation. In today's fast-paced digital era, effective communication stands as a crucial cornerstone for numerous businesses and projects that heavily rely on email as their primary medium of interaction. Nonetheless, the manual handling of individual emails or the management of bulk email campaigns can prove to be both time-consuming and prone to errors.

Fear not, for pyautomail swoops in as the ultimate savior, offering a seamless and highly efficient solution for automating email communication. Be it the need to dispatch personalized emails to a vast audience, the execution of targeted email marketing campaigns, or the automation of repetitive email chores, this package serves as your ultimate go-to tool. With its user-friendly interface and an array of versatile features, pyautomail proves itself as a fitting choice for a wide range of applications, catering to startups, enterprises, professionals, and developers alike.

Revolutionize your email operations, whether it involves mass email distribution, streamlined Gmail tasks, or the quest for enhanced email communication proficiency - pyautomail is here to streamline your workflow, elevate your efficiency, and elevate productivity to soaring heights.

Installation

PyPi

pip install pyautomail

Github

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

How to use in command-line interface

  1. At first, you should initialize project

    python -m pyautomail init
    

    After running this command, you will see a some questions. You should answer them.

    Where do you want to initialize the pyautomail project? [./pyautomail-workspace]
    What is your smtp server? [smtp.gmail.com]:
    What is your smtp port? [465]:
    

    📘 Note:

    1. This command will create a folder with the project name in the path you specified. If you don't specify the path, it will create automail-workspace.
    2. You can change the default smtp server by default it has been set on Gmail Smtp Server.
    3. You also can set the port of Smtm Server (by default 465).
    4. Additionally, if you want to save you password in config file, you can use the -p or --pasword switch.
    5. Moreover, if you want to initialize a test project, you can use -t or --test.
      $ python -m pyautomail init -t -p <your-password>
      

    📙 Important
    If directory already exists, it will be overwritten.

  2. Then you should go to the project directory and register your contact list

    cd <your-project-name>
    python -m pyautomail register <Path-to-your-contact-list> [options]
    

    📘 Note:
    For using a template, use --template switch. The template can be .txt or .html Format.

    python -m pyautomail register contact-list.csv --template ./body.html
    

    body.html:

    <h1> Hi {{ name }}, </h1>
    

    contact-list.csv:

    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
    
  3. Now you can start sending emails by running the following command

    python -m pyautomail start <process-id>
    

How to use in python

    from pyautomail import EmailSender
    email_sender = EmailSender('config.cfg')
    email_sender.set_template('body.txt')
    data = {'name': 'Jon', 'age': 30}
    email_sender.send('msinamsina@gmail.com', 'sub1', data)

Documentation and Resources

For more comprehensive information about PyAutoMail and its capabilities, please explore our detailed documentation.

  • Get a brief overview and explore the features of PyAutoMail in the Introduction section.
  • If you're new to PyAutoMail, follow our Getting Started guide to kickstart your email automation journey.
  • For a quick reference, you can check out the API Reference section.
  • To gain deeper insights into PyAutoMail and learn best practices, dive into our informative Tutorial section.

By exploring these resources, you'll harness the full potential of PyAutoMail and make the most out of its powerful email automation capabilities.


Contribution and Support

We welcome contributions from the community to enhance PyAutoMail and make it even more robust. If you're interested in contributing, here's how you can get involved:

  1. Bug Reports and Feature Requests: If you come across any issues or have ideas for new features, please open an issue on our GitHub repository. We appreciate detailed bug reports with steps to reproduce the problem and clear feature requests with use cases.

  2. Pull Requests: If you want to contribute code to PyAutoMail, you can do so by submitting a pull request. Please ensure that your code adheres to the existing code style, and include relevant tests to maintain code quality.

  3. Documentation: Improving the documentation is always valuable. If you find any inconsistencies or areas that need clarification, feel free to submit documentation updates via pull requests.

  4. Spread the Word: If you find PyAutoMail useful, help us spread the word by sharing it with your peers and on social media platforms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyautomail-1.7.0.7.tar.gz (265.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyautomail-1.7.0.7-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file pyautomail-1.7.0.7.tar.gz.

File metadata

  • Download URL: pyautomail-1.7.0.7.tar.gz
  • Upload date:
  • Size: 265.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyautomail-1.7.0.7.tar.gz
Algorithm Hash digest
SHA256 26cb495a50ab78163f445bcfd6f1b568e03ae7490c787d40a605cfab10759e10
MD5 220a693865dc0b1e0fa47769e96b55ad
BLAKE2b-256 edb19d424258594e839e2c0f1de4a61fcaba4561c539c29ede844b3106442b7d

See more details on using hashes here.

File details

Details for the file pyautomail-1.7.0.7-py3-none-any.whl.

File metadata

  • Download URL: pyautomail-1.7.0.7-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyautomail-1.7.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 dfbe561a08d91c008eefca662ded9a2c044cb19c9eca398abedccb8ca7a8e0de
MD5 f7ca4016696d58104e062e0d1e136ded
BLAKE2b-256 7c5328ed014fde60627272767cc6dabc461fb717f63a624df62fa3f74b9b5785

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page