Skip to content

MailPanel

Type
Class
Namespace
craft\debug
Inherits
craft\debug\MailPanel » yii\debug\panels\MailPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
4.0.0

Debugger panel that collects and displays the generated emails.

View source

Public Properties

PropertyDescription
actionsarray – Array of actions to add to the debug modules default controller.
behaviorsyii\base\Behavior – List of behaviors attached to this component.
datamixed – Data associated with panel
detailstring – Content that is displayed in debugger detail view.
idstring – Panel unique identifier.
mailPath
messagesFileNamearray
modulecraft\debug\Module
namestring – Name of the panel.
summarystring – Content that is displayed at debug toolbar.
tagstring – Request data set identifier.
urlstring – URL pointing to panel detail view.

mailPath

Default value
null

View source

module

Type
craft\debug\Module
Default value
null

View source

Protected Properties

PropertyDescription
erroryii\debug\FlattenException, null – Error while saving the panel

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getDetail()
getError()
getMessagesFileName()Return array of created email files
getName()
getSummary()
getTraceLine()Returns a trace line
getUrl()
hasError()
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()
isEnabled()Checks whether this panel is enabled.
load()Loads data into the panel
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
save()Save info about messages of current request. Each element is array holding message info, such as: time, reply, bc, cc, from, to and other.
setError()
trigger()Triggers an event.

getMessagesFileName()

Return array of created email files

View source

Returns

array

init()

View source

save()

Save info about messages of current request. Each element is array holding message info, such as: time, reply, bc, cc, from, to and other.

View source

Returns

array – Messages

Protected Methods

MethodDescription
getLogMessages()Gets messages from log target and filters according to their categories and levels.