PHP IMAP自动导入邮件到WordPress文章

本教程详细阐述如何利用PHP的IMAP扩展，结合自定义类解析邮件内容，并将其结构化地导入WordPress自定义文章类型。通过集成Email_reader类和wp_insert_post函数，实现邮件标题、正文及元数据到WordPress文章的自动化转换与存储，从而高效管理外部邮件数据。

在许多应用场景中，我们需要将外部邮件数据集成到WordPress后台进行统一管理，例如将客户的邮件咨询导入为工单，或将特定邮件内容存储为可编辑的文章。本教程将指导您如何通过PHP的IMAP扩展读取邮件，并将其内容、标题及相关元数据自动导入到WordPress的自定义文章类型中。

1. 邮件提取与解析

首先，我们需要一个PHP类来处理与IMAP服务器的连接、邮件读取和解析。以下是一个示例Email_reader类，它封装了基本的IMAP操作。

class Email_reader {

    // imap server connection
    public $conn;

    // inbox storage and inbox message count
    private $inbox;
    private $msg_cnt;

    // email login credentials
    private $server = 'myserver.com'; // 您的IMAP服务器地址
    private $user   = 'your_email@myserver.com'; // 您的邮箱地址
    private $pass   = 'YOUR_PASSWORD'; // 您的邮箱密码
    private $port   = 993; // IMAP端口，通常是993（SSL）或143

    /**
     * 构造函数：连接到服务器并读取收件箱邮件
     */
    function __construct() {
        $this->connect();
        $this->inbox();
    }

    /**
     * 关闭服务器连接
     */
    function close() {
        $this->inbox = array();
        $this->msg_cnt = 0;
        if ($this->conn) {
            imap_close($this->conn);
        }
    }

    /**
     * 打开服务器连接
     * 注意：imap_open 函数的参数需要根据您的IMAP服务器配置进行调整。
     * 示例中的 '{'.$this->server.'/notls}' 适用于某些特定服务器（如Dreamhost），
     * 您可能需要改为 '{'.$this->server.':'.$this->port.'/imap/ssl/novalidate-cert}' 等。
     */
    function connect() {
        // 建议根据实际服务器配置调整连接字符串
        $connection_string = '{'.$this->server.':'.$this->port.'/imap/ssl/novalidate-cert}INBOX'; 
        // 原始示例：$this->conn = imap_open('{'.$this->server.'/notls}', $this->user, $this->pass);
        $this->conn = imap_open($connection_string, $this->user, $this->pass);

        if (!$this->conn) {
            throw new Exception('IMAP连接失败: ' . imap_last_error());
        }
    }

    /**
     * 将邮件移动到指定文件夹
     *
     * @param int $msg_index 邮件索引
     * @param string $folder 目标文件夹名称，例如 'INBOX.Processed'
     */
    function move($msg_index, $folder='INBOX.Processed') {
        if ($this->conn) {
            imap_mail_move($this->conn, $msg_index, $folder);
            imap_expunge($this->conn); // 清除已标记为删除的邮件
            $this->inbox(); // 重新读取收件箱
        }
    }

    /**
     * 获取指定索引的邮件内容
     *
     * @param int|null $msg_index 邮件索引 (1 = 第一封邮件, 2 = 第二封邮件, 等)
     * @return array 邮件数据数组
     */
    function get($msg_index=NULL) {
        if (count($this->inbox) <= 0) {
            return array();
        }
        elseif ( ! is_null($msg_index) && isset($this->inbox[$msg_index - 1])) { // 数组索引是从0开始
            return $this->inbox[$msg_index - 1];
        }

        return $this->inbox[0]; // 默认返回第一封邮件
    }

    /**
     * 获取收件箱邮件总数
     *
     * @return int 邮件总数
     */
    function total_msg() {
        return $this->msg_cnt;
    }

    /**
     * 读取收件箱邮件并存储到 $inbox 属性
     */
    function inbox() {
        if (!$this->conn) {
            return;
        }
        $this->msg_cnt = imap_num_msg($this->conn);

        $in = array();
        for($i = 1; $i <= $this->msg_cnt; $i++) {
            $in[] = array(
                'index'     => $i,
                'header'    => imap_headerinfo($this->conn, $i),
                'body'      => imap_body($this->conn, $i),
                'structure' => imap_fetchstructure($this->conn, $i)
            );
        }

        $this->inbox = $in;
    }
}

// 实例化 Email_reader 类以开始读取邮件
try {
    $emails = new Email_reader;
} catch (Exception $e) {
    error_log($e->getMessage()); // 记录错误日志
    die('邮件读取器初始化失败。');
}

// 示例：查看读取到的邮件对象
// var_dump($emails);

代码说明：

• $server, $user, $pass, $port：请根据您的邮箱服务提供商信息进行配置。
• connect() 方法中的连接字符串是关键，它决定了如何连接到IMAP服务器。示例中给出了一个更通用的SSL连接字符串，您可能需要根据实际情况调整。
• inbox() 方法遍历所有邮件，获取每封邮件的header（头部信息）、body（正文）和structure（结构信息）。
• get($msg_index) 方法用于获取特定索引的邮件。请注意，imap_num_msg返回的索引是从1开始，而PHP数组索引是从0开始，因此在get方法中进行了$msg_index - 1的调整。

2. 将邮件数据导入WordPress自定义文章类型

在成功提取和解析邮件数据后，下一步是将其导入到WordPress的自定义文章类型中。在执行此步骤之前，请确保您已经注册了一个自定义文章类型（例如，本教程中假设为faqpress_email）。

// 确保在WordPress环境中运行此代码，例如在主题的functions.php或自定义插件中
if ( ! function_exists('wp_insert_post') ) {
    // 如果不在WordPress环境中，需要手动加载WordPress核心
    require_once( $_SERVER['DOCUMENT_ROOT'] . '/wp-load.php' );
}

// 假设 $emails 对象已由 Email_reader 类实例化并读取了邮件
// $emails = new Email_reader; // 如果 $emails 对象尚未实例化，请取消注释此行

$total_messages = $emails->total_msg(); 

for ($j = 1; $j <= $total_messages; $j++) { 
   $mail = $emails->get($j);

    // 检查邮件是否已存在，避免重复导入
    // 可以通过邮件的唯一标识符（如Msgno）进行检查
    $existing_posts = get_posts(array(
        'post_type'  => 'faqpress_email', // 您的自定义文章类型slug
        'meta_key'   => 'ticket_id',
        'meta_value' => $mail['header']->Msgno,
        'posts_per_page' => 1,
        'fields'     => 'ids',
    ));

    if ( ! empty($existing_posts) ) {
        // 邮件已存在，跳过导入
        continue;
    }

    // 准备要插入的文章数据
    $post_array = array( 
        'post_content'  => wp_kses_post($mail['body']), // 过滤HTML内容，防止XSS攻击
        'post_title'    => sanitize_text_field($mail['header']->subject), // 清理标题
        'post_type'     => 'faqpress_email', // 替换为您的自定义文章类型 slug
        'post_status'   => 'publish', // 发布状态
        'meta_input'    => array(
            'from_address'  => sanitize_email($mail['header']->fromaddress), // 发件人地址
            'email_date'    => date('Y-m-d H:i:s', strtotime($mail['header']->Date)), // 邮件日期，格式化
            'ticket_id'     => intval($mail['header']->Msgno), // 邮件的唯一消息编号
            // 您可以根据需要添加更多自定义字段
        ),
    );

    // 插入文章
    $post_id = wp_insert_post($post_array); 

    if ( is_wp_error($post_id) ) {
        error_log('导入邮件失败: ' . $post_id->get_error_message());
    } else {
        // 邮件导入成功后，可以选择将其移动到已处理文件夹
        // $emails->move($j, 'INBOX.Processed'); 
        // error_log('邮件导入成功，文章ID: ' . $post_id . '，邮件主题: ' . $post_array['post_title']);
    }
}

// 完成所有操作后关闭IMAP连接
$emails->close();

代码说明：

• wp_insert_post($post_array): 这是WordPress核心函数，用于创建新的文章或自定义文章类型。
• $post_array: 这是一个关联数组，包含了新文章的所有属性：
  • post_content: 邮件正文。使用wp_kses_post()进行清理，以移除潜在的恶意HTML代码。
  • post_title: 邮件主题。使用sanitize_text_field()进行清理。
  • post_type: 您注册的自定义文章类型的 slug。在示例中是faqpress_email。
  • post_status: 文章状态，通常设置为publish。
  • meta_input: 这是一个包含自定义字段（post meta）的数组。您可以将邮件的任何头部信息（如发件人、日期、消息ID）存储为自定义字段，以便后续查询和展示。
    • from_address: 邮件发件人地址。
    • email_date: 邮件发送日期。
    • ticket_id: 邮件的唯一消息编号，可用于防止重复导入。
• 重复导入检查: 在循环内部，通过get_posts查询ticket_id（邮件的Msgno）是否存在来避免重复导入同一封邮件。
• 错误处理: wp_insert_post在失败时会返回WP_Error对象，应进行检查并记录错误。
• 邮件处理: 导入成功后，您可以选择调用$emails->move($j, 'INBOX.Processed');将已处理的邮件移动到IMAP服务器上的其他文件夹，以避免重复处理或保持收件箱整洁。

3. 注意事项

• IMAP凭据安全: 将IMAP服务器的用户名和密码直接硬编码在代码中存在安全风险。在生产环境中，应考虑使用WordPress的选项API、环境变量或更安全的配置方式来存储这些敏感信息。
• 错误处理与日志: 在IMAP连接、邮件读取和WordPress文章插入过程中，都可能发生错误。务必添加健壮的错误处理机制和日志记录，以便于调试和监控。
• 性能考量: 如果需要处理大量邮件，一次性读取所有邮件并循环导入可能会导致性能问题或超时。考虑分批处理邮件，或将导入过程作为后台任务（例如通过WP-Cron）执行。
• 自定义文章类型注册: 在运行导入代码之前，请确保您的自定义文章类型（例如faqpress_email）已经正确注册。如果尚未注册，您可以使用register_post_type()函数在主题的functions.php或自定义插件中进行注册。
• 邮件内容解析: imap_body()函数返回的邮件正文可能是纯文本、HTML或其他MIME类型。您可能需要根据邮件的structure进一步解析和处理邮件正文，例如提取特定部分或转换为统一格式。
• 邮件附件: 本教程未涉及邮件附件的处理。如果需要处理附件，您需要解析邮件结构，提取附件信息，并将其保存到服务器或WordPress媒体库中，然后将附件的URL或ID存储为文章的自定义字段。
• 服务器配置: 确保您的PHP环境已启用imap扩展。您可以通过phpinfo()检查。

总结

通过上述步骤，您可以构建一个强大的系统，将外部邮件内容自动导入到WordPress自定义文章类型中。这不仅提高了数据管理的效率，还为基于邮件内容的进一步开发（如工单系统、FAQ管理等）奠定了基础。请根据您的具体需求调整代码中的服务器设置、自定义文章类型slug和元数据字段，并务必注意生产环境中的安全性和性能考量。