Docs For Class src_mail

Class src_mail_htmlMimeMail5

Description

This file is part of the htmlMimeMail5 package (http://www.phpguru.org/)

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

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

You should have received a copy of the GNU General Public License along with htmlMimeMail5; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

filesource: Source Code for this file
access: public
copyright: Copyright (c) 2005
version: $Revision: 1.3 $
author: Richard Heyes <richard@phpguru.org>

Located in /src/mail/class.htmlMimeMail5.php (line 29)

Method Summary

src_mail_htmlMimeMail5 __construct ()

void addAttachment (string $attachment)

void addEmbeddedImage ( $embeddedImage, string $object)

void getRFC822 (array $recipients, [string $type = 'mail'])

mixed send (array $recipients, [string $type = 'mail'])

void setBcc (string $bcc)

void setCc (string $cc)

void setCRLF ([string $crlf = "\n"])

void setFrom (string $from)

void setHeadCharset ([string $charset = 'ISO-8859-1'])

void setHeader (string $name, string $value)

void setHTML (string $html, [string $images_dir = null])

void setHTMLCharset ([string $charset = 'ISO-8859-1'])

void setHTMLEncoding (iEncoding $encoding)

void setPriority ([mixed $priority = 'normal'])

void setReturnPath (string $return_path)

void setSendmailPath (string $path)

void setSMTPParams ([string $host = null], [string $port = null], [string $helo = null], [bool $auth = null], [string $user = null], [string $pass = null])

void setSubject (string $subject)

void setText (string $text)

void setTextCharset ([string $charset = 'ISO-8859-1'])

void setTextEncoding (iEncoding $encoding)

void setTextWrap ([integer $count = 998])

Methods

Constructor __construct (line 106)

Constructor function.

access: public

src_mail_htmlMimeMail5 __construct ()

addAttachment (line 447)

Adds a file to the list of attachments.

access: public

void addAttachment (string $attachment)

string $attachment: Attachment object

addEmbeddedImage (line 436)

Adds an image to the list of embedded images.

access: public

void addEmbeddedImage ( $embeddedImage, string $object)

string $object: Embedded image object
$embeddedImage

getRFC822 (line 821)

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.

access: public

void getRFC822 (array $recipients, [string $type = 'mail'])

array $recipients: Array of recipients
string $type: Method to be used to send the mail. Used to determine the line ending type.

send (line 698)

Sends the mail.

access: public

mixed send (array $recipients, [string $type = 'mail'])

array $recipients: Array of receipients to send the mail to
string $type: How to send the mail ('mail' or 'sendmail' or 'smtp')

setBcc (line 357)

Accessor to add a Bcc: header

access: public

void setBcc (string $bcc)

string $bcc: Blind Carbon Copy address

setCc (line 348)

Accessor to add a Cc: header

access: public

void setCc (string $cc)

string $cc: Carbon Copy address

setCRLF (line 179)

Accessor to set the CRLF style

access: public

void setCRLF ([string $crlf = "\n"])

string $crlf: CRLF style to use. Use \r\n for SMTP, and \n for normal.

setFrom (line 301)

Accessor to add a From: header

access: public

void setFrom (string $from)

string $from: From address

setHeadCharset (line 264)

Accessor function to set the header encoding charset

access: public

void setHeadCharset ([string $charset = 'ISO-8859-1'])

string $charset: Character set to use

setHeader (line 283)

Accessor to set a header

access: public

void setHeader (string $name, string $value)

string $name: Name of header
string $value: Value of header

setHTML (line 379)

Adds HTML to the emails, with an associated text part.

If third part is given, images in the email will be loaded from this directory.

void setHTML (string $html, [string $images_dir = null])

string $html: HTML part of email
string $images_dir: Images directory

setHTMLCharset (line 255)

Accessor function to set the HTML charset

access: public

void setHTMLCharset ([string $charset = 'ISO-8859-1'])

string $charset: Character set to use

setHTMLEncoding (line 237)

Accessor function to set the HTML encoding

access: public

void setHTMLEncoding (iEncoding $encoding)

object $encoding: HTML encoding to use

setPriority (line 312)

Accessor to set priority. Priority given should be either high, normal or low. Can also be specified numerically, being 1, 3 or 5 (respectively).

access: public

void setPriority ([mixed $priority = 'normal'])

mixed $priority: The priority to use.

setReturnPath (line 339)

Accessor to set the return path

access: public

void setReturnPath (string $return_path)

string $return_path: Return path to use

setSendmailPath (line 219)

Sets sendmail path and options (optionally) (when directly piping to sendmail)

access: public

void setSendmailPath (string $path)

string $path: Path and options for sendmail command

setSMTPParams (line 199)

Accessor to set the SMTP parameters

access: public

void setSMTPParams ([string $host = null], [string $port = null], [string $helo = null], [bool $auth = null], [string $user = null], [string $pass = null])

string $host: Hostname
string $port: Port
string $helo: HELO string to use
bool $auth: User authentication or not
string $user: Username
string $pass: Password

setSubject (line 292)

Accessor to add a Subject: header

access: public

void setSubject (string $subject)

string $subject: Subject to set

setText (line 367)

Adds plain text. Use this function when NOT sending html email

access: public

void setText (string $text)

string $text: Plain text of email

setTextCharset (line 246)

Accessor function to set the text charset

access: public

void setTextCharset ([string $charset = 'ISO-8859-1'])

string $charset: Character set to use

setTextEncoding (line 228)

Accessor function to set the text encoding

access: public

void setTextEncoding (iEncoding $encoding)

object $encoding: Text encoding to use

setTextWrap (line 273)

Accessor function to set the text wrap count

access: public

void setTextWrap ([integer $count = 998])

integer $count: Point at which to wrap text

Documentation generated on Sat, 24 Mar 2007 09:59:27 +0100 by phpDocumentor 1.3.1