Skip to content

Installation

Requirements

This extension requires:

  • CiviCRM 4.4, 4.6 or higher
  • PHP version 5.4 or higher, with the curl extension enabled

Installation instructions

  1. Configure CiviCRM extensions parameters (if not done already)

    1. Go to Administer > System Settings > Directories, set the CiviCRM Extensions Directory to a folder that is writable by your web server process
    2. Go to Administer > System Settings > Resource URLs, enter the URL to the above directory

  2. Install the SparkPost email extension

    1. Download the latest release of the extension into your extensions folder

    Tip

    We suggest using: git clone https://github.com/cividesk/com.cividesk.email.sparkpost.git

    1. Go to Administer > Customize Data and Screens > Manage Extensions, and click install for this extension

  3. Sign-up for a SparkPost account, then:

    1. Create and verify your sending domain(s) at: https://app.sparkpost.com/domains/list/sending. Within CiviCRM, sending email addresses are managed at:

      1. Administer > Communications > Organization Address and Contact Info,
      2. and Administer > CiviMail > From Email Address.

      So if you define info@example.org as a sending address in CiviCRM, you would need to create and verify the domain example.org in SparkPost.

    2. Create an API key at: https://app.sparkpost.com/account/api-keys

      Attention

      The API key you create should at a minimum be granted the following permissions:

      • Transmissions (Read/Write)
      • Sending Domains (Read/Write)
      • Event Webhooks (Read/Write)
      • Metrics (Read-only)
      • Suppression Lists (Read/Write)

      However, for the sake of simplicity and in order to account for future updates, we advise you to simply grant all permissions to the API key created.

  4. Setup the SparkPost email extension

    1. Go to Administer > System Settings > Outbound Email (SparkPost)
    2. Enter the API key created above and click Save and Send test email
    3. Check the on-screen messages for any error you would need to resolve