Metadata-Version: 2.1
Name: ashmail
Version: 2.1.2
Summary: the free and simple mass emailing system
Home-page: https://github.com/0x44RU5H/ashmail
Author: Aarush Gupta
Author-email: aarush@theaarushgupta.com
License: AGPLv3+
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: jinja2
Requires-Dist: pyyaml

<p align = "center">
    <a href = "https://opensource.org/licenses/MIT">
        <img alt = "License" src = "https://img.shields.io/badge/License-AGPLv3-green.svg">
    </a>
    <a href = "https://pypi.org/project/ashmail/">
        <img alt = "Version" src = "https://img.shields.io/pypi/v/ashmail.svg">
    </a>
    <a href = "https://pypi.org/project/ashmail/">
        <img alt = "Downloads" src = "https://img.shields.io/pypi/dm/ashmail.svg">
    </a>
    <a href = "https://pypi.org/project/ashmail/">
        <img alt = "Supported Versions" src = "https://img.shields.io/pypi/pyversions/ashmail.svg">
    </a>
</p>

<h1 align = "center"><a href = "https://pypi.org/project/ashmail/">AshMail <code>v2.1.2</code></a></h1>
<h3 align = "center">The free and simple mass emailing system </h3>

## Usage

### Files needed
- `config.yml` - the configuration file
- `content.html` - the html content of the email with variables inside squiggled brackets
- `recievers.csv` - a file with names and emails

Note: all of these files with some example data can be found in the `_tests_/` directory

### Data required in files

#### `config.yml`
- `content`: name of the html file with the content to send in the email
- `recivers`: name of the csv file with data with names and emails
- `from`: the address to send the email from
- `password`: the password of the aforementioned email
- `subject`: the subject of the email

#### `content.html`
An html file with content. Variables can be inside double squiggled brackets:
```html
<h1 style = "color: red;">Hello {{ name }}</h1>
<h3 style = "color: blue;">Nice email! {{ email }} looks so professional</h3>
```

#### `recievers.csv`
A csv file with names and their corrosponding emails
```csv
name,email
Mr. Example,example@example.com
```

### Running AshMail

#### If this is the first time running AshMail on your computer
1. Install the library with `pip3 install ashmail`. The PyPI page is [here](https://pypi.org/project/ashmail/)

#### Continued from last steps or already installed AshMail
1. `ashmail <configuration>` where `<configuration>` is the filename of the configuration yaml file
    - Note: make sure all the files described above are in the same directory before running the script.

## Important Notes
- AshMail currently only works with Gmail based accounts
- Turn on Less Secure Apps on your email before using the app, or if you have two factor authentication on, create an App Password and use that in the configuration file.

## Copyright &copy; 2021 Aarush Gupta
This code is copyrighted but licensed to the public under the GNU AGPLv3 license and any later versions.


