Skip to content

Latest commit

 

History

History
93 lines (56 loc) · 1.91 KB

README.md

File metadata and controls

93 lines (56 loc) · 1.91 KB
Raw

notify-mail

Send mail notifications via google's gmail

How does it work

It uses a gmail account to send notification mails.

How to install

Do it yourself

Build the package

dpkg-buildpackage -us -uc -b

Install it

dpkg -i ../notify-mail_1.2.2_amd64.deb

Remove

dpkg -r notify-mail

Via pre-built package

Download

Get the latest version from https://github.com/adelolmo/notify-mail/releases/latest

dpkg -i notify-mail_1.2.2_amd64.deb

Install

dpkg -i notify-mail_1.2.2_amd64.deb

Remove

apt-get remove notify-mail

Via debian/ubuntu repository

Setup repository

Follow the instructions here.

Install package

apt-get install notify-mail

Remove

apt-get remove notify-mail

Configuration

You will need a gmail account first of all. Make sure that you don't have "two steps authentication" enable.

You need to configure two environment variables:

  • NOTIFY_MAIL_ACCOUNT is the mail account used for sending the mails.
  • NOTIFY_MAIL_PASSWORD is the account's password.
export [email protected]
export NOTIFY_MAIL_PASSWORD=your_password

How to Use

Send with body content

notify-mail -recipient="email_address@email_provider.com" -subject="Notification" -message="Your message"

Send with template

Template example:

<html>
<body>
<p1>Hi {{var1}}</p1>
<p1>Here goes the second variable: {{var2}}</p1>
</body>
</html>
notify-mail -recipient="email_address@email_provider.com" -subject="Notification" -template="/path/to/template.html" -variables="{{var1}}=value of var1,{{var2}}=value of var2"

The placeholders var1 and var2 in the template will be replaced by the values given in the variables parameter. In the example above var1 will be replaced by the text value of var1 and var2 will be replaced by value of var2.