Inheritance diagram for EmailComponent:
Public Member Functions | |
| __attachFiles () | |
| __createBoundary () | |
| __createHeader () | |
| __debug () | |
| __encode ($subject) | |
| __findFiles ($attachment) | |
| __formatAddress ($string, $smtp=false) | |
| __formatMessage ($message) | |
| __mail () | |
| __renderTemplate ($content) | |
| __smtp () | |
| __smtpSend ($data, $checkCode= '250') | |
| __strip ($value, $message=false) | |
| __wrap ($message) | |
| initialize (&$controller, $settings=array()) | |
| reset () | |
| send ($content=null, $template=null, $layout=null) | |
| startup (&$controller) | |
Public Attributes | |
| $__boundary = null | |
| $__header = array() | |
| $__message = array() | |
| $__smtpConnection = null | |
| $_debug = false | |
| $_lineLength = null | |
| $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' | |
Definition at line 38 of file email.php.
| EmailComponent::__attachFiles | ( | ) |
Attach files by adding file contents inside boundaries.
private : modify to use the core File class?
Definition at line 526 of file email.php.
References $handle, and __findFiles().
Referenced by send().
| EmailComponent::__createBoundary | ( | ) |
Create unique boundary identifier
private
Definition at line 438 of file email.php.
References md5().
Referenced by __createHeader().
| EmailComponent::__createHeader | ( | ) |
Create emails headers including (but not limited to) from email address, reply to, bcc and cc.
private
Definition at line 447 of file email.php.
References __createBoundary(), __encode(), __formatAddress(), a(), and e().
Referenced by send().
| EmailComponent::__debug | ( | ) |
Set as controller flash message a debug message showing current settings in component
Definition at line 769 of file email.php.
References __encode().
Referenced by send().
| EmailComponent::__encode | ( | $ | subject | ) |
Encode the specified string using the current charset
| string | $subject String to encode |
Definition at line 603 of file email.php.
References $subject, and __strip().
Referenced by __createHeader(), __debug(), __formatAddress(), and __mail().
| EmailComponent::__findFiles | ( | $ | attachment | ) |
Find the specified attachment in the list of file paths
| string | $attachment Attachment file name to find |
Definition at line 557 of file email.php.
References $path.
Referenced by __attachFiles().
| EmailComponent::__formatAddress | ( | $ | string, | |
| $ | smtp = false | |||
| ) |
Format a string as an email address
| string | $string String representing an email address |
Definition at line 619 of file email.php.
References __encode(), and __strip().
Referenced by __createHeader(), and __smtp().
| EmailComponent::__formatMessage | ( | $ | message | ) |
| EmailComponent::__mail | ( | ) |
Wrapper for PHP mail function used for sending out emails
Definition at line 657 of file email.php.
References __encode().
| EmailComponent::__renderTemplate | ( | $ | content | ) |
Render the contents using the current layout and template.
| string | $content Content to render |
Definition at line 361 of file email.php.
References App::import().
Referenced by send().
| EmailComponent::__smtp | ( | ) |
Sends out email via SMTP
Definition at line 671 of file email.php.
References $bcc, $cc, __formatAddress(), __smtpSend(), env(), and App::import().
| EmailComponent::__smtpSend | ( | $ | data, | |
| $ | checkCode = '250' | |||
| ) |
| EmailComponent::__strip | ( | $ | value, | |
| $ | message = false | |||
| ) |
Remove certain elements (such as bcc:, to:, 0a) from given value
| string | $value Value to strip | |
| boolean | $message Set to true to indicate main message content |
Definition at line 638 of file email.php.
Referenced by __encode(), __formatAddress(), and __wrap().
| EmailComponent::__wrap | ( | $ | message | ) |
Wrap the message using EmailComponent::$lineLength
| string | $message Message to wrap |
Definition at line 576 of file email.php.
References __strip().
Referenced by send().
| EmailComponent::initialize | ( | &$ | controller, | |
| $ | settings = array() | |||
| ) |
Initialize component
| object | $controller Instantiating controller public |
Definition at line 265 of file email.php.
References Object::_set(), and Configure::read().
| EmailComponent::reset | ( | ) |
Reset all EmailComponent internal variables to be able to send out a new email.
public
| EmailComponent::send | ( | $ | content = null, |
|
| $ | template = null, |
|||
| $ | layout = null | |||
| ) |
Send an email using the specified content, template and layout
| 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 |
Definition at line 288 of file email.php.
References $layout, $template, __(), __attachFiles(), __createHeader(), __debug(), __formatMessage(), __renderTemplate(), and __wrap().
| EmailComponent::startup | ( | &$ | controller | ) |
| EmailComponent::$_lineLength = null |
| EmailComponent::$smtpOptions |
| EmailComponent::$subject = null |
1.4.7