EnMail

EnMail (Encrypted mail) helps the Ruby mail gem send secure encrypted messages.

The two ways for secure mail are:

OpenPGP
S/MIME

This gem allows you to select different OpenPGP implementations including NetPGP and GnuPG as different OpenPGP adapters, and also S/MIME.

Installation

Add this line to your application's Gemfile:

gem "enmail"

And then execute:

bundle install

Or install it yourself as:

gem install enmail

Configure

The EnMail gem provides a very easier interface to set custom configurations or configure the underlying dependencies, we can configure it by adding an initializer with the following code

EnMail.configure do |config|
  config.sign_message = true
  config.smime_adapter = :openssl
  config.secret_key = "Secret Key String"

  config.certificates_path = "CERTIFICATES_ROOT_PAH"
end

EnMail.configuration.certificates_path = "CERTIFICATES_ROOT_PAH"

Usage

bin/console

Development

We are following Sandi Metz's Rules for this gem, you can read the description of the rules here. All new code should follow these rules. If you make changes in a pre-existing file that violates these rules you should fix the violations as part of your contribution.

Setup

Clone the repository.

git clone https://github.com/riboseinc/enmail

Setup your environment.

bin/setup

Run the test suite

bin/rspec

Contributing

First, thank you for contributing! We love pull requests from everyone. By participating in this project, you hereby grant Ribose Inc. the right to grant or transfer an unlimited number of non exclusive licenses or sub-licenses to third parties, under the copyright covering the contribution to use the contribution by all means.

Here are a few technical guidelines to follow:

Open an issue to discuss a new feature.
Write tests to support your new feature.
Make sure the entire test suite passes locally and on CI.
Open a Pull Request.
Squash your commits after receiving feedback.
Party!

Credits

This gem is developed, maintained and funded by Ribose Inc.