sendwithus_ruby

Ruby bindings for sending email via the sendwithus API.

sendwithus.com

Installation

gem install send_with_us

or with Bundler:

gem 'send_with_us'
bundle install

Usage

General

For any Ruby project:

require 'rubygems'
require 'send_with_us'

begin
    obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )

    # only required params
    result = obj.send_with(
        'EMAIL_ID',
        { address: "user@example.com" })
    puts result

    # with all optional params
    result = obj.send_with(
        'email_id',
        { name: 'Matt', address: 'recipient@example.com' },
        { company_name: 'TestCo' },
        { name: 'Company',
            address: 'company@example.com',
            reply_to: 'info@example.com' })
    puts result

    # full cc/bcc support
    result = obj.send_with(
        'email_id',
        { name: 'Matt', address: 'recipient@example.com' },
        { company_name: 'TestCo' },
        { name: 'Company',
            address: 'company@example.com',
            reply_to: 'info@example.com' },
        [
            { name: 'CC',
                address: 'cc@example.com' }
        ],
        [
            { name: 'BCC',
                address: 'bcc@example.com' },
            { name: 'BCC2',
                address: 'bcc2@example.com' }
        ])
    puts result

    # Attachment support
    result = obj.send_with(
        'email_id',
        { name: 'Matt', address: 'recipient@example.com' },
        { company_name: 'TestCo' },
        { name: 'Company',
            address: 'company@example.com',
            reply_to: 'info@example.com' },
        [],
        [],
        ['path/to/file.txt'])
    puts result

    # Set ESP account
    # See: https://help.sendwithus.com/support/solutions/articles/1000088976-set-up-and-use-multiple 
    result = obj.send_with(
        'email_id',
        { name: 'Matt', address: 'recipient@example.com' },
        { company_name: 'TestCo' },
        { name: 'Company',
            address: 'company@example.com',
            reply_to: 'info@example.com' },
        [],
        [],
        [],
        'esp_MYESPACCOUNT')
    puts result
rescue => e
    puts "Error - #{e.class.name}: #{e.message}"
end

Remove Customer from Drip Campaign

require 'rubygems'
require 'send_with_us'

begin
    obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )

    result = obj.drip_unsubscribe('customer@example.com')

    puts result
rescue => e
    puts "Error - #{e.class.name}: #{e.message}"
end

Rails

For a Rails app, create send_with_us.rb in /config/initializers/ with the following:

SendWithUs::Api.configure do |config|
    config.api_key = 'YOUR API KEY'
    config.debug = true
end

In your application code where you want to send an email:

begin
    result = SendWithUs::Api.new.send_with('email_id', { address: 'recipient@example.com' }, { company_name: 'TestCo' })
    puts result
rescue => e
    puts "Error - #{e.class.name}: #{e.message}"
end

Take a look at our Mailer that you can use to replace ActionMailer

sendwithus_ruby_action_mailer

Errors

The following errors may be generated:

SendWithUs::ApiInvalidEndpoint - the target URI is probably incorrect or email_id is invalid
SendWithUs::ApiInvalidKey - the sendwithus API key is invalid
SendWithUs::ApiBadRequest - the API request is invalid
SendWithUs::ApiConnectionRefused - the target URI is probably incorrect
SendWithUs::ApiUnknownError - an unhandled HTTP error occurred

Internal

Build gem with

gem build send_with_us.gemspec

Publish gem with

gem push send_with_us-VERSION.gem