EmailComponent Class Reference

Inheritance diagram for EmailComponent:

Object

List of all members.


Public Member Functions

 reset ()
 send ($content=null, $template=null, $layout=null)
 startup (&$controller)

Public Attributes

 $_debug = false
 $_error = false
 $_lineLength = null
 $_newLine = "\n"
 $additionalParams = null
 $attachments = array()
 $bcc = array()
 $cc = array()
 $charset = 'utf-8'
 $delivery = 'mail'
 $filePaths = array()
 $from = null
 $headers = array()
 $layout = 'default'
 $lineLength = 70
 $readReceipt = null
 $replyTo = null
 $return = null
 $sendAs = 'text'
 $smtpError = null
 $smtpOptions
 $subject = null
 $template = null
 $to = null
 $xMailer = 'CakePHP Email Component'

Detailed Description

Definition at line 39 of file email.php.

Member Function Documentation

EmailComponent::reset (  ) 

Reset all EmailComponent internal variables to be able to send out a new email.

public

Definition at line 346 of file email.php.

EmailComponent::send ( $  content = null,
$  template = null,
$  layout = null 
)

Send an email using the specified content, template and layout

Parameters:
mixed $content Either an array of text lines, or a string with contents
string $template Template to use when sending email
string $layout Layout to use to enclose email body
Returns:
boolean Success public

Definition at line 295 of file email.php.

References $layout, and $template.

EmailComponent::startup ( &$  controller  ) 

Startup component

Parameters:
object $controller Instantiating controller public

Definition at line 280 of file email.php.

References Configure::read().

Member Data Documentation

EmailComponent::$_debug = false

Definition at line 231 of file email.php.

EmailComponent::$_error = false

Definition at line 238 of file email.php.

EmailComponent::$_lineLength = null

Deprecated:
see lineLength

Definition at line 146 of file email.php.

EmailComponent::$_newLine = "\n"

Definition at line 245 of file email.php.

EmailComponent::$additionalParams = null

Definition at line 121 of file email.php.

EmailComponent::$attachments = array()

Definition at line 186 of file email.php.

EmailComponent::$bcc = array()

Definition at line 97 of file email.php.

EmailComponent::$cc = array()

Definition at line 87 of file email.php.

EmailComponent::$charset = 'utf-8'

Definition at line 177 of file email.php.

EmailComponent::$delivery = 'mail'

Definition at line 170 of file email.php.

EmailComponent::$filePaths = array()

Definition at line 200 of file email.php.

EmailComponent::$from = null

Definition at line 53 of file email.php.

EmailComponent::$headers = array()

Definition at line 112 of file email.php.

EmailComponent::$layout = 'default'

Definition at line 128 of file email.php.

Referenced by send().

EmailComponent::$lineLength = 70

Definition at line 142 of file email.php.

EmailComponent::$readReceipt = null

Definition at line 67 of file email.php.

EmailComponent::$replyTo = null

Definition at line 60 of file email.php.

EmailComponent::$return = null

Definition at line 77 of file email.php.

EmailComponent::$sendAs = 'text'

Definition at line 158 of file email.php.

EmailComponent::$smtpError = null

Definition at line 224 of file email.php.

EmailComponent::$smtpOptions

Initial value:

 array(
        'port'=> 25, 'host' => 'localhost', 'timeout' => 30
    )

Definition at line 214 of file email.php.

EmailComponent::$subject = null

Definition at line 104 of file email.php.

EmailComponent::$template = null

Definition at line 135 of file email.php.

Referenced by send().

EmailComponent::$to = null

Definition at line 46 of file email.php.

EmailComponent::$xMailer = 'CakePHP Email Component'

Definition at line 193 of file email.php.

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