Metadata-Version: 2.1
Name: ntuee-mailer
Version: 2.0.8
Summary: an auto mailer to send emails in batch for you
Home-page: https://github.com/madmaxieee/ntuee-mailer
License: MIT
Author: madmaxieee
Author-email: 76544194+madmaxieee@users.noreply.github.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Cerberus (==1.3.4)
Requires-Dist: PyYAML (==6.0)
Requires-Dist: email-validator (==1.2.1)
Requires-Dist: rich (==12.5.1)
Requires-Dist: typer[all] (>=0.6.1,<0.7.0)
Project-URL: Repository, https://github.com/madmaxieee/ntuee-mailer
Description-Content-Type: text/markdown

# `ntuee-mailer`

This is a simple mailer for NTU students to send letters in batches.

**Installation**

```bash
$ pip install ntuee-mailer
```

**Usage**:

```bash
$ ntuee-mailer [OPTIONS] COMMAND [ARGS]...
```

**Options**:

- `--install-completion`: Install completion for the current shell.
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
- `--help`: Show this message and exit.

**Commands**:

- `check`: check wether a directory is a valid letter a...
- `config`: configure the auto mailer a valid config file...
- `new`: create a new letter from template
- `send`: send emails to a list of recipients as...

## `ntuee-mailer check`

check wether a directory is a valid letter

a letter folder should be structured as follows:

letter

├── attachments

│ ├── ...

│ └── ...

├── config.yml

├── content.html

└── recipients.csv

**Usage**:

```console
$ ntuee-mailer check [OPTIONS] LETTER_PATH
```

**Arguments**:

- `LETTER_PATH`: Path to letter directory [required]

**Options**:

- `--help`: Show this message and exit.

## `ntuee-mailer config`

configure the auto mailer

a valid config file should have the following structure:

[smtp]

host=smtps.ntu.edu.tw

port=465

timeout=5

[pop3]

host=msa.ntu.edu.tw

port=995

timeout=5

[account]

name=John Doe

**Usage**:

```console
$ ntuee-mailer config [OPTIONS]
```

**Options**:

- `-f, --file TEXT`: Path to new config file whose content will be copied to config.ini
- `-r, --reset`: Reset config.ini to default [default: False]
- `-l, --list`: list current config [default: False]
- `--help`: Show this message and exit.

## `ntuee-mailer new`

create a new letter from template

**Usage**:

```console
$ ntuee-mailer new [OPTIONS] LETTER_NAME
```

**Arguments**:

- `LETTER_NAME`: Name of letter [required]

**Options**:

- `--help`: Show this message and exit.

## `ntuee-mailer send`

send emails to a list of recipients as configured in your letter

**Usage**:

```console
$ ntuee-mailer send [OPTIONS] [LETTER_PATH]
```

**Arguments**:

- `[LETTER_PATH]`: Path to letter

**Options**:

- `-t, --test`: Test mode: send mail to yourself [default: False]
- `-c, --config FILE`: Path to config.ini [default: /home/madmax/.config/ntuee-mailer/config.ini]
- `-q, --quiet`: Quiet mode: less output [default: False]
- `-d, --debug INTEGER RANGE`: Debug level [default: 0]
- `--help`: Show this message and exit.

## `ntuee-mailer test`

**Usage**:

```console
$ ntuee-mailer test [OPTIONS]
```

**Options**:

- `--help`: Show this message and exit.

