Docs For Class CMS

CMS_email

Description

Class CMS_email

Creates email with Sender, receiver, subject and body Also has the ability to send an email Correct input assumed

author: Andre Haynes <andre.haynes@ws-interactive.fr> &
author:
Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>
Methods EncodeHeader, EncodeQP, EncodeQ, FixEOL are based on phpmailer version 2.0.0RC1 See phpmailer.sourceforge.net for license (LGPL) informations and authors.
author: Andy Prevost (project admininistrator)
author: Brent R. Matzelle (original founder)

Located in /automne/classes/common/email.php (line 36)

CMS_grandFather
   |
   --CMS_email

Method Summary

void __construct ()

string, convertTextToHTML (string $body)

void EncodeHeader ( $str, [ $position = 'text'])

string EncodeQ ( $str, [ $position = 'text'])

string EncodeQP ( $str)

void FixEOL ( $str)

String getBody ()

String getEmailEncoding ()

String getEmailFrom ()

mixed getEmailHTML ()

String getEmailTo ()

String getFooter ()

String getSubject ()

String getTemplate ()

boolean sendEmail ()

boolean setBCC (mixed $emailBcc)

void setBody (String $body, String $bodyParameters)

boolean setCC (mixed $emailCc)

void setEmailEncoding ([String $emailEncoding = APPLICATION_DEFAULT_ENCODING])

void setEmailFrom ([String $emailFrom = APPLICATION_POSTMASTER_EMAIL])

void setEmailHTML ([mixed $emailHTML = false])

boolean setEmailTo (mixed $emailTo)

boolean setErrorReturn (string $error)

boolean setFile ( $file, string $to)

void setFooter (String $footer)

boolean setFromName (string $from)

void setSubject (String $subject, [Boolean $withApplicationLabel = false], [Array $separators = array('[',']')], (array)String $subjectParameters)

boolean setTemplate (String $template)

boolean setToName (string $to)

Methods

Constructor __construct (line 164)

Constructor.

use internal functions setBody, setSubject, setEmailTo and setEmailFrom instead

access: public

void __construct ()

convertTextToHTML (line 499)

Convert textBody to HTMLBody, convert all links and \n tags

return: the body converted in html
access: public

string, convertTextToHTML (string $body)

string $body: The body to convert

EncodeHeader (line 699)

void EncodeHeader ( $str, [ $position = 'text'])

$str
$position

EncodeQ (line 770)

Encode string to q encoding.

access: private

string EncodeQ ( $str, [ $position = 'text'])

$str
$position

EncodeQP (line 749)

Encode string to quoted-printable.

access: private

string EncodeQP ( $str)

$str

FixEOL (line 798)

void FixEOL ( $str)

$str

getBody (line 248)

Gets Email body

access: public

String getBody ()

getEmailEncoding (line 412)

Gets Email encoding

access: public

String getEmailEncoding ()

getEmailFrom (line 487)

Gets Email sender

access: public

String getEmailFrom ()

getEmailHTML (line 463)

Gets Email HTML

return: (false if no html set, html string otherwise)
access: public

mixed getEmailHTML ()

getEmailTo (line 389)

Gets Email recipient

access: public

String getEmailTo ()

getFooter (line 271)

Gets Email footer

access: public

String getFooter ()

getSubject (line 224)

Gets Email subject

access: public

String getSubject ()

getTemplate (line 300)

Gets Email template (relative to FS)

access: public

String getTemplate ()

sendEmail (line 530)

Send the mail

return: true on success, false on failure
access: public

boolean sendEmail ()

setBCC (line 364)

Sets Email hidden copy (Bcc) recipient

access: public

boolean setBCC (mixed $emailBcc)

mixed $emailBcc: string or array of emails

setBody (line 238)

Sets Email body

access: public

void setBody (String $body, String $bodyParameters)

String $body
String $bodyParameters

setCC (line 338)

Sets Email copy (Cc) recipient

access: public

boolean setCC (mixed $emailCc)

mixed $emailCc: string or array of emails

setEmailEncoding (line 452)

Sets Email encoding

access: public

void setEmailEncoding ([String $emailEncoding = APPLICATION_DEFAULT_ENCODING])

String $emailEncoding

setEmailFrom (line 402)

Sets Email sender

access: public

void setEmailFrom ([String $emailFrom = APPLICATION_POSTMASTER_EMAIL])

String $emailFrom

setEmailHTML (line 477)

Sets Email HTML

access: public

void setEmailHTML ([mixed $emailHTML = false])

mixed $emailHTML: : false if no html content set, html string otherwise

setEmailTo (line 312)

Sets Email recipient

access: public

boolean setEmailTo (mixed $emailTo)

mixed $emailTo: string or array of emails

setErrorReturn (line 176)

Sets email for the errors return

return: true on success, false on failure
access: public

boolean setErrorReturn (string $error)

string $error: The email to set

setFile (line 189)

Sets the Attach File of the mail

return: true on success, false on failure
access: public

boolean setFile ( $file, string $to)

string $to: The To to set
$file

setFooter (line 261)

Sets Email footer

access: public

void setFooter (String $footer)

String $footer

setFromName (line 424)

Sets the From Name of the mail

return: true on success, false on failure
access: public

boolean setFromName (string $from)

string $from: The from name to set

setSubject (line 210)

Sets Email subject

access: public

void setSubject (String $subject, [Boolean $withApplicationLabel = false], [Array $separators = array('[',']')], (array)String $subjectParameters)

(array)String $subjectParameters
String $subject
Boolean $withApplicationLabel: : default false. For subject only.
Array $separators: : to separate the APPLICATION_LABEL.

setTemplate (line 284)

Sets Email template

access: public

boolean setTemplate (String $template)

String $template: path (relative to FS)

setToName (line 438)

Sets the To Name of the mail

return: true on success, false on failure
access: public

boolean setToName (string $to)

string $to: The to name to set

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:30:08 +0100 by phpDocumentor 1.4.3