mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
426 lines
14 KiB
PHP
426 lines
14 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Mailer objects are responsible for actually sending emails.
|
||
|
|
* The default Mailer class will use PHP's mail() fun
|
||
|
|
* However, it
|
||
|
|
* One Email::set_mailer();
|
||
|
|
*/
|
||
|
|
class Mailer extends Object {
|
||
|
|
/**
|
||
|
|
* Send a plain-text email
|
||
|
|
*/
|
||
|
|
function sendPlain($to, $from, $subject, $plainContent, $attachedFiles = false, $customheaders = false) {
|
||
|
|
return plaintextEmail($to, $from, $subject, $htmlContent, $attachedFiles, $customheaders);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Send a multi-part HTML email
|
||
|
|
*/
|
||
|
|
function sendHTML($to, $from, $subject, $htmlContent, $attachedFiles = false, $customheaders = false, $plainContent = false, $inlineImages = false) {
|
||
|
|
return htmlEmail($to, $from, $subject, $htmlContent, $attachedFiles, $customheaders, $plainContent, $inlineImages);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// TO DO: Clean this code up, make it more OO.
|
||
|
|
// For now, we've just put a clean interface around this dirty code :)
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Sends an email as a both HTML and plaintext
|
||
|
|
* $attachedFiles should be an array of file names
|
||
|
|
* - if you pass the entire $_FILES entry, the user-uploaded filename will be preserved
|
||
|
|
* use $plainContent to override default plain-content generation
|
||
|
|
*/
|
||
|
|
function htmlEmail($to, $from, $subject, $htmlContent, $attachedFiles = false, $customheaders = false, $plainContent = false, $inlineImages = false) {
|
||
|
|
if ($customheaders && is_array($customheaders) == false) {
|
||
|
|
echo "htmlEmail($to, $from, $subject, ...) could not send mail: improper \$customheaders passed:<BR>";
|
||
|
|
dieprintr($headers);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
$subjectIsUnicode = (strpos($subject,"&#") !== false);
|
||
|
|
$bodyIsUnicode = (strpos($htmlContent,"&#") !== false);
|
||
|
|
$plainEncoding = "";
|
||
|
|
|
||
|
|
// We generate plaintext content by default, but you can pass custom stuff
|
||
|
|
$plainEncoding = '';
|
||
|
|
if(!$plainContent) {
|
||
|
|
$plainContent = Convert::xml2raw($htmlContent);
|
||
|
|
if(isset($bodyIsUnicode) && $bodyIsUnicode) $plainEncoding = "base64";
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// If the subject line contains extended characters, we must encode the
|
||
|
|
$subject = Convert::xml2raw($subject);
|
||
|
|
if(isset($subjectIsUnicode) && $subjectIsUnicode)
|
||
|
|
$subject = "=?UTF-8?B?" . base64_encode($subject) . "?=";
|
||
|
|
|
||
|
|
|
||
|
|
// Make the plain text part
|
||
|
|
$headers["Content-Type"] = "text/plain; charset=\"utf-8\"";
|
||
|
|
$headers["Content-Transfer-Encoding"] = $plainEncoding ? $plainEncoding : "quoted-printable";
|
||
|
|
|
||
|
|
$plainPart = processHeaders($headers, ($plainEncoding == "base64") ? chunk_split(base64_encode($plainContent),60) : wordwrap($plainContent,120));
|
||
|
|
|
||
|
|
// Make the HTML part
|
||
|
|
$headers["Content-Type"] = "text/html; charset=\"utf-8\"";
|
||
|
|
|
||
|
|
|
||
|
|
// Add basic wrapper tags if the body tag hasn't been given
|
||
|
|
if(stripos($htmlContent, '<body') === false) {
|
||
|
|
$htmlContent =
|
||
|
|
"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\n" .
|
||
|
|
"<HTML><HEAD>\n" .
|
||
|
|
"<META http-equiv=Content-Type content=\"text/html; charset=utf-8\">\n" .
|
||
|
|
"<STYLE type=3Dtext/css></STYLE>\n\n".
|
||
|
|
"</HEAD>\n" .
|
||
|
|
"<BODY bgColor=#ffffff>\n" .
|
||
|
|
$htmlContent .
|
||
|
|
"\n</BODY>\n" .
|
||
|
|
"</HTML>";
|
||
|
|
}
|
||
|
|
|
||
|
|
if($inlineImages) {
|
||
|
|
$htmlPart = wrapImagesInline($htmlContent);
|
||
|
|
} else {
|
||
|
|
$headers["Content-Transfer-Encoding"] = "quoted-printable";
|
||
|
|
$htmlPart = processHeaders($headers, wordwrap(QuotedPrintable_encode($htmlContent),120));
|
||
|
|
}
|
||
|
|
|
||
|
|
list($messageBody, $messageHeaders) = encodeMultipart(array($plainPart,$htmlPart), "multipart/alternative");
|
||
|
|
|
||
|
|
// Messages with attachments are handled differently
|
||
|
|
if($attachedFiles && is_array($attachedFiles)) {
|
||
|
|
|
||
|
|
// The first part is the message itself
|
||
|
|
$fullMessage = processHeaders($messageHeaders, $messageBody);
|
||
|
|
$messageParts = array($fullMessage);
|
||
|
|
|
||
|
|
// Include any specified attachments as additional parts
|
||
|
|
foreach($attachedFiles as $file) {
|
||
|
|
if($file['tmp_name'] && $file['name']) {
|
||
|
|
$messageParts[] = encodeFileForEmail($file['tmp_name'], $file['name']);
|
||
|
|
} else {
|
||
|
|
$messageParts[] = encodeFileForEmail($file);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// We further wrap all of this into another multipart block
|
||
|
|
list($fullBody, $headers) = encodeMultipart($messageParts, "multipart/mixed");
|
||
|
|
|
||
|
|
// Messages without attachments do not require such treatment
|
||
|
|
} else {
|
||
|
|
$headers = $messageHeaders;
|
||
|
|
$fullBody = $messageBody;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Email headers
|
||
|
|
$headers["From"] = validEmailAddr($from);
|
||
|
|
|
||
|
|
// Messages with the X-SilverStripeMessageID header can be tracked
|
||
|
|
if(isset($customheaders["X-SilverStripeMessageID"]) && defined('BOUNCE_EMAIL')) {
|
||
|
|
$bounceAddress = BOUNCE_EMAIL;
|
||
|
|
// Get the human name from the from address, if there is one
|
||
|
|
if(ereg('^([^<>]+)<([^<>])> *$', $from, $parts))
|
||
|
|
$bounceAddress = "$parts[1]<$bounceAddress>";
|
||
|
|
} else {
|
||
|
|
$bounceAddress = $from;
|
||
|
|
}
|
||
|
|
|
||
|
|
// $headers["Sender"] = $from;
|
||
|
|
$headers["X-Mailer"] = X_MAILER;
|
||
|
|
if (!isset($customheaders["X-Priority"])) $headers["X-Priority"] = 3;
|
||
|
|
|
||
|
|
$headers = array_merge((array)$headers, (array)$customheaders);
|
||
|
|
|
||
|
|
// the carbon copy header has to be 'Cc', not 'CC' or 'cc' -- ensure this.
|
||
|
|
if (isset($headers['CC'])) { $headers['Cc'] = $headers['CC']; unset($headers['CC']); }
|
||
|
|
if (isset($headers['cc'])) { $headers['Cc'] = $headers['cc']; unset($headers['cc']); }
|
||
|
|
|
||
|
|
// the carbon copy header has to be 'Bcc', not 'BCC' or 'bcc' -- ensure this.
|
||
|
|
if (isset($headers['BCC'])) {$headers['Bcc']=$headers['BCC']; unset($headers['BCC']); }
|
||
|
|
if (isset($headers['bcc'])) {$headers['Bcc']=$headers['bcc']; unset($headers['bcc']); }
|
||
|
|
|
||
|
|
|
||
|
|
// Send the email
|
||
|
|
$headers = processHeaders($headers);
|
||
|
|
$to = validEmailAddr($to);
|
||
|
|
|
||
|
|
// Try it without the -f option if it fails
|
||
|
|
if(!($result = @mail($to, $subject, $fullBody, $headers, "-f$bounceAddress"))) {
|
||
|
|
$result = mail($to, $subject, $fullBody, $headers);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Send a plain text e-mail
|
||
|
|
*/
|
||
|
|
function plaintextEmail($to, $from, $subject, $plainContent, $attachedFiles, $customheaders = false) {
|
||
|
|
$subjectIsUnicode = false;
|
||
|
|
$plainEncoding = false; // Not ensurely where this is supposed to be set, but defined it false for now to remove php notices
|
||
|
|
|
||
|
|
if ($customheaders && is_array($customheaders) == false) {
|
||
|
|
echo "htmlEmail($to, $from, $subject, ...) could not send mail: improper \$customheaders passed:<BR>";
|
||
|
|
dieprintr($headers);
|
||
|
|
}
|
||
|
|
|
||
|
|
if(strpos($subject,"&#") !== false) $subjectIsUnicode = true;
|
||
|
|
|
||
|
|
// If the subject line contains extended characters, we must encode it
|
||
|
|
$subject = Convert::xml2raw($subject);
|
||
|
|
if($subjectIsUnicode)
|
||
|
|
$subject = "=?UTF-8?B?" . base64_encode($subject) . "?=";
|
||
|
|
|
||
|
|
|
||
|
|
// Make the plain text part
|
||
|
|
$headers["Content-Type"] = "text/plain; charset=\"utf-8\"";
|
||
|
|
$headers["Content-Transfer-Encoding"] = $plainEncoding ? $plainEncoding : "quoted-printable";
|
||
|
|
|
||
|
|
$plainContent = ($plainEncoding == "base64") ? chunk_split(base64_encode($plainContent),60) : QuotedPrintable_encode($plainContent);
|
||
|
|
|
||
|
|
// Messages with attachments are handled differently
|
||
|
|
if(is_array($attachedFiles)) {
|
||
|
|
// The first part is the message itself
|
||
|
|
$fullMessage = processHeaders($headers, $plainContent);
|
||
|
|
$messageParts = array($fullMessage);
|
||
|
|
|
||
|
|
// Include any specified attachments as additional parts
|
||
|
|
foreach($attachedFiles as $file) {
|
||
|
|
if($file['tmp_name'] && $file['name']) {
|
||
|
|
$messageParts[] = encodeFileForEmail($file['tmp_name'], $file['name']);
|
||
|
|
} else {
|
||
|
|
$messageParts[] = encodeFileForEmail($file);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// We further wrap all of this into another multipart block
|
||
|
|
list($fullBody, $headers) = encodeMultipart($messageParts, "multipart/mixed");
|
||
|
|
|
||
|
|
// Messages without attachments do not require such treatment
|
||
|
|
} else {
|
||
|
|
$fullBody = $plainContent;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Email headers
|
||
|
|
$headers["From"] = validEmailAddr($from);
|
||
|
|
|
||
|
|
// Messages with the X-SilverStripeMessageID header can be tracked
|
||
|
|
if(isset($customheaders["X-SilverStripeMessageID"]) && defined('BOUNCE_EMAIL')) {
|
||
|
|
$bounceAddress = BOUNCE_EMAIL;
|
||
|
|
// Get the human name from the from address, if there is one
|
||
|
|
if(ereg('^([^<>]+)<([^<>])> *$', $from, $parts))
|
||
|
|
$bounceAddress = "$parts[1]<$bounceAddress>";
|
||
|
|
} else {
|
||
|
|
$bounceAddress = $from;
|
||
|
|
}
|
||
|
|
|
||
|
|
// $headers["Sender"] = $from;
|
||
|
|
$headers["X-Mailer"] = X_MAILER;
|
||
|
|
if(!isset($customheaders["X-Priority"])) {
|
||
|
|
$headers["X-Priority"] = 3;
|
||
|
|
}
|
||
|
|
|
||
|
|
$headers = array_merge((array)$headers, (array)$customheaders);
|
||
|
|
|
||
|
|
// the carbon copy header has to be 'Cc', not 'CC' or 'cc' -- ensure this.
|
||
|
|
if (isset($headers['CC'])) { $headers['Cc'] = $headers['CC']; unset($headers['CC']); }
|
||
|
|
if (isset($headers['cc'])) { $headers['Cc'] = $headers['cc']; unset($headers['cc']); }
|
||
|
|
|
||
|
|
// Send the email
|
||
|
|
$headers = processHeaders($headers);
|
||
|
|
$to = validEmailAddr($to);
|
||
|
|
|
||
|
|
// Try it without the -f option if it fails
|
||
|
|
if(!$result = @mail($to, $subject, $fullBody, $headers, "-f$bounceAddress"))
|
||
|
|
$result = mail($to, $subject, $fullBody, $headers);
|
||
|
|
|
||
|
|
if($result)
|
||
|
|
return array($to,$subject,$fullBody,$headers);
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
function encodeMultipart($parts, $contentType, $headers = false) {
|
||
|
|
$separator = "----=_NextPart_" . ereg_replace('[^0-9]','',rand() * 10000000000);
|
||
|
|
|
||
|
|
|
||
|
|
$headers["MIME-Version"] = "1.0";
|
||
|
|
$headers["Content-Type"] = "$contentType; boundary=\"$separator\"";
|
||
|
|
$headers["Content-Transfer-Encoding"] = "7bit";
|
||
|
|
|
||
|
|
if($contentType == "multipart/alternative") {
|
||
|
|
//$baseMessage = "This is an encoded HTML message. There are two parts: a plain text and an HTML message, open whatever suits you better.";
|
||
|
|
$baseMessage = "\nThis is a multi-part message in MIME format.";
|
||
|
|
} else {
|
||
|
|
//$baseMessage = "This is a message containing attachments. The e-mail body is contained in the first attachment";
|
||
|
|
$baseMessage = "\nThis is a multi-part message in MIME format.";
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
$separator = "\n--$separator\n";
|
||
|
|
$body = "$baseMessage\n" .
|
||
|
|
$separator . implode("\n".$separator, $parts) . "\n" . trim($separator) . "--";
|
||
|
|
|
||
|
|
return array($body, $headers);
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Return a multipart/related e-mail chunk for the given HTML message and its linked images
|
||
|
|
* Decodes absolute URLs, accessing the appropriate local images
|
||
|
|
*/
|
||
|
|
function wrapImagesInline($htmlContent) {
|
||
|
|
global $_INLINED_IMAGES;
|
||
|
|
$_INLINED_IMAGES = null;
|
||
|
|
|
||
|
|
$replacedContent = imageRewriter($htmlContent, 'wrapImagesInline_rewriter($URL)');
|
||
|
|
|
||
|
|
|
||
|
|
// Make the HTML part
|
||
|
|
$headers["Content-Type"] = "text/html; charset=\"utf-8\"";
|
||
|
|
$headers["Content-Transfer-Encoding"] = "quoted-printable";
|
||
|
|
$multiparts[] = processHeaders($headers, QuotedPrintable_encode($replacedContent));
|
||
|
|
|
||
|
|
// Make all the image parts
|
||
|
|
global $_INLINED_IMAGES;
|
||
|
|
foreach($_INLINED_IMAGES as $url => $cid) {
|
||
|
|
$multiparts[] = encodeFileForEmail($url, false, "inline", "Content-ID: <$cid>\n");
|
||
|
|
}
|
||
|
|
|
||
|
|
// Merge together in a multipart
|
||
|
|
list($body, $headers) = encodeMultipart($multiparts, "multipart/related");
|
||
|
|
return processHeaders($headers, $body);
|
||
|
|
}
|
||
|
|
function wrapImagesInline_rewriter($url) {
|
||
|
|
$url = relativiseURL($url);
|
||
|
|
|
||
|
|
global $_INLINED_IMAGES;
|
||
|
|
if(!$_INLINED_IMAGES[$url]) {
|
||
|
|
$identifier = "automatedmessage." . rand(1000,1000000000) . "@silverstripe.com";
|
||
|
|
$_INLINED_IMAGES[$url] = $identifier;
|
||
|
|
}
|
||
|
|
return "cid:" . $_INLINED_IMAGES[$url];
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Combine headers w/ the body into a single string
|
||
|
|
*/
|
||
|
|
function processHeaders($headers, $body = false) {
|
||
|
|
$res = '';
|
||
|
|
if(is_array($headers)) while(list($k, $v) = each($headers))
|
||
|
|
$res .= "$k: $v\n";
|
||
|
|
if($body) $res .= "\n$body";
|
||
|
|
return $res;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Encode the contents of a file for emailing, including headers
|
||
|
|
*/
|
||
|
|
function encodeFileForEmail($file, $destFileName = false, $disposition = "attachment", $extraHeaders = "") {
|
||
|
|
if(!$file) {
|
||
|
|
user_error("encodeFileForEmail: not passed a filename and/or data", E_USER_WARNING);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_string($file)) {
|
||
|
|
$file = array('filename' => $file);
|
||
|
|
$fh = fopen($file['filename'], "rb");
|
||
|
|
if ($fh) {
|
||
|
|
while(!feof($fh)) $file['contents'] .= fread($fh, 10000);
|
||
|
|
fclose($fh);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Build headers, including content type
|
||
|
|
if(!$destFileName) $base = basename($file['filename']);
|
||
|
|
else $base = $destFileName;
|
||
|
|
|
||
|
|
$mimeType = $file['mimetype'] ? $file['mimetype'] : getMimeType($file['filename']);
|
||
|
|
if(!$mimeType) $mimeType = "application/unknown";
|
||
|
|
|
||
|
|
// Encode for emailing
|
||
|
|
if (substr($file['mimetype'], 0, 4) != 'text') {
|
||
|
|
$encoding = "base64";
|
||
|
|
$file['contents'] = chunk_split(base64_encode($file['contents']));
|
||
|
|
} else {
|
||
|
|
// This mime type is needed, otherwise some clients will show it as an inline attachment
|
||
|
|
$mimeType = 'application/octet-stream';
|
||
|
|
$encoding = "quoted-printable";
|
||
|
|
$file['contents'] = QuotedPrintable_encode($file['contents']);
|
||
|
|
}
|
||
|
|
|
||
|
|
$headers = "Content-type: $mimeType;\n\tname=\"$base\"\n".
|
||
|
|
"Content-Transfer-Encoding: $encoding\n".
|
||
|
|
"Content-Disposition: $disposition;\n\tfilename=\"$base\"\n" . $extraHeaders . "\n";
|
||
|
|
|
||
|
|
// Return completed packet
|
||
|
|
return $headers . $file['contents'];
|
||
|
|
}
|
||
|
|
|
||
|
|
function QuotedPrintable_encode($quotprint) {
|
||
|
|
$quotprint = (string) str_replace('\r\n',chr(13).chr(10),$quotprint);
|
||
|
|
$quotprint = (string) str_replace('\n', chr(13).chr(10),$quotprint);
|
||
|
|
$quotprint = (string) preg_replace("~([\x01-\x1F\x3D\x7F-\xFF])~e", "sprintf('=%02X', ord('\\1'))", $quotprint);
|
||
|
|
//$quotprint = (string) str_replace('\=0D=0A',"=0D=0A",$quotprint);
|
||
|
|
$quotprint = (string) str_replace('=0D=0A',"\n",$quotprint);
|
||
|
|
$quotprint = (string) str_replace('=0A=0D',"\n",$quotprint);
|
||
|
|
$quotprint = (string) str_replace('=0D',"\n",$quotprint);
|
||
|
|
$quotprint = (string) str_replace('=0A',"\n",$quotprint);
|
||
|
|
return (string) $quotprint;
|
||
|
|
}
|
||
|
|
|
||
|
|
function validEmailAddr($emailAddress) {
|
||
|
|
$emailAddress = trim($emailAddress);
|
||
|
|
$angBrack = strpos($emailAddress, '<');
|
||
|
|
|
||
|
|
if($angBrack === 0) {
|
||
|
|
$emailAddress = substr($emailAddress, 1, strpos($emailAddress,'>')-1);
|
||
|
|
|
||
|
|
} else if($angBrack) {
|
||
|
|
$emailAddress = str_replace('@', '', substr($emailAddress, 0, $angBrack))
|
||
|
|
.substr($emailAddress, $angBrack);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $emailAddress;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Get mime type based on extension
|
||
|
|
*/
|
||
|
|
function getMimeType($filename) {
|
||
|
|
global $global_mimetypes;
|
||
|
|
if(!$global_mimetypes) loadMimeTypes();
|
||
|
|
$ext = strtolower(substr($filename,strrpos($filename,'.')+1));
|
||
|
|
return $global_mimetypes[$ext];
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Load the mime-type data from the system file
|
||
|
|
*/
|
||
|
|
function loadMimeTypes() {
|
||
|
|
$mimetypePathCustom = '/etc/mime.types';
|
||
|
|
$mimetypePathGeneric = Director::baseFolder() . '/sapphire/email/mime.types';
|
||
|
|
$mimeTypes = file_exists($mimetypePathGeneric) ? file($mimetypePathGeneric) : file($mimetypePathCustom);
|
||
|
|
foreach($mimeTypes as $typeSpec) {
|
||
|
|
if(($typeSpec = trim($typeSpec)) && substr($typeSpec,0,1) != "#") {
|
||
|
|
$parts = split("[ \t\r\n]+", $typeSpec);
|
||
|
|
if(sizeof($parts) > 1) {
|
||
|
|
$mimeType = array_shift($parts);
|
||
|
|
foreach($parts as $ext) {
|
||
|
|
$ext = strtolower($ext);
|
||
|
|
$mimeData[$ext] = $mimeType;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
global $global_mimetypes;
|
||
|
|
$global_mimetypes = $mimeData;
|
||
|
|
return $mimeData;
|
||
|
|
}
|
||
|
|
|