Class yii\debug\panels\MailPanel
| Inheritance | yii\debug\panels\MailPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-debug/blob/master/panels/MailPanel.php |
Debugger panel that collects and displays the generated emails.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $actions | array | Array of actions to add to the debug modules default controller. | yii\debug\Panel |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $data | mixed | Data associated with panel | yii\debug\Panel |
| $detail | string | Content that is displayed in debugger detail view | yii\debug\panels\MailPanel |
| $id | string | Panel unique identifier. | yii\debug\Panel |
| $mailPath | string | Path where all emails will be saved. | yii\debug\panels\MailPanel |
| $messagesFileName | array | yii\debug\panels\MailPanel | |
| $module | yii\debug\Module | yii\debug\Panel | |
| $name | string | Name of the panel | yii\debug\panels\MailPanel |
| $summary | string | Content that is displayed at debug toolbar | yii\debug\panels\MailPanel |
| $tag | string | Request data set identifier. | yii\debug\Panel |
| $url | string | URL pointing to panel detail view | yii\debug\Panel |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $error | yii\debug\FlattenException|null | Error while saving the panel | yii\debug\Panel |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getDetail() | yii\debug\panels\MailPanel | |
| getError() | yii\debug\Panel | |
| getMessagesFileName() | Return array of created email files | yii\debug\panels\MailPanel |
| getName() | yii\debug\panels\MailPanel | |
| getSummary() | yii\debug\panels\MailPanel | |
| getTraceLine() | Returns a trace line | yii\debug\Panel |
| getUrl() | yii\debug\Panel | |
| hasError() | yii\debug\Panel | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\debug\panels\MailPanel |
| isEnabled() | Checks whether this panel is enabled. | yii\debug\Panel |
| load() | Loads data into the panel | yii\debug\Panel |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| 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. | yii\debug\panels\MailPanel |
| setError() | yii\debug\Panel | |
| trigger() | Triggers an event. | yii\base\Component |
Property Details
Content that is displayed in debugger detail view
Path where all emails will be saved. should be an alias.
Name of the panel
Content that is displayed at debug toolbar
Method Details
| public string getDetail ( ) | ||
| return | string | Content that is displayed in debugger detail view |
|---|---|---|
Return array of created email files
| public array getMessagesFileName ( ) |
| public string getName ( ) | ||
| return | string | Name of the panel |
|---|---|---|
| public string getSummary ( ) | ||
| return | string | Content that is displayed at debug toolbar |
|---|---|---|
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init ( ) |
Save info about messages of current request. Each element is array holding message info, such as: time, reply, bc, cc, from, to and other.
| public array save ( ) | ||
| return | array | Messages |
|---|---|---|