Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/civitaspo/alerty-plugin-mail

mail plugin for alerty https://github.com/sonots/alerty
https://github.com/civitaspo/alerty-plugin-mail

Last synced: 3 months ago
JSON representation

mail plugin for alerty https://github.com/sonots/alerty

Awesome Lists containing this project

README

        

# Alerty::Plugin::Mail

mail plugin for alerty

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'alerty-plugin-mail'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install alerty-plugin-mail

## Configuration

- **type**: must be `mail`
- **send_from**: send a mail from (required)
- **send_to**: send a mail to (required)
- **delivery_method**: delivery method. see https://github.com/mikel/mail (optional, default: `sendmail`)
- **delivery_settings**: delivery settings. see https://github.com/mikel/mail (optional)
- **num_retries**: retry to send the mail if failed (optional, default: `3`)
- **subject**: mail subject (optional)

## ChangeLog

See [CHANGELOG.md](./CHANGELOG.md)

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/civitaspo/alerty-plugin-mail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).