Automate EmailOctopus Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access EmailOctopus data from PowerShell? This article demonstrates how to utilize the EmailOctopus Cmdlets for tasks like connecting to EmailOctopus data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to EmailOctopus.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for EmailOctopus; this tutorial shows how to use the Provider to retrieve EmailOctopus data.

Once you have acquired the necessary connection properties, accessing EmailOctopus data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the EmailOctopus Profile on disk (e.g. C:\profiles\EmailOctopus.apip). Next, set the ProfileSettings connection property to the connection string for EmailOctopus (see below).

EmailOctopus API Profile Settings

Sign into your EmailOctopus account and navigate to Integrations & API > API > Your API Keys to generate or retrieve your API key.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to EmailOctopus:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\EmailOctopus.apip;ProfileSettings='APIKey=your_api_key';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT CampaignId, ContactId from CampaignReportBounced"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.campaignid $_.contactid
    }
      

Ready to get started?

Connect to live data from EmailOctopus with the API Driver

Connect to EmailOctopus