2016-07-19 11:12:28 +02:00
Plugin Email
2017-01-04 13:22:20 +01:00
============
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
Sends a build status email.
2016-07-19 11:12:28 +02:00
Configuration
2017-01-04 13:22:20 +01:00
-------------
2016-07-19 11:12:28 +02:00
### Options
2016-07-17 16:20:35 +02:00
* **committer** - Whether or not to send the email to the committer that prompted this build.
* **addresses** - A list of addresses to send to.
* **default_mailto_address** - A default address to send to.
* **cc** - A list of addresses that will receive a copy of every emails sent.
* **template** - The template to use, options are short and long. Default is short on success and long otherwise.
2017-06-28 09:25:54 +02:00
**Note:** _This plugin will only work if you configured email settings during installation or configured them later in [`config.yml`](../configuring.md)._
2016-07-19 11:12:28 +02:00
### Examples
2017-02-02 13:32:17 +01:00
See [Adding PHP Censor Support to Your Projects ](../configuring_project.md ) for more information about how to configure plugins.
2016-07-17 16:20:35 +02:00
Send an email to the committer as well as one@exameple.com if a build fails:
```yml
failure:
email:
committer: true
default_mailto_address: one@example.com
```
Send an email to one@example.com every time a build is run:
```yml
complete:
email:
default_mailto_address: one@example.com
```