How to integrate Sendgrid with Zend framework

Email functionality is a crucial part of modern web applications, whether for sending transactional emails, notifications, or newsletters. If you’re using the Zend Framework and need a reliable email service, SendGrid is a great choice. It provides a robust API, high deliverability rates, and excellent scalability.

In this guide, I’ll walk you through integrating SendGrid with Zend Framework step by step. We’ll cover setting up your SendGrid API key, configuring Zend’s Mail component, and sending emails programmatically. By the end of this tutorial, you’ll have a working implementation ready to use in your Zend application.

Let’s get started!

Install send-grid transport using the following command.

composer require iyngaran/send-grid-transport

After install follow one of these steps:

1. Copy the contents file vendor/iyngaran/send-grid-transport/mail.global.php.dist and put it in your config/autoload/mail.global.php.
2. If this file does not exists in your application, just copy the entire file and place into your config/autoload removing the .dist extension.

Then add your SendGrid API Key. To get your API Key, please visit - https://sendgrid.com/docs/Classroom/Send/How_Emails_Are_Sent/api_keys.html

And also add the test email from-email address, name and to-email address, name.

// config/autoload/mail.global.php

return [
    'mail' => [
        'sendgrid' => [
            'api_key' => 'YOUR_API_KEY',
        ]
    ],
    'test-email' => [
        'from' => [
            'name' => 'Iyngaran Iyathurai',
            'email' => 'test@iyngaran.info'
        ],
        'to' => [
            'name' => 'Your name',
            'email' => 'your email address'
        ]
    ]
];

After all, you must register SendGridTransport module in your config/modules.config.php.

// config/modules.config.php
return [
    'Zend\ServiceManager\Di',
    ....
    'Application',
    'SendGridTransport'
];

Testing

Go to this Url – /send-grid-email to send a test email.

How to use it ?

For example, in a controller.

namespace SendGridTransport\Controller;

use Zend\Mvc\Controller\AbstractActionController;
use SendGridTransport\Mail\Transport\SendGridTransport;

class SendEmailController extends AbstractActionController
{
    private $sendGridTransport;
    private $config;

    public function __construct(SendGridTransport $sendGridTransport, array $config)
    {
        $this->sendGridTransport = $sendGridTransport;
        $this->config = $config;
    }


    public function indexAction()
    {
        $message = new \SendGridTransport\Mail\Message();
        $body = '<strong>Hello :),</strong><BR/> The SendGridTransport is working now :)';
        $message->setBody($body);
        $message->setFrom(
            new \Zend\Mail\Address(
                $this->config['test-email']['from']['email'],
                $this->config['test-email']['from']['name']
            )
        );
        $message->addTo(
            new \Zend\Mail\Address(
                $this->config['test-email']['to']['email'],
                $this->config['test-email']['to']['name']
            )
        );
        $message->setSubject('Testing SendGridTransport - Iyngaran');
        $message->setBodyText('Hello, the SendGridTransport is working now :)');
        print('<pre>');
        print_r($this->sendGridTransport->send($message));
        print('<pre/>');

        return [];
    }
}