Sending emails through Mailgun using Codeigniter (and using Mailgun campaigns)

As a developer and startup founder, I occasionally find myself looking at web apps and thinking either “This is too expensive” or “This doesn’t do exactly what I want.” My solution (for better or worse) is to build what I want myself. And when I’m building a quick app that I’m going to be the primary user of, my framework of choice is Codeigniter. It’s fast to develop in. It’s easy. And, most importantly, it’s stable (so I don’t have to worry about keeping up-to-date with weekly version releases… I’m looking at you, Node.JS).

The past few days I’ve been working on an emailing app. After all, why use something as simple and beautiful as Mailchimp when you can build your own clunky, ugly, Frankenstein version, right?

Anyway, a friend suggested Mailgun, and the free 10,000 emails a month sounded like a good deal, so I figured I’d leave SendGrid behind for a few days.

Overall, I’m unbelievably pleased with Mailgun. It’s a solid system. I might even switch RocketBolt to it. However, troubleshooting it with Codeigniter was a bit more tricky than I’m used to. Turns out not too many people are talking about how to make Mailgun and Codeigniter play nicely together. It’s not difficult. It’s just more difficult than it should be because no one has posted instructions. So I thought I’d give a quick write-up. Future spammers of the world… you’re welcome!

Integrating Mailgun into Codeigniter:

The best way to hook Mailgun into Codeigniter is by using Mailgun’s SMTP integration. Start by creating an email.php file in your application’s “config” folder (if you don’t already have one). In the body, you can paste something like this:

<?php if (!defined('BASEPATH')) exit('No direct script access allowed');

  $config['mailtype'] = 'html';
  $config['charset'] = 'utf-8';

  $config['protocol'] = 'smtp';
  $config['smtp_host'] = 'ssl://smtp.mailgun.org';
  $config['smtp_port'] = 465;
  $config['smtp_user'] = '[your Mailgun SMTP username]';
  $config['smtp_pass'] = '[your Mailgun SMTP password]';
  $config['smtp_timeout'] = '4';
  $config['crlf'] = '\n';
  $config['newline'] = '\r\n';

Here’s a little note to future me: the “$config[‘crlf’]” line is needed to fix a Codeigniter bug that prevents subject lines from being more than 75 characters. (Hey… I said Codeigniter is quick, but I didn’t say it was perfect.)

Once you’ve done that, you’re good to go. Send emails through Codeigniter as normal, and you’ll be burning through those 10,000 free Mailgun emails in no time!

Creating Mailgun campaigns with Codeigniter:

This turned out to be a bit more tricky. Mailgun has a slick campaign tracking system. But, in order to use it, you need to add a custom email header. Turns out Codeigniter doesn’t have a pre-built way of doing that, so you’ll need to extend CI’s email class. As I mentioned at the beginning of this post, the Interwebs are a bit lacking for direct answers about sending campaign headers for Mailgun, but I was able to adapt the solution from an answer about how to do a similar thing for Sendgrid. Here’s what you need to know:

Step 1:

Create a file in your application’s “libraries” folder called “MY_Email.php” and then add the following code:

<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');

  class MY_Email extends CI_Email {

      public function __construct($config = array())
      {
          if (count($config) > 0)
          {
              $this->initialize($config);
          }
          else
          {
              $this->_smtp_auth = ($this->smtp_user == '' AND $this->smtp_pass == '') ? FALSE : TRUE;
              $this->_safe_mode = ((boolean)@ini_get("safe_mode") === FALSE) ? FALSE : TRUE;
          }

          log_message('debug', "Email Class Initialized");
      }

      // this will allow us to add headers whenever we need them
      public function set_header($header, $value)
      {
          $this->_headers[$header] = $value;
      }
  }

Step 2:

Once you’ve done that, adding a Mailgun campaign header is as simple as including the following line of code when you first start constructing your email:

  $this->email->set_header('X-Mailgun-Campaign-Id', [Your Mailgun Campaign ID]);

And that’s it. Just make sure to include that line before setting anything else in the email (for example… if you want an HTML email and are loading a View), otherwise it’ll throw a pleasant “headers already sent” error.

That’s it for today. By the way… how’d you like my first coding tutorial? Not nearly as fun as everything else I write, huh? I also learned that my original theme was terrible for showing code, but I think I’ve finally fixed that. Lucky you!

Share

I teach in Duke University’s Innovation & Entrepreneurship program and founded RocketBolt. I write about startups, pedagogy, entrepreneurship, engineering, and poetry. They’re all related, I promise.

Leave a Reply

Your email address will not be published. Required fields are marked *

Instagram

  • My @dukeinnovation capstone students at @adwerxre learning about #sales, #bizdev, and #closing from one of the best: @cleithe #entrepreneur #hustle #innovation #fieldtrip
  • Kirsten Hamstra, global head of social media @sassoftware, talking about corporate #socialmarketing strategies with my @dukeinnovation class: "A lot of brands think social only belongs in the marketing department, but the companies that are really benefiting from social are the ones that understand how it can help across an organization -- #HR, #recruiting, #R&D, #sales... everything."
  • A mini-reunion of the dorm formerly-known-as-Aycock, 2001. Who wins the award for least-receded hairline? #bluedevils #tildeathdouspartin
  • A little @dukeuniversity alumni love from @natedevil and @raleighsparty's wedding. #truelove #tildeathdouspartin #mawwage
  • Pretty much how I feel after a 7 meeting day. #entrepreneurship #hustling #sales #closing #wheatenterrier #furbaby #exhausted
  • Suggested caption: "I took Dr. Dinin's #learningtofail class and all I got was this stupid power strip." Watch My Story to see what other worthless things my students bartered for during today's failure challenge #entrepreneurship #tradingup #paperclips  #powerstrips
  • Teaching my little girl to #dreambig 🐻😆
  • For some reason, a discussion about the risks of using #socialmedia for professional development while hanging out with @fhi_duke's PhD Lab students seemed like a delightfully ironic time to snap a #selfie. #socialmediamarketing #immature
  • In today's #learningtofail class, we answered the age old question: What happens when 24 @dukeuniversity students go Trick-Or-Treating around campus for one hour on the day before #halloween? See My Story for the answer. Spoiler alert: it ends with almost 5,000 pieces of #candy 🍭 #entrepreneur #trickortreat #sugarhigh
  • When life gives you lemons, throw them away, go buy a 48oz tomahawk ribeye, and grill it up! #steak #sousvide #cholesterol #moo
  • #pumpkincarving with the @dukeinnovation education team. #entrepreneur #teambuilding #halloween #sharpthings
  • Hosted my first dorm dinner tonight. Ate some #chicken and talked #entrepreneurship with the kids from Brownstone. Tried to convince them to stop worrying about which major is going to get them a job and start taking classes they enjoy. After all, as the kids like to say... #yolo 🤣

Follow Me!