Skip to content
On this page

LUYA Mail Component

LUYA comes with a luya\components\Mail component that uses PHPMailer. You can access the mail component with Yii::$app->mail and start sending mails. To configure the component, override the class properties in your config as follows:

'components' => [
    'mail' => [
        'host' => '',
        'username' => '',
        'password' => 'YourSmtpPassword',
        'from' => '',
        'fromName' => 'LUYA Admin',
        'altBody' => 'Your HTML ALT BODY'

Often there are different configuration needed which are depending on your hosting provider. Please have a closer look to luya\components\Mail to understand how and what can be configured to match the requirements of your email hosting provider.

In order to test your configurations you can run the console command health/mailer. The command will try to connect to your mail server trough your provided credentials. By default the mailer component requires a SMTP Server and is not using PHPs mail function.

./vendor/bin/luya health/mailer

Compose new email

To quickly send an email in one line you can use the object chain mode like the example below:

$mail = Yii::$app->mail->compose('Mail Subject', 'My HTML email content goes here.')->address('')->send();

You can also use the method addresses with an array of all email addresses you would like to add as recipients.

Yii::$app->mail->compose('Subject', '<p>Html</p>')->addresses(['', 'Jane Doe' => ''])->send();

In order to add cc or bcc recipients you can use similar functions to \luya\components\Mail::addresses.

bccAddresses(['', 'Jane Doe' => ''])
ccAddresses(['', 'Jane Doe' => ''])

The response value of $mail (actually its the response of the method send()) is a boolean value. If something happens wrong during the send process you can access the error inside the component like following:

if (!$mail) {
    echo "Houston, we have problem: " . PHP_EOL;
    echo Yii::$app->mail->error;
} else {
    echo "Wow, mail has been sent!";

Using the PHPMailer Object

If you want to access the PHPMailer object you should use the Object-Mode which provides access to the mailer() method which is the PHPMailer Object. Here you find a list of PHPMailer propertys you can set like in the example below:

$mail = Yii::$app->mail;
$mail->compose('Mail Subject', 'My HTML email content goes here.');
$mail->address("", "John Doe");
$mail->mailer->From = '';
$mail->mailer->FromName = 'Mailer';
$mail->mailer->addReplyTo('', 'Information');
if (!$mail->send()) {
    echo "Houston, we have problem: " . PHP_EOL;
    echo Yii::$app->mail->error;
} else {
    echo "Wow, mail has been sent!";

Define a Mail Template

In order to define a HTML template for your emails add 'layout' => '@app/views/maillayout.php' to the mail component's configuration above.

Example template:

<!doctype html>
    <meta charset="utf-8">
    <title>My App</title>
<img src="<?= luya\helpers\Url::base(true); ?>/images/logo.png" />
<?= $content; ?>

\luya\helpers\Url::$base can be used to get the absolute server URL.