Deliver Email Through Your Drupal Site on the Pantheon Platform

SendGrid API Integration

export SITE=yoursitename
export ENV=dev

1. Install Composer and Drush, then install and authenticate Terminus.

2. If you haven't done so already, clone your Pantheon site repository and navigate to the project's root directory. If you're using Multidev, checkout that branch:

   cd $SITE
   git checkout $ENV

3. Set the connection mode to Git:

   terminus connection:set $SITE.$ENV git

4. Install the SendGrid Integration module (and its dependencies) and the Composer Vendor module using Drush:

   drush dl sendgrid_integration-7.x-1.3 mailsystem composer_vendor

Start Composer

Now that the module and dependencies are installed, initialize Composer:

1. Initialize composer to create a composer.json file with the Drupal 7 package repository:

   composer init --repository=https://packages.drupal.org/7 --no-interaction

2. Edit the composer.json to add extra configuration that specifies installation paths for Drupal modules, libraries, and themes.

   Info:

   Note

   Since Pantheon does not support Git submodules

   Show more information

   , we recommend using the provided script remove-git-submodules to remove any .git directories upon install and update.

   composer.json

   {
     "repositories": [
       {
         "type": "composer",
         "url": "https://packages.drupal.org/7"
       }
     ],
     "require": {},
     "extra": {
       "installer-paths": {
         "sites/all/modules/{$name}/": ["type:drupal-module"],
         "sites/all/themes/{$name}/": ["type:drupal-theme"],
         "sites/all/libraries/{$name}/": ["type:drupal-library"]
       }
     },
     "scripts": {
       "remove-git-submodules": "find . -mindepth 2 -type d -name .git | xargs rm -rf",
       "post-install-cmd": [
         "@remove-git-submodules"
       ],
       "post-update-cmd": [
         "@remove-git-submodules"
       ]
     },
     "config": {
       "vendor-dir": "sites/all/vendor"
     }
   }

Protect Directory Path

The above configuration specifies setting vendor-dir to sites/all/vendor for compatibility with the Composer Vendor module, but this directory is not a protected path by default. Make this path non-web accessible by adding the following to the pantheon.yml configuration file:

protected_web_paths:
  - /sites/all/vendor

1. Require the SendGrid API Library via Composer:

   composer require fastglass/sendgrid:~1.0

2. Add, commit, and push all of the new files:

   git add .
   git commit -am "Add Sendgrid API Integration"
   git push origin master # or $ENV for multidev

3. Switch the site back to SFTP mode:

   terminus connection:set $SITE.$ENV sftp

4. Enable Composer Vendor, followed by SendGrid Integration. Order is important for this step. SendGrid Integration will refuse to activate if the library file is not autoloaded:

   terminus drush $SITE.$ENV -- en composer_vendor -y
   terminus drush $SITE.$ENV -- en sendgrid_integration -y

5. From within your SendGrid account, navigate to Settings > API Keys and create a site-specific API Key. Click the key to copy it to your keyboard.

6. Visit /admin/config/services/sendgrid once you've logged into your Drupal site as an administrator. Paste your API Key and click Save Settings.

Your Drupal application on Pantheon is now set up to send email through SendGrid's API. Test your configuration from /admin/config/services/sendgrid/test.

cd sites/all
ln -s ../../composer.lock ./composer.lock

SendGrid SMTP Integration

1. Install the SMTP Authentication Support module using the Drupal interface or with Terminus:

   terminus drush <site>.<env> -- en smtp -y

2. Visit /admin/config/system/smtp once you've logged in as the administrator.

3. In Install Options, select On.

4. Use the following within SMTP Server Settings:

   SMTP server: smtp.sendgrid.net

   SMTP port: 2525

   Use encrypted protocol: We strongly recommend selecting TLS

   Info:

   Note

   Configuring mail to use ports 25, 465 or 587 is strongly discouraged because it attracts spam activity. For details, see Email with Drupal on Pantheon

5. Provide your site-specific SendGrid credentials and click Save configuration. Note that subusers are not available on free plans.