mailtorpedo

A Python package for sending personalized emails using own SMTP server.


License
MIT
Install
pip install mailtorpedo==1.1.0

Documentation

<style> html { font-family: Trebuchet; } </style>

Torpedo

A Python package for sending personalized emails using own SMTP server.
GitHub Travis Codecov
License Size
Contributors Last Commit
Watchers Stars

Torpedo is a Python package (which also comes as a GUI application) that helps user to send personalized emails (mostly for email marketing) using their own SMTP server (or maybe their Gmail account). The target user base are the people who cannot (or unwilling to) buy a dedicated email marketing service available online.

Features

  • Send personalized messages using {{ variable }} format and Torpedo will replace them while sending.

  • Supports both plain text and html emails.

  • Supports attachments (image, audio and other binary file formats) of 119+ formats (limited to 119 for the GUI application) if not mentioned otherwise. Check list of disallowed file formats for exceptions.

  • Supports CSV files of all common delimiters and Microsoft Excel files for getting user database.

  • Log files for every task started.

  • Can send up to 80 emails a minute.

  • Resumability in case of disrupted emails (available only on windows).

  • Can automate emails with only 6 (or maybe 0 if using GUI) lines of code.

  • Can easily be integrated with any Python application.

Torpedo is made a way so that people can focus on their goal instead of caring too much about the codes. User needs to write down the email body and link the attachment and database files. Rest will be done by Torpedo, flawlessly! Check full code online

Dependencies

Torpedo uses more than a couple of external Python packages to work properly-

  • OpenPyXL to retrieve and process data from Windows Excel documents.

  • BeautifulSoup4 to check availability of HTML content in email body.

  • PyInstaller to compile the GUI into one windows executable file.

All of course Torpedo itself is an open source project with a public repository on GitHub.

Installation

Python Package

To install from PyPI run the following code on your command prompt-

For windows users:

pip install mailtorpedo

For Linux and MacOS users:

pip3 install mailtorpedo

GUI

Installation is not required for the GUI application. Download Torpedo-1.1.0.exe from GitHub repository. Your antivirus might consider it as a suspicious file. Better make an exception folder and save it there.

There is another way to use the GUI without using the executable but that requires Python (3.6+) installed. Run the following commands on command prompt or terminal to get the GUI running.

Linux and MacOS Users

Clone the repository and change directory to the cloned folder-

git clone --depth=3 "https://github.com/pptx704/torpedo"
cd torpedo

Run the GUI using Python

python3 -m torpedo-gui

Windows Users

Clone the repository and change directory to the cloned folder-

git clone --depth=3 "https://github.com/pptx704/torpedo"
cd torpedo

Run the GUI using Python

python -m torpedo-gui

Usage

To be updated

License

MIT License

Contributing

To be updated