PiiMailer
| Package | pii.core |
|---|---|
| Inheritance | class PiiMailer » CApplicationComponent » CComponent |
| Implements | IApplicationComponent |
| Since | 2.0 |
| Version | $Id$ |
ApplicationComponent PiiMailer is the email class for Pii.
This class requires that a controller is present in Yii::app()->controller!!
This class requires that a controller is present in Yii::app()->controller!!
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| behaviors | array | the behaviors that should be attached to this component. | CApplicationComponent |
| controller | CController | the currently active controller | PiiMailer |
| isInitialized | boolean | whether this application component has been initialized (i. | CApplicationComponent |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| getController() | PiiMailer | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIsInitialized() | CApplicationComponent | |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes the application component. | CApplicationComponent |
| raiseEvent() | Raises an event. | CComponent |
| renderMail() | Renders the email template given in $name. | PiiMailer |
| sendAdminMail() | PiiMailer | |
| sendAdminNotification() | Sends a notification email to the admin. | PiiMailer |
| sendUserActivation() | Sends activation to inform user about activation of his account. | PiiMailer |
| sendUserEmailVerification() | Sends verification email to user's verifyEmail address. | PiiMailer |
| sendUserForgotPassword() | Sends email with info on how to update the password. | PiiMailer |
| sendUserMail() | PiiMailer | |
| sendUserVerification() | Sends verification email with info on how | PiiMailer |
Property Details
controller
property
read-only
public CController getController()
the currently active controller
Method Details
getController()
method
|
public CController getController()
| ||
| {return} | CController | the currently active controller |
renderMail()
method
|
public string renderMail(string $name, array $data=array (
))
| ||
| $name | string | $name of the email template |
| $data | array | $data to be rendered |
| {return} | string | the email body |
Renders the email template given in $name.
sendAdminMail()
method
|
public void sendAdminMail($view, $data, $subject)
| ||
| $view | ||
| $data | ||
| $subject | ||
sendAdminNotification()
method
|
public void sendAdminNotification(mixed $user)
| ||
| $user | mixed | $user the new user |
Sends a notification email to the admin.
sendUserActivation()
method
|
public void sendUserActivation(mixed $user)
| ||
| $user | mixed | $user the activated user |
Sends activation to inform user about activation of his account.
sendUserEmailVerification()
method
|
public void sendUserEmailVerification(mixed $user)
| ||
| $user | mixed | $user the user to verify |
Sends verification email to user's verifyEmail address.
sendUserForgotPassword()
method
|
public void sendUserForgotPassword(mixed $user)
| ||
| $user | mixed | $user the user that should receive the email |
Sends email with info on how to update the password.
sendUserMail()
method
|
public void sendUserMail($view, $data, $subject=NULL)
| ||
| $view | ||
| $data | ||
| $subject | ||
sendUserVerification()
method
|
public void sendUserVerification(mixed $user)
| ||
| $user | mixed | $user the new registered user |
Sends verification email with info on how to activate the account.