Sha256: d1376087829da5792ffc91d71f552fa6eeed2f1648e84046b4e1cbd82e07a329

Contents?: true

Size: 1.79 KB

Versions: 2

Compression:

Stored size: 1.79 KB

Contents

# Trumail

[![Gem Version](https://badge.fury.io/rb/trumail.svg)](http://badge.fury.io/rb/trumail)
[![Build Status](https://travis-ci.org/drexed/trumail.svg?branch=master)](https://travis-ci.org/drexed/trumail)

API wrapper for the free and open source [Trumail](https://trumail.io) email validation/verification system.
You can also self-host the system on your own server. Find out more here: [https://github.com/sdwolfe32/trumail](https://github.com/sdwolfe32/trumail)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'trumail'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install trumail

## Usage
```ruby
# Basic Lookup
lookup = Trumail::Lookup.new('test@email.com').verify
lookup = Trumail::Lookup.verify('test@email.com')

# Custom Host
lookup = Trumail::Lookup.new('test@email.com', host: 'https://verifier.com').verify
lookup = Trumail::Lookup.verify('test@email.com', host: 'https://verifier.com')

# Custom Format
lookup = Trumail::Lookup.new('test@email.com', format: :xml).verify
lookup = Trumail::Lookup.verify('test@email.com', format: :xml)

# Public Methods
lookup.url          => 'https://trumail.io/json/test@email.com'
lookup.to_h         => { 'address' => 'test@email.com', 'catchAll' => true, ... }
lookup.address      => 'test@email.com'
lookup.username     => 'test'
lookup.domain       => 'email.com'
lookup.catch_all?   => true
lookup.deliverable? => false
lookup.disposable?  => true
lookup.full_inbox?  => false
lookup.gravatar?    => true
lookup.host_exists? => false
```

## Contributing

Your contribution is welcome.

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

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
trumail-0.2.0 README.md
trumail-0.1.0 README.md