Connect to MailerSend Data in Ruby

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to MailerSend data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData API Driver for ODBC makes it easy to integrate connectivity to live MailerSend data in Ruby. This article shows how to create a simple Ruby app that connects to MailerSend data, executes a query, and displays the results.

Create an ODBC Connection to MailerSend Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

The MailerSend API uses API Key authentication via a Bearer token in the Authorization request header.

Using API Key Authentication

Your MailerSend API token is required to create a connection. To obtain your API token:

  1. Log into your MailerSend account at app.mailersend.com.
  2. Navigate to Settings > API Tokens in your account dashboard.
  3. Click Generate new token, provide a name and select the appropriate permissions.
  4. Copy the generated API token.

After obtaining your API token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your MailerSend API token.

Example connection string:

Profile=C:\profiles\Mailersend.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi
gem install dbd-odbc
gem install ruby-odbc

Create a Ruby App with Connectivity to MailerSend Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN
require 'dbi'
cnxn = DBI.connect('DBI:ODBC:CData API Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT ,  FROM Activity WHERE DomainId = 'domain123'")

#display the names of the columns
resultSet.column_names.each do |name|
  print name, "\t"
end
puts

#display the results
while row = resultSet.fetch do
  (0..resultSet.column_names.size - 1).each do |n|
    print row[n], "\t"
  end
  puts
end
resultSet.finish

#close the connection
cnxn.disconnect if cnxn

With the file completed, you are ready to display your MailerSend data with Ruby. To do so, simply run your file from the command line:

ruby APISelect.rb
Writing SQL-92 queries to MailerSend allows you to quickly and easily incorporate MailerSend data into your own Ruby applications. Download a free trial today!

Ready to get started?

Connect to live data from MailerSend with the API Driver

Connect to MailerSend