Skip to content

FuseMail API client library and command line interface (CLI)

License

Notifications You must be signed in to change notification settings

mudbugmedia/fusebox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fusebox

Description

FuseMail is a business email hosting provider offering outsourced email hosting to businesses and resellers.

fusebox is a ruby gem that provides a 1:1 native ruby interface for every command of FuseMail Platform Programming Interface v2.6, which allows you to manage your accounts, domains, forwards, and aliases via an underlying HTTP interface.

Installation

$ gem install fusebox

Configuration

Although the library supports passing a username and password to {Fusebox::Request#initialize}, we recommend storing authentication information in a YAML file within {Fusebox::Request.auth_yaml_paths} as:

$ cat ~/.fusemail.yaml
username: my_username
password: my_password

Command Line Interface (CLI)

fusebox comes with a command line interface (written on the amazing thor). CLI usage requires the setup of a ~/.fusemail.yaml authentication file. For a command list type: $ fusebox help or for command specific flags, e.g. "rm" $ fusebox help rm

Note: The CLI interface currently assumes all group accounts are named postmaster@example.com, and that the username for all accounts is a full email address.

Library Examples

Fetch a list of users

response = Fusebox::Request.new.report
if response.success?
   response.records.each { |user| puts user.inspect }
end

Create a new account

response = Fusebox::Request.new.order(:account_type => 'group_subaccount', :group_parent => "postmaster@example.com", :user => "user@example.com", :password => 'WooEmail!', :first_name => 'Test', :last_name => 'User')
if response.success?
  puts "Success!"
else
  puts "Failure: " + response.detail
end

See the Fusebox::Request documentation for more commands.

Documentation

Authors

The fusebox gem is independently developed and maintained by Mudbug Media and Gabe Martin-Dempesy.

FuseMail LLC, and its parent company j2 Global Communications, do not provide support or maintenance for this software.

Copyright © 2010 - 2014

About

FuseMail API client library and command line interface (CLI)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages