How to Query MailerSend Data in MySQL Workbench

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute MySQL queries against live MailerSend data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for MailerSend to query MailerSend data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live MailerSend data in MySQL Workbench.

Connect to MailerSend Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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';

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to MailerSend data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query MailerSend from MySQL Workbench

The steps below outline connecting to the virtual MailerSend database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live MailerSend data.

Connect to MailerSend through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for MailerSend).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query MailerSend Data

  1. Open the connection you just created (CData SQL Gateway for MailerSend).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve MailerSend data, like SELECT * FROM `CData API Sys`.Activity;

With access to live MailerSend data from MySQL Workbench, you can easily work with MailerSend, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.

Ready to get started?

Connect to live data from MailerSend with the API Driver

Connect to MailerSend