ContextQMD
Back to Symfony

SMTP

src/Symfony/Component/Mailer/Bridge/Sendgrid/README.md

8.0.101.6 KB
Original Source

Sendgrid Bridge

Provides Sendgrid integration for Symfony Mailer.

Configuration example:

env
# SMTP
MAILER_DSN=sendgrid+smtp://KEY@default?region=REGION

# API
MAILER_DSN=sendgrid+api://KEY@default?region=REGION

where:

  • KEY is your Sendgrid API Key
  • REGION is Sendgrid selected region (default to global)

Webhook

Create a route:

yaml
framework:
    webhook:
        routing:
            sendgrid:
                service: mailer.webhook.request_parser.sendgrid
                secret: '!SENDGRID_VALIDATION_SECRET!' # Leave blank if you don't want to use the signature validation

And a consume:

php
#[\Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer(name: 'sendgrid')]
class SendGridConsumer implements ConsumerInterface
{
    public function consume(RemoteEvent|MailerDeliveryEvent $event): void
    {
        // your code
    }
}

Suppression Groups

Create an e-mail and add the SuppressionGroupHeader:

php
use Symfony\Component\Mailer\Bridge\Sendgrid\Header\SuppressionGroupHeader;
// [...]
$email = new Email();
$email->getHeaders()->add(new SuppressionGroupHeader(GROUP_ID, GROUPS_TO_DISPLAY));

where:

  • GROUP_ID is your Sendgrid suppression group ID
  • GROUPS_TO_DISPLAY_ID is an array of the Sendgrid suppression group IDs presented to the user

Resources