MailFace Ruby SDK - send your face to any email address
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
WHAT_IS_THIS.md

README.md

MailFace Ruby SDK

Gem Version Build Status Contact Support

MailFace is an API for mailing your face to any email address. With one simple API call you can send your face and get first class delivery.

For more details see the Ruby documentation on MailFace.xyz.

Installation

This gem requires Ruby 2.1+. You can install install it directly or via bundler.

gem install 'mailface'

Next: Get Started with the Ruby SDK.

Getting Started

To send your first face via email you will need to register for MailFace and set up your first application.

mailface = MailFace.new({
  app_id: '[YOUR_APP_ID]',
  api_key: '[YOUR_API_KEY]',
  api_secret: '[YOUR_API_SECRET]'
})

mailface.send({
  email: 'recipient@example.com',
  face: 'path/to/yourface.png'
}) 

Next: Learn more about our sending faces with our Ruby SDK.

Initialization

The client follows the 12-factor apps principle and can be either set directly or via environment variables.

# Initialize using parameters
mailface = MailFace.new(app_id: '...', api_key: '...', api_secret: '...')

# Alternative: Initialize using environment variables
# * MAILFACE_API_KEY
# * MAILFACE_API_SECRET
mailface = MailFace.new

Your credentials can be found on the MailFace dashboard. Sign up for an account today.

Next: Learn more about our initializing the Ruby SDK in our documentation.

Documentation

MailFace is a powerful tool and our documentation is here to get you started today.

Alternatively, head over to our Reference documentaton for in-depth information about every SDK method, it's arguments and return types.

Contributing

Want to contribute to this library? Read our contributor guidelines to get set up.

License

This library is released under the MIT License.

Help

Our developer support team is here to help you. You can find us on Twitter, StackOverflow, and email.