notify-mail

command module
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

README

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

Via package

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

# dpkg -i notify-mail_1.2.1_amd64.deb

Via debian/ubuntu repository

Setup repository

Follow the instructions here.

Install package
# apt-get install 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 NOTIFY_MAIL_ACCOUNT=direction@gmail.com
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.

How to remove

# apt-get remove notify-mail

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL