Mailer config in Craft 3 not getting merged

Question

I have this custom config in config/app.php, but Craft seems to keep using the default Control panel Sendmail config.

It seems this doesn't get merged in the main.php file. (as promised)

 return [
 'components' => [
     'mailer' => function() {

        // Get the stored email settings
        $settings = Craft::$app->systemSettings->getEmailSettings();

        // Override the transport adapter class
        $settings->transportType = craft\mail\transportadapters\Smtp::class;

        // Override the transport adapter settings
        $settings->transportSettings = [
            'host' => 'xx',
            'port' => 'xx',
            'useAuthentication' => true,
            'username' => 'xx',
            'password' => 'xx'
        ];

        return craft\helpers\MailerHelper::createMailer($settings);
     },
 ],

];

Check out https://github.com/craftcms/cms/issues/2554#issuecomment-407713430 — Brad, Sep 07 '18 at 13:36

score 1 · Answer 1 · answered Jul 30 '22 at 20:53

For me what worked is instantiating and returning a Craft object, see below: Also, you might want to consider abstracting away env variables. I am using Craft 4

return [
'id' =&gt; App::env('CRAFT_APP_ID') ?: 'CraftCMS',

'modules' =&gt; [

    'my-module' =&gt; \modules\Module::class,

],

'components' =&gt; [

    'mailer' =&gt; function() {



        $settings = craft\helpers\App::mailSettings();

        $settings-&gt;fromEmail = craft\helpers\App::env('CONTACT_FROM_EMAIL');

        // Override the transport adapter class
        $settings-&gt;transportType = craft\mail\transportadapters\Smtp::class;

        // Override the transport adapter settings
        $settings-&gt;transportSettings = [

            'host' =&gt; craft\helpers\App::env('SMTP_HOST'),

            'port' =&gt; craft\helpers\App::env('SMTP_PORT'),

            'useAuthentication' =&gt; true,

            'username' =&gt; craft\helpers\App::env('SMTP_USERNAME'),

            'password' =&gt; craft\helpers\App::env('SMTP_PASSWORD')

        ];



        // Create a Mailer component config with these settings
        $config = craft\helpers\App::mailerConfig($settings);

        // Instantiate and return it
        return Craft::createObject($config);

    }
]


];

score 1 · Answer 2 · answered Jul 31 '22 at 06:47

This was addressed in this issue and the MailerHelper::createMailer() method was deprecated as of Craft 3.0.18, App::mailerConfig() should be used instead.

Changelog: https://github.com/craftcms/cms/blob/v3/CHANGELOG.md#3018---2018-07-31

Here's a working version for Craft 3.1.0 and above.

<?php
use craft\helpers\App;
use craft\mail\transportadapters\Smtp;
return [
    'components' => [
        'mailer' => function() {
            // Get the stored email settings
            $settings = App::mailSettings();
        // Override the transport adapter class
        $settings-&gt;transportType = Smtp::class;

        // Override the transport adapter settings
        $settings-&gt;transportSettings = [
            'host' =&gt; 'xx',
            'port' =&gt; 'xx',
            'useAuthentication' =&gt; true,
            'username' =&gt; 'xx',
            'password' =&gt; 'xx'
        ];

        $config = App::mailerConfig($settings);
        return Craft::createObject($config);
    }
],

];

Mailer config in Craft 3 not getting merged

2 Answers2