gmedia/sendgridfinisher

A Neos.Form finisher for the Sendgrid API

SendGrid Finisher for Neos.Form

A set of Neos.Form finishers for Sendgrid, using the official SendGrid library. With this package you now can send emails via Sendgrid not only through the SMTP-API and the conventional Neos.Form email finisher, but also directly using their library. This enables you to use custom templates, additional headers, variables and many more to send pretty-looking emails directly from your Neos installation., _(*1)

Installation

composer require --no-update gmedia/sendgridfinisher

After adding the requirement to your composer.json you can update your composer.lock and install the plugin., _(*2)

composer update

Usage

To use this finisher in your form configuration, you just need to add the following definitions to it:, _(*3)

finishers:
  -
    identifier: 'Gmedia.SendgridFinisher:EmailFinisher'
    options:
      templatePathAndFilename: 'resource://Neos.Demo/Private/Templates/ContactForm/Email.txt'
      subject: 'Contact from neos.io'
      recipients:
        - name: 'John Doe'
          email: 'john.doe@neos.io'
      senderAddress: 'demo@neos.io'
      senderName: 'Neos Demo Site'
      replyToAddress: 'demo-reply@neos.io'
      attachments:
        - resource: 'resource://Neos.Demo/Private/Templates/ContactForm/Email.txt'

Templates

To use a Sendgrid template, just add your templateId to options., _(*4)

Reference

Configuration

To enable email transport, you will need to add your SendGrid API key to your configuration., _(*5)

Gmedia:
  SendgridFinisher:
    apiKey: ''

Finisher Options

templatePathAndFilename (string)

Defines the resource path to the template of your email content., _(*6)

subject (string)

Defines the subject of the email., _(*7)

recipients (array)

You can add multiple recipients. Each recipient must look like this, while at least the email parameter must be given., _(*8)

recipients:
  -  'email': 'john@doe.com'
     'name': 'John Doe'

carbonCopyRecipients (array)

See recipients., _(*9)

blindCarbonCopyRecipients (array)

See recipients., _(*10)

senderAddress (string)

Defines the address which will show up as sender., _(*11)

senderAddress: 'john.doe@neos.io'

senderName (string)

Defines the name which will show up as sender., _(*12)

senderName: 'John Doe'

replyToAddress (string)

Defines the address which will be set as address to receive replys to this mail., _(*13)

replyToAddress: 'john.doe@neos.io'

substitutions (array)

SendGrid enables you to use variables in your templates, called substitutions. In this array you can define the key-value-pairs used to render the template., _(*14)

'substitutions': 
  '%sub1%': 'Johnny'
  '%sub2%': 'Hello World'

trackingSettings

You can adjust the tracking settings by adding the following options as required. For more information about this options, please refer to the official SendGrid API reference., _(*15)

'trackingSettings':
  'click_tracking':
    'enable': false
    'enable_text': ''
  'open_tracking':
    'enable': false
    'substitution_tag': ''
  'subscription_tracking':
    'enable': false
    'text': ''
    'html': ''
    'substitution_tag': ''
  'ganalytics':
    'enable': false
    'utm_source': ''
    'utm_medium': ''
    'utm_term': ''
    'utm_content': ''
    'utm_campaign': ''

templateId (string)

Defines the id of the template which SendGrid should use to parse your email., _(*16)

additionalHeaders (array)

Defines additional headers to be sent along to the other headers of the email., _(*17)

format (string)

Defines the format of the email to be sent. It can either be plaintext or html. Notice: plaintext will break HTML-behaviour of your SendGrid template if set!, _(*18)

testMode (boolean)

If true, the email will not be sent and you will get a dump of the email object instead., _(*19)

attachments (array)

At the moment, we could only test adding resources as attachments. This can be done this way:, _(*20)

attachments:
  - resource: 'resource://Vendor.Site/Private/Folder/Resource.ext'

A option to send attachments provided by a file upload field in the form will be added later., _(*21)