Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mailtoolbox/mail_grabber
Grab mails to inspect with MailGrabber
https://github.com/mailtoolbox/mail_grabber
deliverymethod inspect interface mail mailer rails ruby ruby-on-rails web webinterface
Last synced: 2 months ago
JSON representation
Grab mails to inspect with MailGrabber
- Host: GitHub
- URL: https://github.com/mailtoolbox/mail_grabber
- Owner: MailToolbox
- License: mit
- Created: 2021-03-19T05:27:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T19:38:55.000Z (3 months ago)
- Last Synced: 2024-09-26T16:22:13.281Z (3 months ago)
- Topics: deliverymethod, inspect, interface, mail, mailer, rails, ruby, ruby-on-rails, web, webinterface
- Language: Ruby
- Homepage:
- Size: 264 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# M
ilGrabber
[](https://badge.fury.io/rb/mail_grabber)
[](https://github.com/MailToolbox/mail_grabber/blob/main/LICENSE.txt)
[](https://github.com/rubocop-hq/rubocop)
[](https://github.com/MailToolbox/mail_grabber/actions/workflows/mail_grabber_ci.yml)
[](https://codeclimate.com/github/MailToolbox/mail_grabber/maintainability)
[](https://codeclimate.com/github/MailToolbox/mail_grabber/test_coverage)
**MailGrabber** is yet another solution to inspect sent emails.
It has two part:
- delivery method to grab emails and store into a database
- simple rack web interface to check those emails
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'mail_grabber'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install mail_grabber
## Usage
- [How to use MailGrabber in a Ruby script or IRB console](https://github.com/MailToolbox/mail_grabber/blob/main/docs/usage_in_script_or_console.md)
- [How to use MailGrabber in Ruby on Rails](https://github.com/MailToolbox/mail_grabber/blob/main/docs/usage_in_ruby_on_rails.md)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 [CHANGELOG.md](https://github.com/MailToolbox/mail_grabber/blob/main/CHANGELOG.md)
- Update the version number in `version.rb` manually or use `gem-release` gem and run `gem bump -v major|minor|patch|rc|beta`.
- Build gem with `bundle exec rake build`.
- Run `bundle install` to update gemfiles and commit the changes.
- 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. Please read [CONTRIBUTING.md](https://github.com/MailToolbox/mail_grabber/blob/main/CONTRIBUTING.md) if you would like to contribute to this project.
## Inspiration
- [MailCatcher](https://github.com/sj26/mailcatcher)
- [letter_opener_web](https://github.com/fgrehm/letter_opener_web)
- [Rack](https://github.com/rack/rack)
- [Rack::Router](https://github.com/pjb3/rack-router)
- [Sidekiq](https://github.com/mperham/sidekiq)
- and other solutions regarding in this topic
## License
The gem is available as open source under the terms of the [MIT License](https://github.com/MailToolbox/mail_grabber/blob/main/LICENSE.txt).