# BaseMessage

> BaseMessage serves as a base class that implements the send() method required by yii\mail\MessageInterface.

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

| abstract class | `yii\mail\BaseMessage` |
| --- | --- |
| Extends | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/mail/BaseMessage.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/mail/BaseMessage.php#L25) |

BaseMessage serves as a base class that implements the [`send()`](/docs/api/yii/mail/basemessage/index.md#method-send) method required by [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md).

By default, [`send()`](/docs/api/yii/mail/basemessage/index.md#method-send) will use the "mailer" application component to send the current message.
The "mailer" application component should be a mailer instance implementing [`MailerInterface`](/docs/api/yii/mail/mailerinterface/index.md).

See also: [`BaseMailer`](/docs/api/yii/mail/basemailer/index.md).

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-bcc"></span>`$bcc` | `string\|array` | The Bcc (hidden copy receiver) addresses of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-cc"></span>`$cc` | `string\|array` | The Cc (additional copy receiver) addresses of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-charset"></span>`$charset` | `string` | The character set of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-from"></span>`$from` | `string\|array` | The sender | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-htmlBody"></span>`$htmlBody` write-only | `string` | Message HTML content. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| [`$mailer`](#property-mailer) | [`MailerInterface`](/docs/api/yii/mail/mailerinterface/index.md)`\|null` | The mailer instance that created this message. Default: `null`. | `BaseMessage` |
| <span id="property-replyTo"></span>`$replyTo` | `string\|array` | The reply-to address of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-subject"></span>`$subject` | `string` | The message subject | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-textBody"></span>`$textBody` write-only | `string` | Message plain text content. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="property-to"></span>`$to` | `string\|array` | The message recipients | [`MessageInterface`](/docs/api/yii/mail/messageinterface/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) |
| [`__toString()`](#method-__toString) | PHP magic method that returns the string representation of this object. | `BaseMessage` |
| <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-attach"></span>[`attach()`](/docs/api/yii/mail/messageinterface/index.md#method-attach) abstract | Attaches existing file to the email message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-attachContent"></span>[`attachContent()`](/docs/api/yii/mail/messageinterface/index.md#method-attachContent) abstract | Attach specified content as file for the email message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/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-embed"></span>[`embed()`](/docs/api/yii/mail/messageinterface/index.md#method-embed) abstract | Attach a file and return it's CID source. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-embedContent"></span>[`embedContent()`](/docs/api/yii/mail/messageinterface/index.md#method-embedContent) abstract | Attach a content as file and return it's CID source. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getBcc"></span>[`getBcc()`](/docs/api/yii/mail/messageinterface/index.md#method-getBcc) abstract | Returns the Bcc (hidden copy receiver) addresses of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getCc"></span>[`getCc()`](/docs/api/yii/mail/messageinterface/index.md#method-getCc) abstract | Returns the Cc (additional copy receiver) addresses of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getCharset"></span>[`getCharset()`](/docs/api/yii/mail/messageinterface/index.md#method-getCharset) abstract | Returns the character set of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getFrom"></span>[`getFrom()`](/docs/api/yii/mail/messageinterface/index.md#method-getFrom) abstract | Returns the message sender. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getReplyTo"></span>[`getReplyTo()`](/docs/api/yii/mail/messageinterface/index.md#method-getReplyTo) abstract | Returns the reply-to address of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getSubject"></span>[`getSubject()`](/docs/api/yii/mail/messageinterface/index.md#method-getSubject) abstract | Returns the message subject. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-getTo"></span>[`getTo()`](/docs/api/yii/mail/messageinterface/index.md#method-getTo) abstract | Returns the message recipient(s). | [`MessageInterface`](/docs/api/yii/mail/messageinterface/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) |
| [`send()`](#method-send) | Sends this email message. | `BaseMessage` |
| <span id="method-setBcc"></span>[`setBcc()`](/docs/api/yii/mail/messageinterface/index.md#method-setBcc) abstract | Sets the Bcc (hidden copy receiver) addresses of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setCc"></span>[`setCc()`](/docs/api/yii/mail/messageinterface/index.md#method-setCc) abstract | Sets the Cc (additional copy receiver) addresses of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setCharset"></span>[`setCharset()`](/docs/api/yii/mail/messageinterface/index.md#method-setCharset) abstract | Sets the character set of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setFrom"></span>[`setFrom()`](/docs/api/yii/mail/messageinterface/index.md#method-setFrom) abstract | Sets the message sender. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setHtmlBody"></span>[`setHtmlBody()`](/docs/api/yii/mail/messageinterface/index.md#method-setHtmlBody) abstract | Sets message HTML content. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setReplyTo"></span>[`setReplyTo()`](/docs/api/yii/mail/messageinterface/index.md#method-setReplyTo) abstract | Sets the reply-to address of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setSubject"></span>[`setSubject()`](/docs/api/yii/mail/messageinterface/index.md#method-setSubject) abstract | Sets the message subject. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setTextBody"></span>[`setTextBody()`](/docs/api/yii/mail/messageinterface/index.md#method-setTextBody) abstract | Sets message plain text content. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-setTo"></span>[`setTo()`](/docs/api/yii/mail/messageinterface/index.md#method-setTo) abstract | Sets the message recipient(s). | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |
| <span id="method-toString"></span>[`toString()`](/docs/api/yii/mail/messageinterface/index.md#method-toString) abstract | Returns string representation of this message. | [`MessageInterface`](/docs/api/yii/mail/messageinterface/index.md) |

## Property details

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

```php
public yii\mail\MailerInterface|null $mailer = null
```

The mailer instance that created this message.

For independently created messages this is `null`.

## Method details

### __toString() <span id="method-__toString"></span>

```php
public function __toString(): string
```

PHP magic method that returns the string representation of this object.

**Returns**

`string`: The string representation of this object.

### send() <span id="method-send"></span>

```php
public function send(yii\mail\MailerInterface|null $mailer = null): bool
```

Sends this email message.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$mailer` | [`MailerInterface`](/docs/api/yii/mail/mailerinterface/index.md)`\|null` | The mailer that should be used to send this message. If no mailer is given it will first check if [`$mailer`](/docs/api/yii/mail/basemessage/index.md#property-mailer) is set and if not, the "mailer" application component will be used instead. |

**Returns**

`bool`: Whether this message is sent successfully.