Version: 1.3.2
Author: Ivan Tcholakov ivantcholakov@gmail.com, 2012-2019.
License: The MIT License (MIT), http://opensource.org/licenses/MIT
This library is intended to be compatible with CI 2.x and CI 3.x.
Tested on CodeIgniter 3.1.11 (September 19th, 2019) and PHPMailer Version 6.1.1 (September 28th, 2019).
Download this package and uncompress it within application/ directory of your CodeIgniter site.
https://github.com/PHPMailer/PHPMailer
- Edit the file
application/config/email.phpwhich contains the default settings for the email engine. For a Gmail account, the setting might be something like this:
<?php defined('BASEPATH') OR exit('No direct script access allowed.');
$config['useragent'] = 'PHPMailer'; // Mail engine switcher: 'CodeIgniter' or 'PHPMailer'
$config['protocol'] = 'smtp'; // 'mail', 'sendmail', or 'smtp'
$config['mailpath'] = '/usr/sbin/sendmail';
$config['smtp_host'] = 'smtp.gmail.com';
$config['smtp_auth'] = true; // Whether to use SMTP authentication, boolean TRUE/FALSE. If this option is omited or if it is NULL, then SMTP authentication is used when both $config['smtp_user'] and $config['smtp_pass'] are non-empty strings.
$config['smtp_user'] = 'yourusername@gmail.com';
$config['smtp_pass'] = 'yourpassword';
$config['smtp_port'] = 587;
$config['smtp_timeout'] = 30; // (in seconds)
$config['smtp_crypto'] = 'tls'; // '' or 'tls' or 'ssl'
$config['smtp_debug'] = 0; // PHPMailer's SMTP debug info level: 0 = off, 1 = commands, 2 = commands and data, 3 = as 2 plus connection status, 4 = low level data output.
$config['debug_output'] = ''; // PHPMailer's SMTP debug output: 'html', 'echo', 'error_log' or user defined function with parameter $str and $level. NULL or '' means 'echo' on CLI, 'html' otherwise.
$config['smtp_auto_tls'] = false; // Whether to enable TLS encryption automatically if a server supports it, even if `smtp_crypto` is not set to 'tls'.
$config['smtp_conn_options'] = array(); // SMTP connection options, an array passed to the function stream_context_create() when connecting via SMTP.
$config['wordwrap'] = true;
$config['wrapchars'] = 76;
$config['mailtype'] = 'html'; // 'text' or 'html'
$config['charset'] = null; // 'UTF-8', 'ISO-8859-15', ...; NULL (preferable) means config_item('charset'), i.e. the character set of the site.
$config['validate'] = true;
$config['priority'] = 3; // 1, 2, 3, 4, 5; on PHPMailer useragent NULL is a possible option, it means that X-priority header is not set at all, see https://github.com/PHPMailer/PHPMailer/issues/449
$config['crlf'] = "\n"; // "\r\n" or "\n" or "\r"
$config['newline'] = "\n"; // "\r\n" or "\n" or "\r"
$config['bcc_batch_mode'] = false;
$config['bcc_batch_size'] = 200;
$config['encoding'] = '8bit'; // The body encoding. For CodeIgniter: '8bit' or '7bit'. For PHPMailer: '8bit', '7bit', 'binary', 'base64', or 'quoted-printable'.
// DKIM Signing
$config['dkim_domain'] = ''; // DKIM signing domain name, for exmple 'example.com'.
$config['dkim_private'] = ''; // DKIM private key, set as a file path.
$config['dkim_private_string'] = ''; // DKIM private key, set directly from a string.
$config['dkim_selector'] = ''; // DKIM selector.
$config['dkim_passphrase'] = ''; // DKIM passphrase, used if your key is encrypted.
$config['dkim_identity'] = ''; // DKIM Identity, usually the email address used as the source of the email.- Notes:
PHP openssl module should be enabled if encrypted SMTP access is required;
Set $config['useragent'] as 'PHPMailer' if the original 'CodeIgniter' engine fails for some reason.
- Within a controller paste the following code for testing purposes:
$this->load->library('email');
$subject = 'This is a test';
$message = '
<p>This message has been sent for testing purposes.</p>
<!-- Attaching an image example - an inline logo. -->
<p><img src="cid:logo_src" /></p>
';
// Get full html:
$body = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=' . strtolower(config_item('charset')) . '" />
<title>' . html_escape($subject) . '</title>
<style type="text/css">
body {
font-family: Arial, Verdana, Helvetica, sans-serif;
font-size: 16px;
}
</style>
</head>
<body>
' . $message . '
</body>
</html>';
// Also, for getting full html you may use the following internal method:
//$body = $this->email->full_html($subject, $message);
// Attaching the logo first.
$file_logo = FCPATH.'apple-touch-icon-precomposed.png'; // Change the path accordingly.
// The last additional parameter is set to true in order
// the image (logo) to appear inline, within the message text:
$this->email->attach($file_logo, 'inline', null, '', true);
$cid_logo = $this->email->get_attachment_cid($file_logo);
$body = str_replace('cid:logo_src', 'cid:'.$cid_logo, $body);
// End attaching the logo.
$result = $this->email
->from('yourusername@gmail.com')
->reply_to('yoursecondemail@somedomain.com') // Optional, an account where a human being reads.
->to('therecipient@otherdomain.com')
->subject($subject)
->message($body)
->send();
var_dump($result);
echo '<br />';
echo $this->email->print_debugger();
exit;Load the corresponding page, executte this code. Check whether an email has been sent. Read the error message, if any, and make corrections in your settings.
Note, that most of the SMTP servers require "from" address of the message to be the same as the address within $config['smtp_user'] setting.
At the end remove this test.
The API of this library is the same as the original Email API. Read the CodeIgniter's manual about Email Class.
When CodeIgniter version is 3.1.0 or greater and PHP version is 5.5 or greater The library tries to find and load PHPMailer 6. Otherwise 5.2.27 ig going to be used, its files are under the directory third_party/phpmailer in this project. If you intend to use PHPMailer 6, you need to use Composer for installing it.
First, you need to have Composer locally or globally installed on your development machine see the instructions for that: https://getcomposer.org/doc/00-intro.md .
Then you need to enable Composer to be used by CodeIgniter. Check this page from its documentation: https://www.codeigniter.com/user_guide/general/autoloader.html . You need to see or decide when your vendor/ directory is (to be) and within the CodeIgniter's configuration file application/config/config.php you need to set the configuration option $config['composer_autoload'] accordingly.
Then, third, add to your composer.json uder the section "require" the following line:
"phpmailer/phpmailer": "^6.1.1"
It might need a comma at the end if the list "require" continues. Or, alternatively from command line interface run the following command:
composer require phpmailer/phpmailer:^6.1.1
The command
composer update
will install or update PHPMailer.
Lately, from your development machine you are to upload on the production server the whole CodeIgniter-based project, together with the files composer.json, composer.lock, and the directory vendor/ . Avoid using Composer on your production server. Composer is a version management tool for developers, its alone is not a deployment tool.
- https://www.youtube.com/watch?v=UGzZ0qyODDo - "Bibliotecas Codeigniter - PHPMailer", Wagner Faria dos Santos