Skip to content

Support custom email headers via sendRawEmail #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joehoyle wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Support custom email headers via sendRawEmail #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 80 additions & 1 deletion inc/class-ses.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,20 @@ public function send_wp_mail( $to, $subject, $message, $headers = [], $attachmen
}

$args = apply_filters( 'aws_ses_wp_mail_ses_send_message_args', $args, $message_args );
$result = $ses->sendEmail( $args );

// Check for custom headers that sendEmail doesn't support.
// If present, use sendRawEmail to preserve them (e.g. List-Unsubscribe).
$standard_headers = [ 'Content-Type', 'From', 'Reply-To', 'Cc', 'Bcc' ];
$custom_headers = array_diff_key(
$message_args['headers'],
array_flip( $standard_headers )
);

if ( ! empty( $custom_headers ) ) {
$result = $this->send_raw_email( $ses, $args, $message_args, $custom_headers );
} else {
$result = $ses->sendEmail( $args );
}
} catch ( Exception $e ) {
$error = new WP_Error( 'wp_mail_failed', $e->getMessage() );

Expand All @@ -228,6 +241,72 @@ public function send_wp_mail( $to, $subject, $message, $headers = [], $attachmen
return true;
}

/**
* Send an email using sendRawEmail to support custom headers.
*
* Used when headers like List-Unsubscribe are present, which
* the structured sendEmail API doesn't support.
*
* @param SesClient $ses The SES client.
* @param array $args The sendEmail args (for Source, Destination, etc).
* @param array $message_args The processed wp_mail message args.
* @param array $custom_headers Additional headers to include.
* @return \Aws\Result The SES response.
*/
private function send_raw_email( SesClient $ses, array $args, array $message_args, array $custom_headers ) {
$charset = get_bloginfo( 'charset' );

// Build MIME headers.
$mime = '';
$mime .= 'From: ' . $args['Source'] . "\r\n";
$mime .= 'To: ' . implode( ', ', $args['Destination']['ToAddresses'] ) . "\r\n";

if ( ! empty( $args['Destination']['CcAddresses'] ) ) {
$mime .= 'Cc: ' . implode( ', ', $args['Destination']['CcAddresses'] ) . "\r\n";
}

if ( ! empty( $args['ReplyToAddresses'] ) ) {
$mime .= 'Reply-To: ' . implode( ', ', $args['ReplyToAddresses'] ) . "\r\n";
}

$mime .= 'Subject: =?' . $charset . '?B?' . base64_encode( $message_args['subject'] ) . "?=\r\n";
$mime .= 'MIME-Version: 1.0' . "\r\n";

// Add custom headers (List-Unsubscribe, etc).
foreach ( $custom_headers as $name => $value ) {
$mime .= $name . ': ' . $value . "\r\n";
}

// Content type and body.
if ( isset( $message_args['html'] ) ) {
$mime .= 'Content-Type: text/html; charset=' . $charset . "\r\n";
$mime .= "\r\n";
$mime .= $message_args['html'];
} else {
$mime .= 'Content-Type: text/plain; charset=' . $charset . "\r\n";
$mime .= "\r\n";
$mime .= $message_args['text'] ?? '';
}

$raw_args = [
'Source' => $args['Source'],
'Destinations' => $args['Destination']['ToAddresses'],
'RawMessage' => [
'Data' => $mime,
],
];

if ( ! empty( $args['ConfigurationSetName'] ) ) {
$raw_args['ConfigurationSetName'] = $args['ConfigurationSetName'];
}

if ( ! empty( $args['Tags'] ) ) {
$raw_args['Tags'] = $args['Tags'];
}

return $ses->sendRawEmail( $raw_args );
}

/**
* Get the client for AWS SES.
*
Expand Down