mailer

---

Command line mail utility

Installation:

1. Clone the repo on your computer and cd to the root folder of the project.
2. run python setup.py install

Usage:

NOTE: The following examples call the program delta-mail. This is how it is currently named, however the name is expected to be changed soon.

• Sending the exact same mail to a list of people. No variables in the mail template

  delta-mail -r="bob@job.com,job@bob.com" -s="Welcome" -t=input.mmtmpl -u="123456789" -o=mailtrap.io -p=25

• Sending the exact same mail to a list of people. However, the email template can contain variables that are specific to this particular batch of mails.

  delta-mail -r="bob@job.com,job@bob.com" --globals=variables.mvar -s="Welcome to {{EventName}}" -t=input.mmtmpl -u="123456789" -o=mailtrap.io -p=25

• Sending personalised mails. Requires the use of a .ml (mailing list) file

  delta-mail -R=receivers.ml -s="Welcome {{name}}!" -t=input.mmtmpl -u="123456789" -o=mailtrap.io -p=25

• Sending personalised mails. Requires the use of a .ml file. In addition, one can use a .mvar (mail variables) file to specify variables common to this particular batch of mails.

  delta-mail -R=receivers.ml --globals=globalvars.mvar -s="Welcome {{name}}!" -t=input.mmtmpl -u="123456789" -o=mailtrap.io -p=25

• Automatically finding out the type of the mail to be sent

  delta-mail --smartsend=./mail-campaigns/festember/ -u="123456789" -o=c1mailtrap.io -p=25

The folder ./mail-campaigns/festember/c1 should have the following structure:

- template.mmtmpl
- mailinglist.ml
- subject.txt
- globals.mvar

The first two files are required. The last file is optional. If the subject.txt file is missing, then the subject will be taken as the directory name (here, c1).

(For the first type of command, the subject can NOT be a template.)

Format of a .ml file:

The file is a tab separated file. (As of now, tabs in the values are not allowed. Will be changed soon.) First line contains the list of fields - the variables that are referred to in the template file. One of the fields has to be called email. This field contains the email addresses of the receivers.

If files are to be attached, have a field called $attachments, and the corresponding entry in each row can be an empty string or a semicolon-separated list of paths. Each path must lead to a valid file.

From the next line, each row will contain the values of the appropriate fields, and this data will be used to make personalised emails.

Empty lines (lines having only, and only whitespace characters) are ignored.

Example:

email	fname	lname	dob	$attachments

bob@rob.com	Bob	Rob	26-8-2015	~/delta/mailer/README1.md;~/delta/mailer/main.py
hog@rob.com	Hog	Rob	26-8-1996	~/delta/mailer/README2.md;~/delta/mailer/main.py

This file, when used as the -R option, will generate two mails.

NOTE: As of now, this does not allow you to send CC and BCC. Also, it doesn't not allow you to send the same email to multiple receipients - if you want to do that, you'll have to have two separate rows in the above file (i.e., comma-separated list of emails is not supported. No error will be raised as of now. It will silently fail)

Format of a .mvar file:

Each line is of form: {VARIABLE}={VALUE}

Empty lines are ignored

Spaces to the right of the equal-to sign are considered part of the value. Trailing spaces in variable names are ignored. Spaces aren't allowed in the variable names themselves. Though they may contain any other characters (other than = of course)

$attachments is a special variable - its value should be a semicolon separated list of paths that lead to valid files. These files will be attached to the mail.