Documentation TYPO3 par Ameos

t3lib_htmlmail Class Reference

Inheritance diagram for t3lib_htmlmail:
[legend]
List of all members.

Public Member Functions

 t3lib_htmlmail ()
 start ()
 useQuotedPrintable ()
 useBase64 ()
 use8Bit ()
 encodeMsg ($content)
 addPlain ($content)
 addAttachment ($file)
 addHTML ($file)
 extractHtmlInit ($html, $url)
 send ($recipient)
 setHeaders ()
 setRecipient ($recip)
 getHTMLContentType ()
 setContent ()
 constructMixed ($boundary)
 constructHTML ($boundary)
 constructAlternative ($boundary)
 constructHTML_media ($boundary)
 sendTheMail ()
 getBoundary ()
 setPlain ($content)
 setHtml ($content)
 add_header ($header)
 add_message ($string)
 getContent ($type)
 preview ()
 fetchHTML ($file)
 fetchHTMLMedia ()
 extractMediaLinks ()
 extractHyperLinks ()
 extractFramesInfo ()
 substMediaNamesInHTML ($absolute)
 substHREFsInHTML ()
 substHTTPurlsInPlainText ($content)
 fixRollOvers ()
 makeBase64 ($inputstr)
 getExtendedURL ($url)
 addUserPass ($url)
 getURL ($url)
 getStrippedURL ($url)
 getMimeType ($url)
 absRef ($ref)
 split_fileref ($fileref)
 extParseUrl ($path)
 tag_regex ($tagArray)
 get_tag_attributes ($tag)
 quoted_printable ($string)
 convertName ($name)

Public Attributes

 $recipient = "recipient@whatever.com"
 $recipient_copy = ""
 $subject = "This is the subject"
 $from_email = "sender@php-mailer.com"
 $from_name = "Mr. Sender"
 $replyto_email = "reply@mailer.com"
 $replyto_name = "Mr. Reply"
 $organisation = "Your Company"
 $priority = 3
 $mailer = "PHP mailer"
 $alt_base64 = 0
 $alt_8bit = 0
 $jumperURL_prefix = ""
 $jumperURL_useId = 0
 $mediaList = ""
 $http_password = ""
 $http_username = ""
 $postfix_version1 = false
 $theParts = Array()
 $messageid = ""
 $returnPath = ""
 $Xid = ""
 $dontEncodeHeader = false
 $headers = ""
 $message = ""
 $part = 0
 $image_fullpath_list = ""
 $href_fullpath_list = ""
 $plain_text_header = ''
 $html_text_header = ''
 $charset = ''
 $defaultCharset = 'iso-8859-1'

Detailed Description

Definition at line 193 of file class.t3lib_htmlmail.php.


Member Function Documentation

t3lib_htmlmail::t3lib_htmlmail (  ) 

Constructor. If the configuration variable forceReturnPath is set, calls to mail will be called with a 5th parameter. See function sendTheMail for more info

Returns:
[type] ...

Definition at line 261 of file class.t3lib_htmlmail.php.

t3lib_htmlmail::start (  ) 

Returns:
[type] ...

Definition at line 268 of file class.t3lib_htmlmail.php.

References t3lib_div::getHostname(), and useQuotedPrintable().

t3lib_htmlmail::useQuotedPrintable (  ) 

[Describe function...]

Returns:
void

Definition at line 306 of file class.t3lib_htmlmail.php.

Referenced by start().

t3lib_htmlmail::useBase64 (  ) 

[Describe function...]

Returns:
void

Definition at line 316 of file class.t3lib_htmlmail.php.

Referenced by t3lib_formmail::start().

t3lib_htmlmail::use8Bit (  ) 

[Describe function...]

Returns:
void

Definition at line 327 of file class.t3lib_htmlmail.php.

t3lib_htmlmail::encodeMsg ( content  ) 

[Describe function...]

Parameters:
[type] $content: ...
Returns:
[type] ...

Definition at line 339 of file class.t3lib_htmlmail.php.

References makeBase64(), and t3lib_div::quoted_printable().

Referenced by addHTML(), addPlain(), and t3lib_formmail::start().

t3lib_htmlmail::addPlain ( content  ) 

[Describe function...]

Parameters:
[type] $content: ...
Returns:
[type] ...

Definition at line 349 of file class.t3lib_htmlmail.php.

References encodeMsg(), setPlain(), and substHTTPurlsInPlainText().

Referenced by t3lib_formmail::start().

t3lib_htmlmail::addAttachment ( file  ) 

[Describe function...]

Parameters:
[type] $file: ...
Returns:
[type] ...

Definition at line 361 of file class.t3lib_htmlmail.php.

References getExtendedURL(), and split_fileref().

t3lib_htmlmail::addHTML ( file  ) 

[Describe function...]

Parameters:
[type] $file: ...
Returns:
[type] ...

Definition at line 379 of file class.t3lib_htmlmail.php.

References encodeMsg(), extractFramesInfo(), extractHyperLinks(), extractMediaLinks(), fetchHTML(), fetchHTMLMedia(), substHREFsInHTML(), and substMediaNamesInHTML().

t3lib_htmlmail::extractHtmlInit ( html,
url 
)

External used to extract HTML-parts

Parameters:
[type] $html: ...
[type] $url: ...
Returns:
[type] ...

Definition at line 402 of file class.t3lib_htmlmail.php.

t3lib_htmlmail::send ( recipient  ) 

[Describe function...]

Parameters:
[type] $recipient: ...
Returns:
[type] ...

Definition at line 413 of file class.t3lib_htmlmail.php.

References $recipient, sendTheMail(), setContent(), and setHeaders().

t3lib_htmlmail::setHeaders (  ) 

Returns:
[type] ...

Definition at line 442 of file class.t3lib_htmlmail.php.

References add_header(), t3lib_div::encodeHeader(), and quoted_printable().

Referenced by send(), and t3lib_formmail::start().

t3lib_htmlmail::setRecipient ( recip  ) 

[Describe function...]

Parameters:
[type] $recip: ...
Returns:
[type] ...

Definition at line 501 of file class.t3lib_htmlmail.php.

Referenced by t3lib_formmail::start().

t3lib_htmlmail::getHTMLContentType (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 519 of file class.t3lib_htmlmail.php.

Referenced by constructMixed(), and setContent().

t3lib_htmlmail::setContent (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 528 of file class.t3lib_htmlmail.php.

References add_header(), add_message(), constructHTML(), constructMixed(), getBoundary(), getContent(), and getHTMLContentType().

Referenced by send(), and t3lib_formmail::start().

t3lib_htmlmail::constructMixed ( boundary  ) 

[Describe function...]

Parameters:
[type] $boundary: ...
Returns:
[type] ...

Definition at line 555 of file class.t3lib_htmlmail.php.

References add_message(), constructHTML(), getBoundary(), getContent(), getHTMLContentType(), and makeBase64().

Referenced by setContent().

t3lib_htmlmail::constructHTML ( boundary  ) 

[Describe function...]

Parameters:
[type] $boundary: ...
Returns:
[type] ...

Definition at line 594 of file class.t3lib_htmlmail.php.

References add_message(), constructAlternative(), constructHTML_media(), and getBoundary().

Referenced by constructMixed(), and setContent().

t3lib_htmlmail::constructAlternative ( boundary  ) 

[Describe function...]

Parameters:
[type] $boundary: ...
Returns:
[type] ...

Definition at line 618 of file class.t3lib_htmlmail.php.

References add_message(), and getContent().

Referenced by constructHTML().

t3lib_htmlmail::constructHTML_media ( boundary  ) 

[Describe function...]

Parameters:
[type] $boundary: ...
Returns:
[type] ...

Definition at line 639 of file class.t3lib_htmlmail.php.

References add_message(), t3lib_div::inList(), and makeBase64().

Referenced by constructHTML().

t3lib_htmlmail::sendTheMail (  ) 

Sends the mail by calling the mail() function in php. On Linux systems this will invoke the MTA defined in php.ini (sendmail -t -i by default), on Windows a SMTP must be specified in the sys.ini. Most common MTA's on Linux has a Sendmail interface, including Postfix and Exim. For setting the return-path correctly, the parameter -f has to be added to the system call to sendmail. This obviously does not have any effect on Windows, but on Sendmail compliant systems this works. If safe mode is enabled, then extra parameters is not allowed, so a safe mode check is made before the mail() command is invoked. When using the -f parameter, some MTA's will put an X-AUTHENTICATION-WARNING saying that the return path was modified manually with the -f flag. To disable this warning make sure that the user running Apache is in the /etc/mail/trusted-users table.

POSTFIX: With postfix version below 2.0 there is a problem that the -f parameter can not be used in conjunction with -t. Postfix will give an error in the maillog:

cannot handle command-line recipients with -t

The -f parameter is only enabled if the parameter forceReturnPath is enabled in the install tool.

This whole problem of return-path turns out to be quite tricky. If you have a solution that works better, on all standard MTA's then we are very open for suggestions.

With time this function should be made such that several ways of sending the mail is possible (local MTA, smtp other).

Returns:
[type] ...

Definition at line 692 of file class.t3lib_htmlmail.php.

References $returnPath, and $theParts.

Referenced by send().

t3lib_htmlmail::getBoundary (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 758 of file class.t3lib_htmlmail.php.

Referenced by constructHTML(), constructMixed(), and setContent().

t3lib_htmlmail::setPlain ( content  ) 

[Describe function...]

Parameters:
[type] $content: ...
Returns:
[type] ...

Definition at line 770 of file class.t3lib_htmlmail.php.

Referenced by addPlain().

t3lib_htmlmail::setHtml ( content  ) 

[Describe function...]

Parameters:
[type] $content: ...
Returns:
[type] ...

Definition at line 781 of file class.t3lib_htmlmail.php.

t3lib_htmlmail::add_header ( header  ) 

[Describe function...]

Parameters:
[type] $header: ...
Returns:
[type] ...

Definition at line 792 of file class.t3lib_htmlmail.php.

References t3lib_div::encodeHeader(), and quoted_printable().

Referenced by setContent(), and setHeaders().

t3lib_htmlmail::add_message ( string  ) 

[Describe function...]

Parameters:
[type] $string: ...
Returns:
[type] ...

Definition at line 813 of file class.t3lib_htmlmail.php.

Referenced by constructAlternative(), constructHTML(), constructHTML_media(), constructMixed(), and setContent().

t3lib_htmlmail::getContent ( type  ) 

[Describe function...]

Parameters:
[type] $type: ...
Returns:
[type] ...

Definition at line 824 of file class.t3lib_htmlmail.php.

Referenced by constructAlternative(), constructMixed(), and setContent().

t3lib_htmlmail::preview (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 833 of file class.t3lib_htmlmail.php.

t3lib_htmlmail::fetchHTML ( file  ) 

Parameters:
[type] $file: ...
Returns:
[type] ...

Definition at line 861 of file class.t3lib_htmlmail.php.

References extParseUrl(), and getURL().

Referenced by addHTML().

t3lib_htmlmail::fetchHTMLMedia (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 879 of file class.t3lib_htmlmail.php.

References getExtendedURL().

Referenced by addHTML().

t3lib_htmlmail::extractMediaLinks (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 900 of file class.t3lib_htmlmail.php.

References absRef(), get_tag_attributes(), split_fileref(), and tag_regex().

Referenced by addHTML().

t3lib_htmlmail::extractHyperLinks (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 977 of file class.t3lib_htmlmail.php.

References absRef(), get_tag_attributes(), and tag_regex().

Referenced by addHTML().

t3lib_htmlmail::extractFramesInfo (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 1026 of file class.t3lib_htmlmail.php.

References absRef(), get_tag_attributes(), and tag_regex().

Referenced by addHTML().

t3lib_htmlmail::substMediaNamesInHTML ( absolute  ) 

[Describe function...]

Parameters:
[type] $absolute: ...
Returns:
[type] ...

Definition at line 1052 of file class.t3lib_htmlmail.php.

References absRef(), and fixRollOvers().

Referenced by addHTML().

t3lib_htmlmail::substHREFsInHTML (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 1079 of file class.t3lib_htmlmail.php.

References absRef().

Referenced by addHTML().

t3lib_htmlmail::substHTTPurlsInPlainText ( content  ) 

[Describe function...]

Parameters:
[type] $content: ...
Returns:
[type] ...

Definition at line 1107 of file class.t3lib_htmlmail.php.

Referenced by addPlain().

t3lib_htmlmail::fixRollOvers (  ) 

[Describe function...]

Returns:
[type] ...

Definition at line 1143 of file class.t3lib_htmlmail.php.

References $part.

Referenced by substMediaNamesInHTML().

t3lib_htmlmail::makeBase64 ( inputstr  ) 

Parameters:
[type] $inputstr: ...
Returns:
[type] ...

Definition at line 1190 of file class.t3lib_htmlmail.php.

Referenced by constructHTML_media(), constructMixed(), and encodeMsg().

t3lib_htmlmail::getExtendedURL ( url  ) 

[Describe function...]

Parameters:
[type] $url: ...
Returns:
[type] ...

Definition at line 1201 of file class.t3lib_htmlmail.php.

References getMimeType(), getURL(), and split_fileref().

Referenced by addAttachment(), and fetchHTMLMedia().

t3lib_htmlmail::addUserPass ( url  ) 

[Describe function...]

Parameters:
[type] $url: ...
Returns:
[type] ...

Definition at line 1223 of file class.t3lib_htmlmail.php.

Referenced by getURL().

t3lib_htmlmail::getURL ( url  ) 

[Describe function...]

Parameters:
[type] $url: ...
Returns:
[type] ...

Definition at line 1239 of file class.t3lib_htmlmail.php.

References addUserPass(), and t3lib_div::getURL().

Referenced by t3lib_formmail::addAttachment(), fetchHTML(), and getExtendedURL().

t3lib_htmlmail::getStrippedURL ( url  ) 

[Describe function...]

Parameters:
[type] $url: ...
Returns:
[type] ...

Definition at line 1251 of file class.t3lib_htmlmail.php.

t3lib_htmlmail::getMimeType ( url  ) 

This function returns the mime type of the file specified by the url

Parameters:
string $url: the url
Returns:
string $mimeType: the mime type found in the header

Definition at line 1272 of file class.t3lib_htmlmail.php.

References $headers, and t3lib_div::getURL().

Referenced by getExtendedURL().

t3lib_htmlmail::absRef ( ref  ) 

[Describe function...]

Parameters:
[type] $ref: ...
Returns:
[type] ...

Definition at line 1290 of file class.t3lib_htmlmail.php.

Referenced by extractFramesInfo(), extractHyperLinks(), extractMediaLinks(), substHREFsInHTML(), and substMediaNamesInHTML().

t3lib_htmlmail::split_fileref ( fileref  ) 

[Describe function...]

Parameters:
[type] $fileref: ...
Returns:
[type] ...

Definition at line 1310 of file class.t3lib_htmlmail.php.

Referenced by addAttachment(), t3lib_formmail::addAttachment(), extractMediaLinks(), and getExtendedURL().

t3lib_htmlmail::extParseUrl ( path  ) 

[Describe function...]

Parameters:
[type] $path: ...
Returns:
[type] ...

Definition at line 1337 of file class.t3lib_htmlmail.php.

Referenced by fetchHTML().

t3lib_htmlmail::tag_regex ( tagArray  ) 

[Describe function...]

Parameters:
[type] $tagArray: ...
Returns:
[type] ...

Definition at line 1352 of file class.t3lib_htmlmail.php.

Referenced by extractFramesInfo(), extractHyperLinks(), and extractMediaLinks().

t3lib_htmlmail::get_tag_attributes ( tag  ) 

analyses a HTML-tag $tag is either like this "<TAG OPTION ATTRIB=VALUE>" or this " OPTION ATTRIB=VALUE>" which means you can omit the tag-name returns an array with the attributes as keys in lower-case If an attribute is empty (like OPTION) the value of that key is just empty. Check it with is_set();

Parameters:
[type] $tag: ...
Returns:
[type] ...

Definition at line 1374 of file class.t3lib_htmlmail.php.

Referenced by extractFramesInfo(), extractHyperLinks(), and extractMediaLinks().

t3lib_htmlmail::quoted_printable ( string  ) 

Implementation of quoted-printable encode. This function was a duplicate of t3lib_div::quoted_printable, thus it's going to be removed.

Parameters:
string Content to encode
Returns:
string The QP encoded string

Definition at line 1416 of file class.t3lib_htmlmail.php.

References t3lib_div::quoted_printable().

Referenced by add_header(), and setHeaders().

t3lib_htmlmail::convertName ( name  ) 

[Describe function...]

Parameters:
[type] $name: ...
Returns:
[type] ...
Deprecated:

Definition at line 1427 of file class.t3lib_htmlmail.php.


The documentation for this class was generated from the following file:


Généré par Les spécialistes TYPO3 avec  doxygen 1.4.6