Using the CData ODBC Driver for MailerSend in PyCharm

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to MailerSend as an ODBC data source in PyCharm using the CData ODBC Driver for MailerSend.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for MailerSend from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for MailerSend as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to MailerSend

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for MailerSend
Description = My Description
Profile = C:\profiles\Mailersend.apip
AuthScheme = APIKey
ProfileSettings = 'APIKey = your_api_token'

Execute SQL to MailerSend

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Mailersend.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_token';')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Activity WHERE DomainId = 'domain123'")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

After connecting to MailerSend in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to MailerSend data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].

Ready to get started?

Connect to live data from MailerSend with the API Driver

Connect to MailerSend