Email Library Extension Hooks

email_from_address($from, $name)

Overwrite an email from address.

How it’s called:

if (ee()->extensions->active_hook('email_from_address')) {
    $processed_address = ee()->extensions->call('email_from_address', $from, $name);
    $from = $processed_address['from'] ?? $from;
    $name = $processed_address['name'] ?? $name;
    
    if (ee()->extensions->end_script === true) {
        return;
    }
}

email_to_address($to)

Overwrite an email to address.

How it’s called:

if (ee()->extensions->active_hook('email_to_address')) {
    $to = ee()->extensions->call('email_to_address', $to);
    
    if (ee()->extensions->end_script === true) {
        return;
    }		
}

email_send(&$data)

Modify email headers, recipients and body data, and optionally take over email sending completely.

How it’s called:

    $ret = ee()->extensions->call(
        'email_send',
        array(
            'headers'       => &$this->_headers,     // Email headers array
            'header_str'    => &$this->_header_str,  // Header string
            'recipients'    => &$this->_recipients,  // Recipients string
            'cc_array'      => &$this->_cc_array,    // CC recipients, populated by Email::cc(), used by SMTP
            'bcc_array'     => &$this->_bcc_array,   // BCC recipients, populated by Email::bcc(), used by SMTP
            'subject'       => &$this->_subject,     // Email subject
            'finalbody'     => &$this->_finalbody    // Final email body text
        )
    );

    if (ee()->extensions->end_script === TRUE)
    {
        return $ret;
    }

Note: If the extension decides to take over sending of the email, end_script should be set to TRUE, and _spool_email will return the extension’s return value, preferably a boolean indicating success or failure