t3lib_htmlmail Class Reference

Inheritance diagram for t3lib_htmlmail:

t3lib_formmail 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.

Constructor & Destructor 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.

Member Function Documentation

t3lib_htmlmail.absRef (  $  ref  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.add_header (  $  header  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.add_message (  $  string  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.addAttachment (  $  file  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.addHTML (  $  file  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.addPlain (  $  content  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.addUserPass (  $  url  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.constructAlternative (  $  boundary  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.constructHTML (  $  boundary  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.constructHTML_media (  $  boundary  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.constructMixed (  $  boundary  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.convertName (  $  name  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.encodeMsg (  $  content  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.extParseUrl (  $  path  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.extractFramesInfo (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.extractHtmlInit (  $  html,
$  url
) 
 

External used to extract HTML-parts

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

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

t3lib_htmlmail.extractHyperLinks (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.extractMediaLinks (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.fetchHTML (  $  file  ) 
 

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

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

t3lib_htmlmail.fetchHTMLMedia (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.fixRollOvers (   ) 
 

[Describe function...]

Returns:
[type] ...

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

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 1384 of file class.t3lib_htmlmail.php.

t3lib_htmlmail.getBoundary (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.getContent (  $  type  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.getExtendedURL (  $  url  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.getHTMLContentType (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.getMimeType (  $  url  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.getStrippedURL (  $  url  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.getURL (  $  url  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.makeBase64 (  $  inputstr  ) 
 

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

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

t3lib_htmlmail.preview (   ) 
 

[Describe function...]

Returns:
[type] ...

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

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 1426 of file class.t3lib_htmlmail.php.

t3lib_htmlmail.send (  $  recipient  ) 
 

[Describe function...]

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

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

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 691 of file class.t3lib_htmlmail.php.

t3lib_htmlmail.setContent (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.setHeaders (   ) 
 

Returns:
[type] ...

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

t3lib_htmlmail.setHtml (  $  content  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.setPlain (  $  content  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.setRecipient (  $  recip  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.split_fileref (  $  fileref  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.start (   ) 
 

Returns:
[type] ...

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

t3lib_htmlmail.substHREFsInHTML (   ) 
 

[Describe function...]

Returns:
[type] ...

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

t3lib_htmlmail.substHTTPurlsInPlainText (  $  content  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.substMediaNamesInHTML (  $  absolute  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.tag_regex (  $  tagArray  ) 
 

[Describe function...]

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

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

t3lib_htmlmail.use8Bit (   ) 
 

[Describe function...]

Returns:
void

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

t3lib_htmlmail.useBase64 (   ) 
 

[Describe function...]

Returns:
void

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

t3lib_htmlmail.useQuotedPrintable (   ) 
 

[Describe function...]

Returns:
void

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

Member Data Documentation

t3lib_htmlmail.$alt_8bit = 0
 

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

t3lib_htmlmail.$alt_base64 = 0
 

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

t3lib_htmlmail.$charset = ''
 

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

t3lib_htmlmail.$defaultCharset = 'iso-8859-1'
 

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

t3lib_htmlmail.$dontEncodeHeader = false
 

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

t3lib_htmlmail.$from_email = "sender@php-mailer.com"
 

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

t3lib_htmlmail.$from_name = "Mr. Sender"
 

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

t3lib_htmlmail.$headers = ""
 

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

t3lib_htmlmail.$href_fullpath_list = ""
 

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

t3lib_htmlmail.$html_text_header = ''
 

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

t3lib_htmlmail.$http_password = ""
 

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

t3lib_htmlmail.$http_username = ""
 

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

t3lib_htmlmail.$image_fullpath_list = ""
 

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

t3lib_htmlmail.$jumperURL_prefix = ""
 

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

t3lib_htmlmail.$jumperURL_useId = 0
 

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

t3lib_htmlmail.$mailer = "PHP mailer"
 

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

t3lib_htmlmail.$mediaList = ""
 

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

t3lib_htmlmail.$message = ""
 

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

t3lib_htmlmail.$messageid = ""
 

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

t3lib_htmlmail.$organisation = "Your Company"
 

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

t3lib_htmlmail.$part = 0
 

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

t3lib_htmlmail.$plain_text_header = ''
 

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

t3lib_htmlmail.$postfix_version1 = false
 

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

t3lib_htmlmail.$priority = 3
 

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

t3lib_htmlmail.$recipient = "recipient@whatever.com"
 

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

t3lib_htmlmail.$recipient_copy = ""
 

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

t3lib_htmlmail.$replyto_email = "reply@mailer.com"
 

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

t3lib_htmlmail.$replyto_name = "Mr. Reply"
 

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

t3lib_htmlmail.$returnPath = ""
 

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

t3lib_htmlmail.$subject = "This is the subject"
 

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

t3lib_htmlmail.$theParts = Array()
 

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

t3lib_htmlmail.$Xid = ""
 

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

The documentation for this class was generated from the following file:
Generated on Fri Apr 7 10:49:03 2006 for TYPO3 by  doxygen 1.4.6