HumHub Documentation (unofficial)

BaseMailer extends Component
in package

Application

implements MailerInterface, ViewContextInterface

AbstractYes

BaseMailer serves as a base class that implements the basic functions required by [[MailerInterface]].

Concrete child classes should may focus on implementing the [[sendMessage()]] method.

Interfaces

MailerInterface: MailerInterface is the interface that should be implemented by mailer classes.
ViewContextInterface: ViewContextInterface is the interface that should implemented by classes who want to support relative view names.

Constants

EVENT_AFTER_SEND = 'afterSend'
EVENT_BEFORE_SEND = 'beforeSend'

Properties

$behaviors : array<string|int, Behavior>
$fileTransportCallback : callable|null
$fileTransportPath : string
$htmlLayout : string|bool
$messageClass : string
$messageConfig : array<string|int, mixed>
$textLayout : string|bool
$useFileTransport : bool
$view : View
$viewPath : string
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_message : mixed
$_view : View|array<string|int, mixed>
$_viewPath : string

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
afterSend() : mixed: This method is invoked right after mail was send.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
beforeSend() : bool: This method is invoked right before mail send.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
compose() : MessageInterface: Creates a new message instance and optionally composes its body content via view rendering.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
generateMessageFileName() : string
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getView() : View
getViewPath() : string
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
render() : string: Renders the specified view with optional parameters and layout.
send() : bool: Sends the given email message.
sendMultiple() : int: Sends multiple messages at once.
setView() : mixed
setViewPath() : mixed
trigger() : mixed: Triggers an event.
createMessage() : MessageInterface: Creates a new message instance.
createView() : View: Creates view instance from given configuration.
saveMessage() : bool: Saves the message as a file under [[fileTransportPath]].
sendMessage() : bool: Sends the specified message.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

EVENT_AFTER_SEND


    public
        mixed
    EVENT_AFTER_SEND
    = 'afterSend'

EVENT_BEFORE_SEND


    public
        mixed
    EVENT_BEFORE_SEND
    = 'beforeSend'

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$fileTransportCallback


    public
        callable|null
    $fileTransportCallback

a PHP callback that will be called by [[send()]] when [[useFileTransport]] is true. The callback should return a file name which will be used to save the email message. If not set, the file name will be generated based on the current timestamp.

The signature of the callback is:

function ($mailer, $message)

$fileTransportPath


    public
        string
    $fileTransportPath
     = '@runtime/mail'

the directory where the email messages are saved when [[useFileTransport]] is true.

$htmlLayout


    public
        string|bool
    $htmlLayout
     = 'layouts/html'

HTML layout view name. This is the layout used to render HTML mail body. The property can take the following values:

a relative view name: a view file relative to [[viewPath]], e.g., 'layouts/html'.
a path alias: an absolute view file path specified as a path alias, e.g., '@app/mail/html'.
a boolean false: the layout is disabled.

$messageClass


    public
        string
    $messageClass
     = 'yii\mail\BaseMessage'

the default class name of the new message instances created by [[createMessage()]]

$messageConfig


    public
        array<string|int, mixed>
    $messageConfig
     = []

the configuration that should be applied to any newly created email message instance by [[createMessage()]] or [[compose()]]. Any valid property defined by [[MessageInterface]] can be configured, such as from, to, subject, textBody, htmlBody, etc.

For example:

[
    'charset' => 'UTF-8',
    'from' => 'noreply@mydomain.com',
    'bcc' => 'developer@mydomain.com',
]

$textLayout


    public
        string|bool
    $textLayout
     = 'layouts/text'

text layout view name. This is the layout used to render TEXT mail body. Please refer to [[htmlLayout]] for possible values that this property can take.

$useFileTransport


    public
        bool
    $useFileTransport
     = false

whether to save email messages as files under [[fileTransportPath]] instead of sending them to the actual recipients. This is usually used during development for debugging purpose.

$view


    public
        View
    $view

View instance. Note that the type of this property differs in getter and setter. See [[getView()]] and [[setView()]] for details.

$viewPath


    public
        string
    $viewPath

The directory that contains the view files for composing mail messages Defaults to '@app/mail'.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_message


    private
        mixed
    $_message

$_view


    private
        View|array<string|int, mixed>
    $_view
     = []

view instance or its array configuration.

$_viewPath


    private
        string
    $_viewPath

the directory containing view files for composing mail messages.

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

afterSend()

This method is invoked right after mail was send.


    public
                    afterSend(MessageInterface $message, bool $isSuccessful) : mixed

You may override this method to do some postprocessing or logging based on mail send status. If you override this method, please make sure you call the parent implementation first.

Parameters

$message : MessageInterface
$isSuccessful : bool

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

beforeSend()

This method is invoked right before mail send.


    public
                    beforeSend(MessageInterface $message) : bool

You may override this method to do last-minute preparation for the message. If you override this method, please make sure you call the parent implementation first.

Parameters

$message : MessageInterface

Return values

bool —

whether to continue sending an email.

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

compose()

Creates a new message instance and optionally composes its body content via view rendering.


    public
                    compose([string|array<string|int, mixed>|null $view = null ][, array<string|int, mixed> $params = [] ]) : MessageInterface

Parameters

$view : string|array<string|int, mixed>|null = null

the view to be used for rendering the message body. This can be:

a string, which represents the view name or path alias for rendering the HTML body of the email. In this case, the text body will be generated by applying strip_tags() to the HTML body.
an array with 'html' and/or 'text' elements. The 'html' element refers to the view name or path alias for rendering the HTML body, while 'text' element is for rendering the text body. For example, ['html' => 'contact-html', 'text' => 'contact-text'].
null, meaning the message instance will be returned without body content.

The view to be rendered can be specified in one of the following formats:

path alias (e.g. "@app/mail/contact");
a relative view name (e.g. "contact") located under [[viewPath]].

$params : array<string|int, mixed> = []

the parameters (name-value pairs) that will be extracted and made available in the view file.

Return values

MessageInterface —

message instance.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

generateMessageFileName()


    public
                    generateMessageFileName() : string

Return values

string —

the file name for saving the message when [[useFileTransport]] is true.

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getView()


    public
                    getView() : View

Return values

View —

view instance.

getViewPath()


    public
                    getViewPath() : string

Return values

string —

the directory that contains the view files for composing mail messages Defaults to '@app/mail'.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

render()

Renders the specified view with optional parameters and layout.


    public
                    render(string $view[, array<string|int, mixed> $params = [] ][, string|bool $layout = false ]) : string

The view will be rendered using the [[view]] component.

Parameters

$view : string: the view name or the path alias of the view file.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that will be extracted and made available in the view file.
$layout : string|bool = false: layout view name or path alias. If false, no layout will be applied.

Return values

string —

the rendering result.

send()

Sends the given email message.


    public
                    send(MessageInterface $message) : bool

This method will log a message about the email being sent. If [[useFileTransport]] is true, it will save the email as a file under [[fileTransportPath]]. Otherwise, it will call [[sendMessage()]] to send the email to its recipient(s). Child classes should implement [[sendMessage()]] with the actual email sending logic.

Parameters

$message : MessageInterface: email message instance to be sent

Return values

bool —

whether the message has been sent successfully

sendMultiple()

Sends multiple messages at once.


    public
                    sendMultiple(array<string|int, mixed> $messages) : int

The default implementation simply calls [[send()]] multiple times. Child classes may override this method to implement more efficient way of sending multiple messages.

Parameters

$messages : array<string|int, mixed>: list of email messages, which should be sent.

Return values

int —

number of messages that are successfully sent.

setView()


    public
                    setView(array<string|int, mixed>|View $view) : mixed

Parameters

$view : array<string|int, mixed>|View: view instance or its array configuration that will be used to render message bodies.

setViewPath()


    public
                    setViewPath(string $path) : mixed

Parameters

$path : string: the directory that contains the view files for composing mail messages This can be specified as an absolute path or a path alias.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

createMessage()

Creates a new message instance.


    protected
                    createMessage() : MessageInterface

The newly created instance will be initialized with the configuration specified by [[messageConfig]]. If the configuration does not specify a 'class', the [[messageClass]] will be used as the class of the new message instance.

Return values

MessageInterface —

message instance.

createView()

Creates view instance from given configuration.


    protected
                    createView(array<string|int, mixed> $config) : View

Parameters

$config : array<string|int, mixed>: view configuration.

Return values

View —

view instance.

saveMessage()

Saves the message as a file under [[fileTransportPath]].


    protected
                    saveMessage(MessageInterface $message) : bool

Parameters

$message : MessageInterface

Return values

bool —

whether the message is saved successfully

sendMessage()

Sends the specified message.


    protected
    abstract                sendMessage(MessageInterface $message) : bool

This method should be implemented by child classes with the actual email sending logic.

Parameters

$message : MessageInterface: the message to be sent

Return values

bool —

whether the message is sent successfully

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

BaseMailer extends Component in package Application implements MailerInterface, ViewContextInterface

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

EVENT_AFTER_SEND

Tags

EVENT_BEFORE_SEND

Tags

Properties

$behaviors read-only

$fileTransportCallback

$fileTransportPath

$htmlLayout

$messageClass

$messageConfig

$textLayout

$useFileTransport

Tags

$view

$viewPath

$_behaviors

$_events

$_eventWildcards

Tags

$_message

$_view

$_viewPath

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

afterSend()

Parameters

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

beforeSend()

Parameters

Return values

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

BaseMailer extends Component
in package

Application

implements MailerInterface, ViewContextInterface