EmailComponent
This component is used for handling Internet Message Format based based on the standard outlined in http://www.rfc-editor.org/rfc/rfc2822.txt
$_controller
protected $additionalParams
public string
$attachments
public array
$bcc
public array
$cc
public array
$charset
public string
$date
public string
The date to put in the Date: header. This should be a date conforming with the RFC2822 standard. Leave null, to have today's date generated.
$delivery
public string
$filePaths
public array
$from
public string
$headers
public array
Associative array of a user defined headers Keys will be prefixed 'X-' as per RFC2822 Section 4.7.5
$htmlMessage
public string
$layout
public string
$lineFeed
public string
Line feed character(s) to be used when sending using mail() function By default PHP_EOL is used. RFC2822 requires it to be CRLF but some Unix mail transfer agents replace LF by CRLF automatically (which leads to doubling CR if CRLF is used).
$messageId
public mixed
Whether to generate a Message-ID header for the e-mail. True to generate a Message-ID, False to let it be handled by sendmail (or similar) or a string to completely override the Message-ID.
$readReceipt
public string
$replyTo
public string
$return
public string
The mail that will be used in case of any errors like - Remote mailserver down - Remote user has exceeded his quota - Unknown user
$sendAs
public string
$smtpOptions
public array
$subject
public string
$template
public string
$textMessage
public string
$to
public string
$xMailer
public string
Remove certain elements (such as bcc:, to:, %0a) from given value. Helps prevent header injection / manipulation on user content.
__construct( ComponentCollection $collection , array $settings array() )
Constructor
ComponentCollection
$collection
$settings
optional array() Component::__construct()
_findFiles( string $attachment )
Find the specified attachment in the list of file paths
$attachment
_formatAddresses( array $addresses )
Format addresses to be an array with email as key and alias as value
$addresses
_strip( string $value , boolean $message false )
Remove certain elements (such as bcc:, to:, %0a) from given value. Helps prevent header injection / manipulation on user content.
$value
$message
optional false initialize( Controller $controller )
Initialize component
Controller
$controller
Component::initialize()
reset( )
Reset all EmailComponent internal variables to be able to send out a new email.
send( string|array $content null , string $template null , string $layout null )
Send an email using the specified content, template and layout
$content
optional null Either an array of text lines, or a string with contents If you are rendering a template this variable will be sent to the templates as $content
$template
optional null $layout
optional null __get( string $name )
Magic method for lazy loading $components.
$name
beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )
Called before Controller::redirect(). Allows you to replace the URL that will be redirected to with a new URL. The return of this method can either be an array or a string.
If the return is an array and contains a 'url' key. You may also supply the following:
status
The status code for the redirectexit
Whether or not the redirect should exit.If your response is a string or an array that does not contain a 'url' key it will be used as the new URL to redirect to.
Controller
$controller
$url
$status
optional null $exit
optional true beforeRender( Controller $controller )
Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()
Controller
$controller
shutdown( Controller $controller )
Called after Controller::render() and before the output is printed to the browser.
Controller
$controller
startup( Controller $controller )
Called after the Controller::beforeFilter() and before the controller action
Controller
$controller
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
$properties
$class
$normalize
optional true _set( array $properties array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
$method
$params
optional array() log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
requestAction( string|array $url , array $extra array() )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$url
String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.
$extra
optional array() if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
CakeObject-to-string conversion. Each class can override this method as necessary.
public string
List of additional headers
These will NOT be used if you are using safemode and mail()
null
public array
List of files that should be attached to the email.
Can be both absolute and relative paths
array()
public array
Blind Carbon Copy
List of email's that should receive a copy of the email. The Recipient WILL NOT be able to see this list
array()
public array
Carbon Copy
List of email's that should receive a copy of the email. The Recipient WILL be able to see this list
array()
public string
The date to put in the Date: header. This should be a date conforming with the RFC2822 standard. Leave null, to have today's date generated.
null
public string
What method should the email be sent by
Supported methods: - mail - smtp - debug
'mail'
public array
Associative array of a user defined headers Keys will be prefixed 'X-' as per RFC2822 Section 4.7.5
array()
public string
Line feed character(s) to be used when sending using mail() function By default PHP_EOL is used. RFC2822 requires it to be CRLF but some Unix mail transfer agents replace LF by CRLF automatically (which leads to doubling CR if CRLF is used).
PHP_EOL
public mixed
Whether to generate a Message-ID header for the e-mail. True to generate a Message-ID, False to let it be handled by sendmail (or similar) or a string to completely override the Message-ID.
If you are sending Email from a shell, be sure to set this value. As you could encounter delivery issues if you do not.
true
public string
The mail that will be used in case of any errors like - Remote mailserver down - Remote user has exceeded his quota - Unknown user
null
public string
What format should the email be sent in
Supported formats: - text - html - both
'text'
public array
List of options to use for smtp mail method
Options is: - port - host - timeout - username - password - client
array()
public string
What mailer should EmailComponent identify itself as
'CakePHP Email Component'
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-EmailComponent.html