CodeIgniter 4 Send Email with SMTP Tutorial

Share this Article
Reading Time: 9 minutes
7,759 Views

Sending Emails with SMTP in any application nowadays very common. In CodeIgniter 4, we have in-built Email library class provided. So, inside this article we will see CodeIgniter 4 send email with smtp configuration.

The process of SMTP configuration to send emails is very simple. We need to configure settings and by the help of which we send emails. Let’s see what we need to configure inside codeigniter 4?

For complete CodeIgniter 4 basics please follow this article to get all things clear from basics.

Learn More –

Let’s get started.


What is Email Class in CodeIgniter 4?

Email class is a in-built library. There are several features available by the help of which we configure emails. CodeIgniter 4 email class have these features

  • Multiple Protocols: Mail, Sendmail, and SMTP
  • TLS and SSL Encryption for SMTP
  • Multiple recipients
  • CC and BCCs
  • HTML or Plaintext email
  • Attachments
  • Word wrapping
  • Priorities
  • BCC Batch Mode, enabling large email lists to be broken into small BCC batches.
  • Email Debugging tools

CodeIgniter 4 Installation

To create a CodeIgniter 4 setup run this given command into your shell or terminal. Please make sure composer should be installed.

$ composer create-project codeigniter4/appstarter codeigniter-4

Assuming you have successfully installed application into your local system.


.env Setup

When we install CodeIgniter 4, we will have env file at root. To use the environment variables means using variables at global scope we need to do env to .env

Either we can do via renaming file as simple as that. Also we can do by terminal command.

Open project in terminal

$ cp env .env

Above command will create a copy of env file to .env file.

Now we are ready to use environment variables.

Enable Development Mode

CodeIgniter starts up in production mode by default. You need to make it in development mode to see any error if you are working with application.

Open .env file from root.

# CI_ENVIRONMENT = production

 // Do it to 
 
CI_ENVIRONMENT = development

Now application is in development mode.


Email Library Class

To use Email library class in codeigniter 4 application, we need to do some email configuration inside Email.php file of /app/Config folder

It’s a class file, where we set some values to class member variables.

After doing all needed configuration settings, we load in application like this before use.

$email = \Config\Services::email();

//... rest code for email

Email Settings Configuration

For email configuration settings, we can use any sending email protocol like mail, sendmail or smtp. Here, we will use SMTP and use Host as Gmail.

Open up the Email.php file from /app/Config folder.

<?php

namespace Config;

use CodeIgniter\Config\BaseConfig;

class Email extends BaseConfig
{
    /**
     * @var string
     */
    public $fromEmail;

    /**
     * @var string
     */
    public $fromName;

    /**
     * @var string
     */
    public $recipients;

    /**
     * The "user agent"
     *
     * @var string
     */
    public $userAgent = 'CodeIgniter';

    /**
     * The mail sending protocol: mail, sendmail, smtp
     *
     * @var string
     */
    public $protocol = 'smtp';

    /**
     * The server path to Sendmail.
     *
     * @var string
     */
    public $mailPath = '/usr/sbin/sendmail';

    /**
     * SMTP Server Address
     *
     * @var string
     */
    public $SMTPHost = "smtp.gmail.com";

    /**
     * SMTP Username
     *
     * @var string
     */
    public $SMTPUser = "xxxx@gmail.com";

    /**
     * SMTP Password
     *
     * @var string
     */
    public $SMTPPass = "xxxxxxxx";

    /**
     * SMTP Port
     *
     * @var integer
     */
    public $SMTPPort = 587;

    /**
     * SMTP Timeout (in seconds)
     *
     * @var integer
     */
    public $SMTPTimeout = 60;

    /**
     * Enable persistent SMTP connections
     *
     * @var boolean
     */
    public $SMTPKeepAlive = false;

    /**
     * SMTP Encryption. Either tls or ssl
     *
     * @var string
     */
    public $SMTPCrypto = 'tls';

    /**
     * Enable word-wrap
     *
     * @var boolean
     */
    public $wordWrap = true;

    /**
     * Character count to wrap at
     *
     * @var integer
     */
    public $wrapChars = 76;

    /**
     * Type of mail, either 'text' or 'html'
     *
     * @var string
     */
    public $mailType = 'text';

    /**
     * Character set (utf-8, iso-8859-1, etc.)
     *
     * @var string
     */
    public $charset = 'UTF-8';

    /**
     * Whether to validate the email address
     *
     * @var boolean
     */
    public $validate = false;

    /**
     * Email Priority. 1 = highest. 5 = lowest. 3 = normal
     *
     * @var integer
     */
    public $priority = 3;

    /**
     * Newline character. (Use "\r\n" to comply with RFC 822)
     *
     * @var string
     */
    public $CRLF = "\r\n";

    /**
     * Newline character. (Use "\r\n" to comply with RFC 822)
     *
     * @var string
     */
    public $newline = "\r\n";

    /**
     * Enable BCC Batch Mode.
     *
     * @var boolean
     */
    public $BCCBatchMode = false;

    /**
     * Number of emails in each BCC batch
     *
     * @var integer
     */
    public $BCCBatchSize = 200;

    /**
     * Enable notify message from server
     *
     * @var boolean
     */
    public $DSN = false;
}

Here, inside this file we have configured all basic settings for sending emails. But one more thing before setting your email address and password to a SMTP details. You need to make it as for LESS SECURE APPS AT YOUR GOOGLE ACCOUNT.

When you go at your given email account settings. You will find a Security Tab. When you click into it –

Next, we need to create a method in controller and call Email service.


Use & Send Email Using Library

We need to create a controller.

Controller Setup

Open project into terminal and run this spark command to create controller.

$ php spark make:controller User

It will create a file User.php inside /app/Controllers folder. Open file and write this code.

<?php

namespace App\Controllers;

use App\Controllers\BaseController;

class User extends BaseController
{
    public function sendMail()
    {
        $email = \Config\Services::email(); // loading for use

        // This is for getting form data while submit
        // $to = $this->request->getVar('user_to');
        // $subject = $this->request->getVar('mail_subject');
        // $message = $this->request->getVar('mail_message');

        $email->setTo("xxxxx@gmail.com");
        $email->setFrom('xxxxx@gmail.com', 'Online Web Tutor Support');
        // If you need to send mail to CC and BCC
        // $email->setCC('another@another-user.com');
        // $email->setBCC('other@other-user.com');

        $email->setSubject("Sample Mail - Online Web Tutor");
        $email->setMessage("This is a sample mail sent by online web tutor for testing");

        if ($email->send()) {
            echo 'Email successfully sent, please check';
        } else {
            $data = $email->printDebugger(['headers']);
            print_r($data);
        }
    }
}

Now, need to set route to call this controller’s method which sends mail.


Add Route

Open Routes.php from /app/Config folder. Add given route into it.

//...

$routes->get("send-mail", "User::sendMail");

//...

Application Testing

Start development server:

$ php spark serve

URL – http://localhost:8080/send-mail

Output

Email successfully sent, please check

We hope this article helped you to learn CodeIgniter 4 Send Email with SMTP in a very detailed way.

Buy Me a Coffee

Online Web Tutor invites you to try Skillshare free for 1 month! Learn CakePHP 4, Laravel APIs Development, CodeIgniter 4, Node Js, etc into a depth level. Master the Coding Skills to Become an Expert in Web Development. So, Search your favourite course and enroll now. Click here to join.

If you liked this article, then please subscribe to our YouTube Channel for PHP & it’s framework, WordPress, Node Js video tutorials. You can also find us on Twitter and Facebook.

Was this post helpful?

3 thoughts on “CodeIgniter 4 Send Email with SMTP Tutorial”

  1. Hi Sanjay,

    Could you please tell me which code snippet plugin you are using to add code on blog?

  2. I do believe all of the ideas you have presented in your post.
    They are really convincing and will definitely work.

    Still, the posts are very quick for beginners. May you please
    extend them a bit from next time? Thank you for the post.

Comments are closed.

Learn Web Development Courses Risk Free @ $5 only.
Web Development Courses @ $5