BaseMessage

API reference › yii › mail › BaseMessage

abstract class	`yii\mail\BaseMessage`
Extends	`yii\base\BaseObject`
Implements	`MessageInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/mail/BaseMessage.php`

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

By default, send() will use the “mailer” application component to send the current message. The “mailer” application component should be a mailer instance implementing MailerInterface.

Properties

Property	Type	Description	Defined by
`$bcc`	`string\|array`	The Bcc (hidden copy receiver) addresses of this message.	`MessageInterface`
`$cc`	`string\|array`	The Cc (additional copy receiver) addresses of this message.	`MessageInterface`
`$charset`	`string`	The character set of this message.	`MessageInterface`
`$from`	`string\|array`	The sender	`MessageInterface`
`$htmlBody` write-only	`string`	Message HTML content.	`MessageInterface`
`$mailer`	`MailerInterface\|null`	The mailer instance that created this message. Default: `null`.	`BaseMessage`
`$replyTo`	`string\|array`	The reply-to address of this message.	`MessageInterface`
`$subject`	`string`	The message subject	`MessageInterface`
`$textBody` write-only	`string`	Message plain text content.	`MessageInterface`
`$to`	`string\|array`	The message recipients	`MessageInterface`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__toString()`	PHP magic method that returns the string representation of this object.	`BaseMessage`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`attach()` abstract	Attaches existing file to the email message.	`MessageInterface`
`attachContent()` abstract	Attach specified content as file for the email message.	`MessageInterface`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`embed()` abstract	Attach a file and return it’s CID source.	`MessageInterface`
`embedContent()` abstract	Attach a content as file and return it’s CID source.	`MessageInterface`
`getBcc()` abstract	Returns the Bcc (hidden copy receiver) addresses of this message.	`MessageInterface`
`getCc()` abstract	Returns the Cc (additional copy receiver) addresses of this message.	`MessageInterface`
`getCharset()` abstract	Returns the character set of this message.	`MessageInterface`
`getFrom()` abstract	Returns the message sender.	`MessageInterface`
`getReplyTo()` abstract	Returns the reply-to address of this message.	`MessageInterface`
`getSubject()` abstract	Returns the message subject.	`MessageInterface`
`getTo()` abstract	Returns the message recipient(s).	`MessageInterface`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`send()`	Sends this email message.	`BaseMessage`
`setBcc()` abstract	Sets the Bcc (hidden copy receiver) addresses of this message.	`MessageInterface`
`setCc()` abstract	Sets the Cc (additional copy receiver) addresses of this message.	`MessageInterface`
`setCharset()` abstract	Sets the character set of this message.	`MessageInterface`
`setFrom()` abstract	Sets the message sender.	`MessageInterface`
`setHtmlBody()` abstract	Sets message HTML content.	`MessageInterface`
`setReplyTo()` abstract	Sets the reply-to address of this message.	`MessageInterface`
`setSubject()` abstract	Sets the message subject.	`MessageInterface`
`setTextBody()` abstract	Sets message plain text content.	`MessageInterface`
`setTo()` abstract	Sets the message recipient(s).	`MessageInterface`
`toString()` abstract	Returns string representation of this message.	`MessageInterface`

Property details

$mailer

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

The mailer instance that created this message.

For independently created messages this is null.

Method details

__toString()

public function __toString(): string

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

Returns

string: The string representation of this object.

send()

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

Sends this email message.

Parameters

Parameter	Type	Description
`$mailer`	`MailerInterface\|null`	The mailer that should be used to send this message. If no mailer is given it will first check if `$mailer` is set and if not, the “mailer” application component will be used instead.

Returns

bool: Whether this message is sent successfully.