EmailMessagesService

Type
Class
Namespace
Craft
Inherits
Craft\EmailMessagesService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class EmailMessagesService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getAllMessages()Returns all of the system email messages.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getMessage()Returns a system email message by its key.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
raiseEvent()Raises an event.
saveMessage()Saves the localized content for a system email message.

getAllMessages()

Returns all of the system email messages.

View source

Arguments

Returns

array

Signature

public array getAllMessages ( $localeId = null )

getMessage()

Returns a system email message by its key.

View source

Arguments

Returns

Craft\RebrandEmailModel

Signature

public Craft\RebrandEmailModel getMessage ( $key, $localeId = null )

saveMessage()

Saves the localized content for a system email message.

View source

Arguments

Returns

boolean

Signature

public boolean saveMessage ( Craft\RebrandEmailModel $message )