Download the PHP package gmedia/sendgridfinisher without Composer
On this page you can find all versions of the php package gmedia/sendgridfinisher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gmedia/sendgridfinisher
More information about gmedia/sendgridfinisher
Files in gmedia/sendgridfinisher
Package sendgridfinisher
Short Description A Neos.Form finisher for the Sendgrid API
License GPL-3.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sendgridfinisher
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.
Installation
After adding the requirement to your composer.json you can update your composer.lock and install the plugin.
Usage
To use this finisher in your form configuration, you just need to add the following definitions to it:
Templates
To use a Sendgrid template, just add your templateId to options.
Reference
Configuration
To enable email transport, you will need to add your SendGrid API key to your configuration.
Finisher Options
templatePathAndFilename (string)
Defines the resource path to the template of your email content.
subject (string)
Defines the subject of the email.
recipients (array)
You can add multiple recipients.
Each recipient must look like this,
while at least the email parameter must be given.
carbonCopyRecipients (array)
See recipients.
blindCarbonCopyRecipients (array)
See recipients.
senderAddress (string)
Defines the address which will show up as sender.
senderName (string)
Defines the name which will show up as sender.
replyToAddress (string)
Defines the address which will be set as address to receive replys to this mail.
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.
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.
templateId (string)
Defines the id of the template which SendGrid should use to parse your email.
additionalHeaders (array)
Defines additional headers to be sent along to the other headers of the email.
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!
testMode (boolean)
If true, the email will not be sent and you will get a dump of the
email object instead.
attachments (array)
At the moment, we could only test adding resources as attachments. This can be done this way:
A option to send attachments provided by a file upload field in the form will be added later.
All versions of sendgridfinisher with dependencies
neos/form Version ^4.0 || ^5.0
sendgrid/sendgrid Version ^7.3