mailtrigger 2.0.0

Remote service trigger with mail

Mail Trigger

Requirements

• Python (3.7+)
• pip
• python-dev

Installation

On Ubuntu / Mint, install Mail Trigger with the following commands:

sudo apt update
sudo apt install python3-dev python3-pip python3-setuptools
sudo pip install mailtrigger

On OS X, install Mail Trigger via Homebrew (or via Linuxbrew on Linux):

TBD

On Windows, install Mail Trigger with the following commands:

pip install -U pywin32
pip install -U PyInstaller
pip install -Ur requirements.txt

pyinstaller --clean --name mailtrigger -F trigger.py

Updating

pip install mailtrigger --upgrade

Running

mailtrigger --mailer-config mailer.json --scheduler-config scheduler.json --trigger-config trigger.json

Settings

Mail Trigger parameters can be set in the directory config.

An example of configuration in mailer.json:

{
  "pop3": {
    "host": "pop.example.com",
    "pass": "pass",
    "port": 995,
    "ssl": true,
    "timeout": 10,
    "user": "user"
  },
  "smtp": {
    "host": "smtp.example.com",
    "pass": "pass",
    "port": 465,
    "ssl": true,
    "timeout": 10,
    "user": "user"
  }
}

An example of configuration in scheduler.json:

{
  "interval": 30
}

An example of configuration in trigger.json:

{
  "gerrit": {
    "filter": {
      "from": [
        "[e-mail]"
      ],
      "subject": "[trigger]"
    },
    "host": "localhost",
    "port": 8080
  },
  "helper": {
    "filter": {
      "from": [
        "[e-mail]"
      ],
      "subject": "[trigger]"
    }
  },
  "jenkins": {
    "filter": {
      "from": [
        "[e-mail]"
      ],
      "subject": "[trigger]"
    },
    "host": "localhost",
    "port": 8081
  },
  "jira": {
    "filter": {
      "from": [
        "[e-mail]"
      ],
      "subject": "[trigger]"
    },
    "host": "localhost",
    "port": 8082
  },
  "printer": {
    "filter": {
      "from": [
        "[e-mail]"
      ],
      "subject": "[trigger]"
    },
    "name": "name.xlsx"
  }
}

Usage

Subject

[trigger]: Write your description here

Note: [trigger] is the reserved word in subject

Recipient

The recipient is mail receiver as Mail Trigger.

Content

Gerrit Trigger

@gerrit help
@gerrit list
@gerrit restart <host>
@gerrit start <host>
@gerrit stop <host>
@gerrit verify <host>

@gerrit review <host>:<port>
  [--project <PROJECT> | -p <PROJECT>]
  [--branch <BRANCH> | -b <BRANCH>]
  [--message <MESSAGE> | -m <MESSAGE>]
  [--notify <NOTIFYHANDLING> | -n <NOTIFYHANDLING>]
  [--submit | -s]
  [--abandon | --restore]
  [--rebase]
  [--move <BRANCH>]
  [--publish]
  [--json | -j]
  [--delete]
  [--verified <N>] [--code-review <N>]
  [--label Label-Name=<N>]
  [--tag TAG]
  {COMMIT | CHANGEID,PATCHSET}

Jenkins Trigger

@jenkins build <host>:<port> JOB [--parameter <PARAMETER> | -p <PARAMETER>]
@jenkins help
@jenkins list
@jenkins list <host>:<port>
@jenkins query <host>:<port> JOB
@jenkins rebuild <host>:<port> JOB
@jenkins stop <host>:<port> JOB
@jenkins verify <host>:<port> JOB

Jira Trigger

TBD

Trigger Help

@help

License Apache

Project License can be found here.