This project is not affiliated with SendGrid, Inc.

Use the issue tracker located at Drupal.org for bug reports or questions about this module. If you want more info about SendGrid services, contact SendGrid.

This module uses a PHP wrapper library for the SendGrid API. This library supports v3 of the API.

This module overrides default email sending behaviour and sending emails through SendGrid Transactional Email service instead. Emails are sent via a web service and does not function like SMTP therefore there are certain caveats with other email formatting modules. Read below for details.

Failures to send are re-queued for sending later. Queue of failed messages are run on a 60 minute interval.

Mailsystem - A module to create an agnostic management layer for Mail. Very useful for controlling the mail system on Drupal.

PHP dependencies for this module are loaded via Composer in Drupal 8.

Before starting your installation, be aware that this module uses composer to load dependencies. In Drupal 8, there are different ways to configure your site to use composer for contributed modules.

As of recent changes with Drush for Drupal 8.4, there is no option to download a module with Drush. All downloading of modules now resides with composer.

Installation via command line and composer:

1. Start at the root of your Drupal 8 installation and issue the command composer require drupal/sendgrid_integration.

2. The module will be downloaded from Drupal.org, the dependent API wrapper will be downloaded from Github, and your main composer.json will be updated.

3. Navigate to Modules and enable SendGrid Integration in the Mail category.

4. Configure your SendGrid API-Key in admin/config/services/sendgrid

5. Confirm that the mail system is setup to use Sendgrid for how you wish to run you website. If you want it all to run through Sendgrid then you set the System-wide default MailSystemInterface class to "SendGridMailSystem". As an example, see this image.

• Composer Documentation: https://getcomposer.org/doc/

• We are going to update the D8 version of this module to allow for an optional manual installation of the API wrapper.

In order to send HTML email. Your installation of Drupal must generate an email with the proper headers. Sendgrid Integration modules looks for the content type of the email to be set to "text/html" in the header (i.e. "Content-Type"="text/html"). A text version of the email is also sent at the same time.

If the message does not have the content type set to "text/html" the message will be stripped of any tags and converted to text.

We recommend using the module HTMLmail for HTML formatting of emails. This module allows for easy templating of emails and it sets the correct header on emails (text/html).

We do not recommend MIMEmail module because it sets the content-type header of a message to "multipart/mixed" instead of strictly "text/html". In addition, the MIMEmail module attempts to template emails and include inline CSS that is not compatible with SendGrid template system. If you want to use MIMEmail, we suggest using the SMTP module and not this module.

If you want to work on a solution for MIMEmail and contribute it back to the module, we gladly accept community contributions!

In order to use this module, follow the installation instructions above. If advanced functionality is needed (such as the use of Sendgrid's hosted templates), then values can be added into a hook_mail() method and set values as follows:

$message['sendgrid']['substitutions']['custom_value'] = 'Custom value';

Then in Sendgrid, using the handlebar notation, adding the tag {{custom_value}} within your template will substitute the value from Drupal into the template.

This method is good for global variables.

See Sendgrid's online documentation for available values. https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html

If sending email fails with certain (predefined) response codes the message be added to Cron Queue for later delivery. In order for this to function, you must configure Cron running period and when it is possible also add your drupal site to crontab (Linux only), read more about cron at https://www.drupal.org/cron.

If you would like a record of the emails being sent by the website, installing Maillog (https://www.drupal.org/project/maillog) will allow you to store local copies of the emails sent. Sendgrid does not store the content of the email.

Debugging this module while installed can be done by installing the Maillog module (https://www.drupal.org/project/maillog). This module will allow you to store the emails locally before they are sent and view the message generated in the Sendgrid email object.

Sendgrid also provides a status page that can help when tracking down deliverability issues. http://status.sendgrid.com/

Information about the Sendgrid PHP Library is available on Github: https://github.com/taz77/sendgrid-php-ng