TYPO3 Core

* Copyright notice

*

* (c) 1999-2010 Kasper Sk?rh?j (kasperYYYY@typo3.com)

* All rights reserved

*

* This script is part of the TYPO3 project. The TYPO3 project is

* free software; you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation; either version 2 of the License, or

* (at your option) any later version.

*

* The GNU General Public License can be found at

* http://www.gnu.org/copyleft/gpl.html.

* A copy is found in the textfile GPL.txt and important notices to the license

* from the author is found in LICENSE.txt distributed with these scripts.

*

*

* This script is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* This copyright notice MUST APPEAR in all copies of the script!

***************************************************************/

* 261: function t3lib_htmlmail ()

* 268: function start ()

* 305: function useQuotedPrintable()

* 315: function useBase64()

* 326: function use8Bit()

* 338: function encodeMsg($content)

* 348: function addPlain ($content)

* 360: function addAttachment($file)

* 378: function addHTML ($file)

* 401: function extractHtmlInit($html,$url)

* 412: function send($recipient)

* SECTION: Main functions

* 441: function setHeaders()

* 500: function setRecipient ($recip)

* 518: function getHTMLContentType()

* 527: function setContent()

* 554: function constructMixed ($boundary)

* 593: function constructHTML ($boundary)

* 617: function constructAlternative($boundary)

* 638: function constructHTML_media ($boundary)

* 691: function sendTheMail ()

* 757: function getBoundary()

* 769: function setPlain ($content)

* 780: function setHtml ($content)

* 791: function add_header($header)

* 812: function add_message($string)

* 823: function getContent($type)

* 832: function preview()

* SECTION: Functions for acquiring attachments, HTML, analyzing and so on **

* 860: function fetchHTML($file)

* 878: function fetchHTMLMedia()

* 899: function extractMediaLinks()

* 976: function extractHyperLinks()

* 1025: function extractFramesInfo()

* 1051: function substMediaNamesInHTML($absolute)

* 1078: function substHREFsInHTML()

* 1106: function substHTTPurlsInPlainText($content)

* 1142: function fixRollOvers()

* SECTION: File and URL-functions

* 1189: function makeBase64($inputstr)

* 1200: function getExtendedURL($url)

* 1222: function addUserPass($url)

* 1238: function getURL($url)

* 1250: function getStrippedURL($url)

* 1271: function getMimeType($url)

* 1300: function absRef($ref)

* 1320: function split_fileref($fileref)

* 1347: function extParseUrl($path)

* 1362: function tag_regex($tagArray)

* 1384: function get_tag_attributes($tag)

* 1426: function quoted_printable($string)

* 1437: function convertName($name)

* multipart/alternative (text, html)

* multipart/alternative (text, html)

* multipart/related (m/a, cids)

* multipart/alternative (text, html)

* multipart/related (m/a, cids)

* multipart/alternative (text, html)

* multipart/mixed

* multipart/mixed (text/html , attachments)

* multipart/mixed (m/a, attachments)

* multipart/alternative (text, html)

* Outlook expr.

* multipart/mixed (m/r, attachments)

* multipart/related (m/a, cids)

* multipart/alternative (text, html)

* quoted-printable := ([*(ptext / SPACE / TAB) ptext] ["="] CRLF)

* ; Maximum line length of 76 characters excluding CRLF

* ptext := octet /<any ASCII character except "=", SPACE, or TAB>

* ; characters not listed as "mail-safe" in Appendix B

* ; are also not recommended.

* octet := "=" 2(DIGIT / "A" / "B" / "C" / "D" / "E" / "F")

* ; octet must be used for characters > 127, =, SPACE, or TAB,

* ; and is recommended for any characters not listed in

* ; Appendix B as "mail-safe".

class t3lib_htmlmail {

var $recipient = '';

var $recipient_copy = ''; // This recipient (or list of...) will also receive the mail. Regard it as a copy.

var $subject = '';

var $from_email = '';

var $from_name = '';

var $replyto_email = '';

var $replyto_name = '';

var $organisation = '';

var $priority = 3; // 1 = highest, 5 = lowest, 3 = normal

var $mailer = ''; // X-mailer, set to TYPO3 Major.Minor in constructor

var $alt_base64 = 0;

var $alt_8bit = 0;

var $jumperURL_prefix = ''; // This is a prefix that will be added to all links in the mail. Example: 'http://www.mydomain.com/jump?userid=###FIELD_uid###&url='. if used, anything after url= is urlencoded.

var $jumperURL_useId = 0; // If set, then the array-key of the urls are inserted instead of the url itself. Smart in order to reduce link-length

var $mediaList = ''; // If set, this is a list of the media-files (index-keys to the array) that should be represented in the html-mail

var $http_password = '';

var $http_username = '';

var $postfix_version1 = false;

// Internal

var $dontEncodeHeader = false; // If set, the header will not be encoded

public function t3lib_htmlmail() {

public function start() {

} else {

public function useQuotedPrintable() {

$this->plain_text_header = 'Content-Type: text/plain; charset='.$this->charset.$this->linebreak.'Content-Transfer-Encoding: quoted-printable';

$this->html_text_header = 'Content-Type: text/html; charset='.$this->charset.$this->linebreak.'Content-Transfer-Encoding: quoted-printable';

public function useBase64() {

$this->plain_text_header = 'Content-Type: text/plain; charset='.$this->charset.$this->linebreak.'Content-Transfer-Encoding: base64';

$this->html_text_header = 'Content-Type: text/html; charset='.$this->charset.$this->linebreak.'Content-Transfer-Encoding: base64';

public function use8Bit() {

$this->plain_text_header = 'Content-Type: text/plain; charset='.$this->charset.$this->linebreak.'Content-Transfer-Encoding: 8bit';

$this->html_text_header = 'Content-Type: text/html; charset='.$this->charset.$this->linebreak.'Content-Transfer-Encoding: 8bit';

public function encodeMsg($content) {

} else {

public function addPlain($content) {

public function addAttachment($file) {

} elseif (strpos(' '.$fileInfo['content_type'], 'htm')) {

} else {

return true;

return false;

public function addHTML($file) {

return false;

$this->substMediaNamesInHTML(0); // 0 = relative

public function extractHtmlInit($html,$url) {

public function send($recipient) {

public function setHeaders() {

$this->add_header('Message-ID: <'.$this->messageid.'>');

$this->add_header('Return-Path: '.$this->returnPath);

$this->add_header('Errors-To: '.$this->returnPath);

$this->add_header('X-Typo3MID: '.$this->Xid);

$this->add_header('From: '.$this->from_name.' <'.$this->from_email.'>');

$this->add_header('From: '.$this->from_email);

$this->add_header('Reply-To: '.$this->replyto_name.' <'.$this->replyto_email.'>');

$this->add_header('Reply-To: '.$this->replyto_email);

$this->add_header('X-Mailer: '.$this->mailer);

$this->add_header('X-Priority: '.$this->priority);

$enc = $this->alt_base64 ? 'base64' : 'quoted_printable'; // Header must be ASCII, therefore only base64 or quoted_printable are allowed!

$this->recipient = t3lib_div::encodeHeader($this->recipient,$enc,$this->charset);

$this->subject = t3lib_div::encodeHeader($this->subject,$enc,$this->charset);

public function setRecipient($recipient) {

public function getHTMLContentType() {

public function setContent() {

// Generate (plain/HTML) / attachments

// Generate plain/HTML mail

// Generate plain only

public function constructMixed($boundary) {

// HTML and plain is added

$this->add_message('Content-Type: '.$this->getHTMLContentType() . ';');

// Purely plain

// attachments are added

public function constructHTML($boundary) {

// If media, then we know, the multipart/related content-type has been set before this function call

// HTML has media

} else {

// if no media, just use the $boundary for adding plaintext/html mix

public function constructAlternative($boundary) {

$this->add_message('--'.$boundary);

public function constructHTML_media($boundary) {

// media is added

foreach($this->theParts['html']['media'] as $key => $media) {

public function sendTheMail() {

$mailWasSent = false;

return false;

// If safe mode is on, the fifth parameter to mail is not allowed, so the fix wont work on unix with safe_mode=On

$this->subject,

$this->message,

$this->headers,

$returnPath);

$this->subject,

$this->message,

$this->headers);

$theParts = explode('/',$this->auto_respond_msg,2);

$theParts[1] = str_replace("/",LF,$theParts[1]);

$theParts[0],

$theParts[1],

'From: ' . $recipient,

$returnPath);

$theParts[0],

$theParts[1],

'From: ' . $recipient);

public function getBoundary() {

return "----------".uniqid("part_".$this->part."_");

public function setPlain($content) {

public function setHtml($content) {

public function add_header($header) {

if (!$this->dontEncodeHeader && !stristr($header,'Content-Type') && !stristr($header,'Content-Transfer-Encoding')) {

$parts = explode(': ',$header,2);

$this->headers .= $header.LF;

public function add_message($msg) {

$this->message .= $msg.LF;

public function getContent($type) {

public function preview() {

public function fetchHTML($file) {

$path = ($addr['scheme']) ? $addr['scheme'].'://'.$addr['host'].(($addr['port'])?':'.$addr['port']:'').(($addr['filepath'])?$addr['filepath']:'/') : $addr['filepath'];

return true;

} else {

return false;

public function fetchHTMLMedia() {

if (!is_array($this->theParts['html']['media']) || !count($this->theParts['html']['media'])) return;

$this->theParts['html']['media'][$key]['ctype'] = $picdata['content_type'];

public function extractMediaLinks() {

$attribRegex = $this->tag_regex(array('img','table','td','tr','body','iframe','script','input','embed'));

$tag = strtolower(strtok(substr($html_code,$len+1,10),' '));

$len += strlen($tag)+strlen($codepieces[$i])+2;

$attributes = $this->get_tag_attributes($reg[0]); // Fetches the attributes for the tag

$imageData['quotes'] = (substr($codepieces[$i], strpos($codepieces[$i], $imageData['ref'])-1,1) == '"') ? '"' : '';

$imageData['subst_str'] = $imageData['quotes'].$imageData['ref'].$imageData['quotes'];

if ($imageData['ref'] && !strstr($this->image_fullpath_list,"|".$imageData["subst_str"]."|")) {

$this->image_fullpath_list .= "|".$imageData['subst_str']."|";

$imageData['use_jumpurl'] = $attributes['dmailerping']?1:0;

$imageData['quotes'] = (substr($codepieces[$i],strpos($codepieces[$i], $imageData['ref'])-1,1) == '"') ? '"' : '';

$imageData['subst_str'] = $imageData['quotes'].$imageData['ref'].$imageData['quotes'];

if ($imageData['ref'] && !strstr($this->image_fullpath_list,"|".$imageData["subst_str"]."|")) {

$this->image_fullpath_list .= "|".$imageData["subst_str"]."|";

$expr = '/^[^'.quotemeta('"').quotemeta("'").']*/';

for($i = 1; $i < $pieces; $i++) {

$temp = trim(str_replace('=','',trim($temp)));

preg_match($expr,substr($temp,1,strlen($temp)),$reg);

$imageData['quotes'] = substr($temp,0,1);

$imageData['subst_str'] = $imageData['quotes'].$imageData['ref'].$imageData['quotes'];

if ($imageData['ref'] && !strstr($this->image_fullpath_list,"|".$imageData["subst_str"]."|")) {

$this->image_fullpath_list .= "|".$imageData['subst_str']."|";

public function extractHyperLinks() {

$attribRegex = $this->tag_regex(array('a','form','area'));

$codepieces = preg_split($attribRegex, $html_code); // Splits the document by the beginning of the above tags

for($i = 1; $i < $pieces; $i++) {

$tag = strtolower(strtok(substr($html_code,$len+1,10)," "));

$hrefData['quotes'] = (substr($codepieces[$i],strpos($codepieces[$i], $hrefData["ref"])-1,1) == '"') ? '"' : '';

$hrefData['subst_str'] = $hrefData['quotes'].$hrefData['ref'].$hrefData['quotes'];

if ($hrefData['ref'] && substr(trim($hrefData['ref']),0,1) != "#" && !strstr($this->href_fullpath_list,"|".$hrefData['subst_str']."|")) {

$this->href_fullpath_list .= "|".$hrefData['subst_str']."|";

for($i = 1; $i < $pieces; $i++) {

$showpic_linkArr = explode("'",$codepieces[$i]);

$hrefData['subst_str'] = $hrefData['quotes'].$hrefData['ref'].$hrefData['quotes'];

if ($hrefData['ref'] && !strstr($this->href_fullpath_list,"|".$hrefData['subst_str']."|")) {

$this->href_fullpath_list .= "|".$hrefData['subst_str']."|";

public function extractFramesInfo() {

if (strpos(' '.$htmlCode,'<frame ')) {

for($i = 1; $i < $pieces; $i++) {

public function substMediaNamesInHTML($absolute) {

$subst = $this->jumperURL_prefix.t3lib_div::rawUrlEncodeFP($val['absRef']);

$subst = ($absolute) ? $val['absRef'] : 'cid:part'.$key.'.'.$this->messageid;

public function substHREFsInHTML() {

if (!is_array($this->theParts['html']['hrefs'])) return;

$substVal = $this->jumperURL_prefix.$key;

$substVal = $this->jumperURL_prefix.t3lib_div::rawUrlEncodeFP($val['absRef']);

public function substHTTPurlsInPlainText($content) {

if (!$this->jumperURL_prefix) return $content;

for($i = 1; $i<$pieces; $i++) {

$len = strcspn($textpieces[$i],chr(32).TAB.CRLF);

if (trim(substr($textstr,-1)) == '' && $len) {

$lastChar = substr($textpieces[$i],$len-1,1);

if (!preg_match('/[A-Za-z0-9\/#]/',$lastChar)) {

$parts[0] = "http://".substr($textpieces[$i],0,$len);

$parts[1] = substr($textpieces[$i],$len);

$parts[0] = $this->jumperURL_prefix.'-'.$i;

$parts[0] = $this->jumperURL_prefix.t3lib_div::rawUrlEncodeFP($parts[0]);

$textstr .= $parts[0].$parts[1];

$textstr .= 'http://'.$textpieces[$i];

public function fixRollOvers() {

$items = explode('.src',$this->theParts['html']['content']);

if (count($items) <= 1) return;

foreach($items as $key => $part) {

if (preg_match('/cid:part[^ "\']*/',$sub,$reg)) {

$thePos = strpos($part,$reg[0]);

preg_match('/cid:part([^\.]*).*/',$sub,$reg2);

// ... and substitutes the javaScript rollover image with this instead

// If the path is NOT and url, the reference is set to nothing

if (!strpos(' '.$theSubStr, 'http://')) {

$part = substr($part, 0, $thePos) . $theSubStr . substr($part,$thePos+strlen($reg[0]),strlen($part));

$newContent .= $part . ((($key+1) != count($items)) ? '.src' : '');

public function makeBase64($inputstr) {

public function getExtendedURL($url) {

if (!$res['content']) return false;

$res['content_type'] = 'image/'.$fileInfo['fileext'];

break;

break;

break;

break;

break;

public function addUserPass($url) {

return $matches[1].$user.':'.$pass.'@'.substr($url,strlen($matches[1]));

public function getURL($url) {

public function getStrippedURL($url) {

public function getMimeType($url) {

public function absRef($ref) {

} elseif (preg_match('/^\//',$ref)) {

return $addr['scheme'].'://'.$addr['host'].($addr['port']?':'.$addr['port']:'').$ref;

// If the reference is relative, the path is added, in order for us to fetch the content

public function split_fileref($fileref) {

} else {

} else {

public function extParseUrl($path) {

public function tag_regex($tags) {

foreach($tags as $tag) {

* this " OPTION ATTRIB=VALUE>" which means you can omit the tag-name

public function get_tag_attributes($tag) {

$tag = ltrim(preg_replace('/^<[^ ]*/','',trim($tag)));

$tag = ltrim(substr($tag,strlen($attrib),$tagLen));

if (substr($tag,0,1) == '=') {

$tag = ltrim(substr($tag,1,$tagLen));

if (substr($tag,0,1) == '"') {

$reg = explode('"',substr($tag,1,$tagLen),2);

preg_match('/^([^[:space:]>]*)(.*)/',$tag,$reg);

if (substr($tag,0,1) == '>') {

if ($safetyCounter < 0) break;

}

* @deprecated since TYPO3 4.0, will be removed in TYPO3 4.6

public function quoted_printable($string) {

* @deprecated since TYPO3 4.0, will be removed in TYPO3 4.6

public function convertName($name) {