# MailEvent

> MailEvent represents the event parameter used for events triggered by yii\mail\BaseMailer.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [mail](/docs/api/yii/mail/index.md) › MailEvent

| class | `yii\mail\MailEvent` |
| --- | --- |
| Extends | [`yii\base\Event`](/docs/api/yii/base/event/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/mail/MailEvent.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/mail/MailEvent.php#L21) |

MailEvent represents the event parameter used for events triggered by [`BaseMailer`](/docs/api/yii/mail/basemailer/index.md).

By setting the [`$isValid`](/docs/api/yii/mail/mailevent/index.md#property-isValid) property, one may control whether to continue running the action.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-data"></span>[`$data`](/docs/api/yii/base/event/index.md#property-data) | `mixed` | The data that is passed to [`Component::on()`](/docs/api/yii/base/component/index.md#method-on) when attaching an event handler. Default: `null`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="property-handled"></span>[`$handled`](/docs/api/yii/base/event/index.md#property-handled) | `bool` | Whether the event is handled. Default: `false`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="property-isSuccessful"></span>`$isSuccessful` | `bool` | If message was sent successfully. Default: `null`. | `MailEvent` |
| [`$isValid`](#property-isValid) | `bool` | Whether to continue sending an email. Default: `true`. | `MailEvent` |
| <span id="property-message"></span>`$message` | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) | The mail message being send. Default: `null`. | `MailEvent` |
| <span id="property-name"></span>[`$name`](/docs/api/yii/base/event/index.md#property-name) | `string` | The event name. Default: `null`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="property-sender"></span>[`$sender`](/docs/api/yii/base/event/index.md#property-sender) | `object\|null` | The sender of this event. Default: `null`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/baseobject/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/baseobject/index.md#method-__get) | Returns the value of an object property. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/baseobject/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/baseobject/index.md#method-__set) | Sets value of an object property. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/baseobject/index.md#method-__unset) | Sets an object property to null. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/baseobject/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/baseobject/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-hasHandlers"></span>[`hasHandlers()`](/docs/api/yii/base/event/index.md#method-hasHandlers) static | Returns a value indicating whether there is any handler attached to the specified class-level event. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/baseobject/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/baseobject/index.md#method-hasProperty) | Returns a value indicating whether a property is defined. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-init"></span>[`init()`](/docs/api/yii/base/baseobject/index.md#method-init) | Initializes the object. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/event/index.md#method-off) static | Detaches an event handler from a class-level event. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="method-offAll"></span>[`offAll()`](/docs/api/yii/base/event/index.md#method-offAll) static | Detaches all registered class-level event handlers. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/event/index.md#method-on) static | Attaches an event handler to a class-level event. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/event/index.md#method-trigger) static | Triggers a class-level event. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |

## Property details

### $isValid <span id="property-isValid"></span>

```php
public bool $isValid = true
```

Whether to continue sending an email.

Event handlers of
[`BaseMailer::EVENT_BEFORE_SEND`](/docs/api/yii/mail/basemailer/index.md#event-EVENT_BEFORE_SEND) may set this property to decide whether
to continue send or not.