Contents

# MAYaml

[![Gem Version](https://badge.fury.io/rb/mayaml.svg)](http://badge.fury.io/rb/mayaml)
[![Code Climate](https://codeclimate.com/github/skopciewski/mayaml/badges/gpa.svg)](https://codeclimate.com/github/skopciewski/mayaml)
[![Dependency Status](https://gemnasium.com/badges/github.com/skopciewski/mayaml.svg)](https://gemnasium.com/github.com/skopciewski/mayaml)

This is a base package for mail accounts configuration generators. The idea is to store mail accounts configuration in one Yaml file and then generates dedicated configs for specific programs (like getmail, mutt, etc...).

## Installation

Add this line to your application's Gemfile:

    gem 'mayaml'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install mayaml

## Usage

If ruby bin dir is in your PATH, just call `mayaml-check <path_to_the_yaml_file>` to list recognized accounts.
On the other hand, In plugins:

```ruby
require "mayaml"

Mayaml.accounts_from_file(yaml_path).each { |account| ... }
```

### Mail account format in Yaml file

```yaml
- name: account_name
  default: false
  realname: Jon Foo
  type: imap
  server: test.mailserver.com
  port: 998
  user: [e-mail]
  pass: sercet_password
  mailboxes:
    - INBOX
  smtp_protocol: smtps
  smtp_port: 587
  smtp_authenticator: login
```

#### Required attributes

* `name`
* `realname`
* `type` [imap | imapssl | pop3 | pop3ssl]
* `server`
* `port`
* `user`
* `pass`
* `smtp_protocol` [smpt | smtps]
* `smtp_port`
* `smtp_authenticator`

#### Default attributes

* `mailboxes` => `[]`
* `default` => `false`

## Versioning

See [semver.org][semver]

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

[semver]: http://semver.org/

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
mayaml-3.0.1	README.md