Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rhukster committed Oct 5, 2022
1 parent 442b56e commit 47fe252
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The **email plugin** for [Grav](http://github.com/getgrav/grav) adds the ability to send email utilizing the `symfony/mailer` package. This is particularly useful for the **admin** and **login** plugins.

> Version 4.0 replaced the old deprecated `SwiftMailer` library with `Symfony/Mailer` package. This is a modern and well supported library that also has the capability to support 3rd party libraries such as `SendGrid`, `MailJet`, `MailGun`, `MailChimp`, etc.
# Installation

The email plugin is easy to install with GPM.
Expand Down Expand Up @@ -40,12 +42,6 @@ The first setting you'd likely change is your `Email from` / `Email to` names an

Also, you'd likely want to setup a SMTP server instead of using PHP Mail, as the latter is not 100% reliable and you might experience problems with emails.

Valid values for `auth_mode` include `plain`, `login`, `cram-md5`, or `null`.

> NOTE: `engine: mail` has been deprecated from the SwiftMail library that this plugin uses as it does not function at all. Please use `smtp` if at all possible, and `sendmail` if SMTP is not an option.
>

## 3rd Party Plugin Support

Along with the **Email** `v4.0` release, there has also been several custom provider plugins released to provide support for `SMTP`, `API`, and sometimes even `HTTPS` support for 3rd party providers such as **Sendgrid**, **MailJet**, **MailGun**, **Amazon SES**, **Mailchimp/Mandrill**, and others! `API` or `HTTPS` will provide a faster email sending experience compared to `SMTP` which is an older protocol and requires more back-and-forth negotiation and communication compared to the single-request of `API` or `HTTPS` solutions.
Expand Down

0 comments on commit 47fe252

Please sign in to comment.