| [ PHPXref.com ] | [ Generated: Sun Jul 20 19:33:36 2008 ] | [ phpBugTracker 1.0.1 ] |
| [ Index ] [ Variables ] [ Functions ] [ Classes ] [ Constants ] [ Statistics ] | ||
[Source view] [Print]
Filename.......: class.html.mime.mail.inc Project........: HTML Mime mail class Last Modified..: Date: 2002/07/24 13:14:10 CVS Revision...: Revision: 1.4 Copyright......: 2001, 2002 Richard Heyes
| File Size: | 774 lines (21 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
htmlMimeMail:: (32 methods):
htmlMimeMail()
getFile()
setCrlf()
setSMTPParams()
setTextEncoding()
setHtmlEncoding()
setTextCharset()
setHtmlCharset()
setHeadCharset()
setTextWrap()
setHeader()
setSubject()
setFrom()
setReturnPath()
setCc()
setBcc()
setText()
setHtml()
_findHtmlImages()
addHtmlImage()
addAttachment()
_addTextPart()
_addHtmlPart()
_addMixedPart()
_addAlternativePart()
_addRelatedPart()
_addHtmlImagePart()
_addAttachmentPart()
buildMessage()
_encodeHeader()
send()
getRFC822()
Class: htmlMimeMail - X-Ref
| htmlMimeMail() X-Ref |
| Constructor function. Sets the headers if supplied. |
| getFile($filename) X-Ref |
| This function will read a file in from a supplied filename and return it. This can then be given as the first argument of the the functions add_html_image() or add_attachment(). |
| setCrlf($crlf = "\n") X-Ref |
| Accessor to set the CRLF style |
| setSMTPParams($host = null, $port = null, $helo = null, $auth = null, $user = null, $pass = null) X-Ref |
| Accessor to set the SMTP parameters |
| setTextEncoding($encoding = '7bit') X-Ref |
| Accessor function to set the text encoding |
| setHtmlEncoding($encoding = 'quoted-printable') X-Ref |
| Accessor function to set the HTML encoding |
| setTextCharset($charset = 'ISO-8859-1') X-Ref |
| Accessor function to set the text charset |
| setHtmlCharset($charset = 'ISO-8859-1') X-Ref |
| Accessor function to set the HTML charset |
| setHeadCharset($charset = 'ISO-8859-1') X-Ref |
| Accessor function to set the header encoding charset |
| setTextWrap($count = 998) X-Ref |
| Accessor function to set the text wrap count |
| setHeader($name, $value) X-Ref |
| Accessor to set a header |
| setSubject($subject) X-Ref |
| Accessor to add a Subject: header |
| setFrom($from) X-Ref |
| Accessor to add a From: header |
| setReturnPath($return_path) X-Ref |
| Accessor to set the return path |
| setCc($cc) X-Ref |
| Accessor to add a Cc: header |
| setBcc($bcc) X-Ref |
| Accessor to add a Bcc: header |
| setText($text = '') X-Ref |
| Adds plain text. Use this function when NOT sending html email |
| setHtml($html, $text = null, $images_dir = null) X-Ref |
| Adds a html part to the mail. Also replaces image names with content-id's. |
| _findHtmlImages($images_dir) X-Ref |
| Function for extracting images from html source. This function will look through the html code supplied by add_html() and find any file that ends in one of the extensions defined in $obj->image_types. If the file exists it will read it in and embed it, (not an attachment). author: Dan Allen |
| addHtmlImage($file, $name = '', $c_type='application/octet-stream') X-Ref |
| Adds an image to the list of embedded images. |
| addAttachment($file, $name = '', $c_type='application/octet-stream', $encoding = 'base64') X-Ref |
| Adds a file to the list of attachments. |
| _addTextPart(&$obj, $text) X-Ref |
| Adds a text subpart to a mime_part object |
| _addHtmlPart(&$obj) X-Ref |
| Adds a html subpart to a mime_part object |
| _addMixedPart() X-Ref |
| Starts a message with a mixed part |
| _addAlternativePart(&$obj) X-Ref |
| Adds an alternative part to a mime_part object |
| _addRelatedPart(&$obj) X-Ref |
| Adds a html subpart to a mime_part object |
| _addHtmlImagePart(&$obj, $value) X-Ref |
| Adds an html image subpart to a mime_part object |
| _addAttachmentPart(&$obj, $value) X-Ref |
| Adds an attachment subpart to a mime_part object |
| buildMessage($params = array() X-Ref |
| Builds the multipart message from the list ($this->_parts). $params is an array of parameters that shape the building of the message. Currently supported are: $params['html_encoding'] - The type of encoding to use on html. Valid options are "7bit", "quoted-printable" or "base64" (all without quotes). 7bit is EXPRESSLY NOT RECOMMENDED. Default is quoted-printable $params['text_encoding'] - The type of encoding to use on plain text Valid options are "7bit", "quoted-printable" or "base64" (all without quotes). Default is 7bit $params['text_wrap'] - The character count at which to wrap 7bit encoded data. Default this is 998. $params['html_charset'] - The character set to use for a html section. Default is ISO-8859-1 $params['text_charset'] - The character set to use for a text section. - Default is ISO-8859-1 $params['head_charset'] - The character set to use for header encoding should it be needed. - Default is ISO-8859-1 |
| _encodeHeader($input, $charset = 'ISO-8859-1') X-Ref |
| Function to encode a header if necessary according to RFC2047 |
| send($recipients, $type = 'mail') X-Ref |
| Sends the mail. param: array $recipients param: string $type OPTIONAL return: mixed |
| getRFC822($recipients) X-Ref |
| Use this method to return the email in message/rfc822 format. Useful for adding an email to another email as an attachment. there's a commented out example in example.php. |
| [ Powered by PHPXref - Served by Debian GNU/Linux ] |