CodeIgniter 电子邮件打印调试器 - PHP

简介

本文介绍了如何在 CodeIgniter 框架中使用电子邮件打印调试器，以便程序员在调试电子邮件相关问题时更加高效。

安装

1. 将以下文件复制到 CodeIgniter 框架的 application/libraries 目录下。

Email_debugger.php

2. 在 CodeIgniter 框架中的 application/config/email.php 配置文件中添加以下配置。

$config['smtp_debug'] = TRUE;

3. 在需要使用该调试器的控制器中，加载该库文件。

$this->load->library('email_debugger');

使用

在使用 CodeIgniter 框架发送电子邮件的时候，如果需要打印调试信息，可以使用 $this->email->print_debugger() 方法，该方法会输出当前电子邮件发送的完整调试信息。而使用本调试器，将会在控制台中以更加友好的格式展示调试信息，同时也能够将调试信息记录到文本文件中，方便后续检查。

要使用本调试器，只需要将调用 $this->email->print_debugger() 方法的地方改为 $this->email_debugger->print_debugger() 即可。

代码片段

Email_debugger.php

<?php

class Email_debugger
{
    private $CI;
    private $enabled = true;
    private $debug = array();
    private $log_path = '';

    public function __construct()
    {
        $this->CI =& get_instance();
        $this->CI->load->library('email');
        $this->log_path = $this->CI->config->item('email_log_path');
        if(empty($this->log_path))
            $this->log_path = APPPATH . 'logs/email_log.txt';
        $this->enabled = $this->CI->config->item('smtp_debug');
        $this->debug['path'] = $this->log_path;
    }

    public function print_debugger()
    {
        $this->CI->email->print_debugger();
        if($this->enabled)
        {
            $debug = $this->CI->email->get_debugger();
            $this->debug['debugger'] = $debug;
            $this->debug_to_log();
            echo "<pre>".print_r($debug, true)."</pre>";
        }
    }

    private function debug_to_log() 
    {
        $log_data = date('Y-m-d H:i:s') . " - Email Debug:\n";
        $log_data .= $this->debug['debugger'] . "\n\n";
        if(!file_exists($this->log_path))
            $this->write_file('', $this->log_path);
        $temp_file = $this->log_path.'_temp';
        $this->write_file($log_data, $temp_file, 'a');
        @rename($temp_file, $this->log_path);
    }

    private function write_file($data, $filename, $mode = 'wb')
    {
        if ( ! $fp = @fopen($filename, $mode))
        {
            return false;
        }

        flock($fp, LOCK_EX);

        fwrite($fp, $data);
        flock($fp, LOCK_UN);
        fclose($fp);

        return true;
    }
}

使用示例

$this->load->library('email_debugger');
$this->email->initialize([
    'protocol' => 'smtp',
    'smtp_host' => 'smtp.qq.com',
    'smtp_user' => 'example@qq.com',
    'smtp_pass' => 'password',
    'smtp_port' => '465',
    'smtp_crypto' => 'ssl',
    'mailtype' => 'html',
    'charset' => 'utf-8'
]);
$this->email->to('foo@example.com');
$this->email->from('bar@example.com');
$this->email->subject('Testing email sending');
$this->email->message('This is a test email');
$this->email->send();
// 使用调试器打印调试信息，而不是原本的 $this->email->print_debugger() 方法
$this->email_debugger->print_debugger();

结语

本调试工具将会以更加友好的方式展示电子邮件发送调试信息，对于需要调试电子邮件发送问题的程序员来说，是一个非常不错的工具。