Email Sendgrid Plugin

This README.md file should be modified to describe the features, installation, configuration, and general usage of the plugin.

The Email Sendgrid Plugin is an extension for Grav CMS. Sendgrid integration for new Email plugin

Installation

Installing the Email Sendgrid plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.

GPM Installation (Preferred)

To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:

bin/gpm install email-sendgrid

This will install the Email Sendgrid plugin into your /user/plugins-directory within Grav. Its files can be found under /your/site/grav/user/plugins/email-sendgrid.

Admin Plugin

If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu and clicking on the Add button.

Configuration

Before configuring this plugin, you should copy the user/plugins/email-sendgrid/email-sendgrid.yaml to user/config/plugins/email-sendgrid.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true
transport: api
api_key: 

Note that if you use the Admin Plugin, a file with your configuration named email-sendgrid.yaml will be saved in the user/config/plugins/-folder once the configuration is saved in the Admin.

Usage

The transport can either be api (recommended) or smtp.

Once the options are set, all other configuration regarding email should be done in the main email plugin. You just need to set the engine in the email.yaml configuration:

mailer:
  engine: sendgrid

A default from: and to: address is also required.

Credits

Thanks to the Syfmony team for making this plugin possible.