Mail | Programming Tips

CakePHP: Configure Mail

As we know, mail feature is required in almost every application. CakePHP also provide support for mail feature. CakeEmail is a new class to send email. You can configure email settings in app/Config/email.php as per your need.

    class EmailConfig {
        public $smtp = array(
            'host' => 'ssl://smtp.gmail.com',
            'port' => 465,
            'username' => 'your_user@gmail.com',
            'password' => 'your_password',
            'transport' => 'Smtp',
            'timeout' => 30 
        );
    }

class EmailConfig {

public $smtp = array(

'host' => 'ssl://smtp.gmail.com',

'port' => 465,

'username' => 'your_user@gmail.com',

'password' => 'your_password',

'transport' => 'Smtp',

'timeout' => 30

);

}

Before sending mail, please ensure that the extension “extension=php_openssl.so” or “extension=php_openssl.dll” is enable in php.ini. Now it’s… Read More »

Zend Framework 2 : Mail

Step 1 : Create a new module ZF2Mail to manage mails in Zend Framework 2 Step 2 : In /path/to/yourapp/vendor/ZF2Mail/config/module.config.php

return array(
    "EMAIL" => array(
        "SMTP_SENDER_TYPE" => "user",
        "SMTP_NAME" => "localhost",
        "SMTP_HOST" => "localhost",
        "SMTP_PORT" => "25",
        "SMTP_CONNECTION_CLASS" => "plain",
        "SMTP_USERNAME" => "",
        "SMTP_PASSWORD" => "",
        "SMTP_SSL" => "",
        "BODY" => "Custom default message",
        "FROM" => "noreply@example.com",
        "TO" => "yoremail@example.com",
        "MAIL_FROM_NICK_NAME" => "Custom Name",
        "SUBJECT" => "Custom Subject",
        "FROM_NICK_NAME" => "Cutom From",
        "EMAIL_TEMPLATE_PATH" => __DIR__ . "/../view/emails/templates/",
        "USE_SMTP" => FALSE
    )    
);

return array(

"EMAIL" => array(

"SMTP_SENDER_TYPE" => "user",

"SMTP_NAME" => "localhost",

"SMTP_HOST" => "localhost",

"SMTP_PORT" => "25",

"SMTP_CONNECTION_CLASS" => "plain",

"SMTP_USERNAME" => "",

"SMTP_PASSWORD" => "",

"SMTP_SSL" => "",

"BODY" => "Custom default message",

"FROM" => "noreply@example.com",

"TO" => "yoremail@example.com",

"MAIL_FROM_NICK_NAME" => "Custom Name",

"SUBJECT" => "Custom Subject",

"FROM_NICK_NAME" => "Cutom From",

"EMAIL_TEMPLATE_PATH" => __DIR__ . "/../view/emails/templates/",

"USE_SMTP" => FALSE

)

);

Step 3 : In /path/to/yourapp/vendor/ZF2Mail/src/ZF2Mail/Mail.php

<?php
namespace ZF2Mail;

use Zend\Mail\Transport\Smtp as SmtpTransport;
use Zend\Mail\Transport\SmtpOptions;
use Zend\Mime\Part;
use Zend\Mime\Mime;
use Zend\Mail\Message;
use Zend\Mime\Message as MimeMessage;
use Zend\View\Renderer\PhpRenderer;
use Zend\View\Resolver\TemplateMapResolver;
use Zend\View\Model\ViewModel;

class Mail
{

    private $serviceManager = null;

    private $useSMTP = false;

    private $smtpName = '';

    private $smtpHost = '';

    private $smtpPort = '';

    private $smtpConnectionClass = '';

    private $smtpUsername = '';

    private $smtpPassword = '';

    private $smtpSsl = '';

    private $mailBody = '';

    private $mailFrom = '';

    private $mailSubject = '';

    private $mailFromNickName = '';

    private $mailTo = '';

    private $mailSenderType = '';

    private $mailCc = array();

    private $mailBcc = array();

    private $fileNames = array();

    private $filePaths = array();

    private $params = array();

    private $templateFile = '';

    private $templatePath = '';

    public function __construct($serviceManager)
    {
        $this->serviceManager = $serviceManager;
        $emailConfig = $this->_getConfig("EMAIL");
        
        $this->useSMTP = $emailConfig['USE_SMTP'];
        $this->smtpSsl = $emailConfig['SMTP_SSL'];
        $this->smtpName = $emailConfig['SMTP_NAME'];
        $this->smtpHost = $emailConfig['SMTP_HOST'];
        $this->smtpPort = $emailConfig['SMTP_PORT'];
        $this->smtpUsername = $emailConfig['SMTP_USERNAME'];
        $this->smtpPassword = $emailConfig['SMTP_PASSWORD'];
        $this->smtpConnectionClass = $emailConfig['SMTP_CONNECTION_CLASS'];
        
        $this->mailBody = $emailConfig['BODY'];
        $this->mailFrom = $emailConfig['FROM'];
        $this->mailSubject = $emailConfig['SUBJECT'];
        $this->mailFromNickName = $emailConfig['FROM_NICK_NAME'];
        $this->mailTo = $emailConfig['TO'];
        $this->mailSenderType = $emailConfig['SMTP_SENDER_TYPE'];
        $this->templatePath = $emailConfig['EMAIL_TEMPLATE_PATH'];
    }

    public function sendMail($mailOptions = array())
    {
        $this->_setMailOptions($mailOptions);
        
        $text = new Part($this->mailBody);
        $text->type = Mime::TYPE_HTML;
        $mailBodyParts = new MimeMessage();
        $mailBodyParts->addPart($text);
        if (! empty($this->fileNames) && ! empty($this->filePaths)) {
            foreach ($this->filePaths as $key => $filePath) {
                $file = new Part(file_get_contents($filePath));
                $file->encoding = Mime::ENCODING_BASE64;
                $file->type = finfo_file(finfo_open(), $filePath, FILEINFO_MIME_TYPE);
                $file->disposition = Mime::DISPOSITION_ATTACHMENT;
                $file->filename = $this->fileNames[$key];
                $mailBodyParts->addPart($file);
            }
        }
        
        $options = array();
        
        if ($this->useSMTP === false) {
            $options = new SmtpOptions(array(
                "name" => $this->smtpName,
                "host" => $this->smtpHost,
                "port" => $this->smtpPort
            ));
        } else {
            $options = new SmtpOptions(array(
                'name' => $this->smtpName,
                'host' => $this->smtpHost,
                'port' => $this->smtpPort,
                'connection_class' => $this->smtpConnectionClass,
                'connection_config' => array(
                    'ssl' => $this->smtpSsl,
                    'username' => $this->smtpUsername,
                    'password' => $this->smtpPassword
                )
            ));
        }
        
        $mail = new Message();
        $mail->setBody($mailBodyParts);
        $mail->setFrom($this->mailFrom, $this->mailFromNickName);
        $mail->addTo($this->mailTo);
        if (! empty($this->mailCc)) {
            $mail->addCc($this->mailCc);
        }
        if (! empty($this->mailBcc)) {
            $mail->addBcc($this->mailBcc);
        }
        $mail->setSubject($this->mailSubject);
        $transport = new SmtpTransport();
        $transport->setOptions($options);
        $emailLogInfo = array(
            'email_to' => $this->mailTo,
            'email_from' => $this->mailFrom,
            'email_body' => $this->mailBody,
            'email_subject' => $this->mailSubject,
            'sender_type' => $this->mailSenderType
        );
        
        $emailSend = 0;
        try {
            $transport->send($mail);
            $emailSend = 1;
        } catch (\Exception $e) {
            $emailLogInfo['email_error'] = $e->getMessage();
            throw $e;
        }
        return $emailSend;
    }

    private function _setMailOptions($mailOptions)
    {
        if (array_key_exists('useSMTP', $mailOptions)) {
            $this->useSMTP = $mailOptions['useSMTP'];
        }
        if (array_key_exists('mailTo', $mailOptions)) {
            $this->mailTo = $mailOptions['mailTo'];
        }
        if (array_key_exists('mailCc', $mailOptions)) {
            $this->mailCc = $mailOptions['mailCc'];
        }
        if (array_key_exists('mailBcc', $mailOptions)) {
            $this->mailBcc = $mailOptions['mailBcc'];
        }
        if (array_key_exists('mailFrom', $mailOptions)) {
            $this->mailFrom = $mailOptions['mailFrom'];
        }
        if (array_key_exists('mailFromNickName', $mailOptions)) {
            $this->mailFromNickName = $mailOptions['mailFromNickName'];
        }
        if (array_key_exists('mailSubject', $mailOptions)) {
            $this->mailSubject = $mailOptions['mailSubject'];
        }
        if (array_key_exists('mailBody', $mailOptions)) {
            $this->mailBody = $mailOptions['mailBody'];
        }
        if (array_key_exists('sender_type', $mailOptions)) {
            $this->mailSenderType = $mailOptions['sender_type'];
        }
        if (array_key_exists('fileNames', $mailOptions)) {
            $this->fileNames = $mailOptions['fileNames'];
        }
        if (array_key_exists('filePaths', $mailOptions)) {
            $this->filePaths = $mailOptions['filePaths'];
        }
        if (array_key_exists('params', $mailOptions)) {
            $this->params = $mailOptions['params'];
        }
        if (array_key_exists('templateFile', $mailOptions)) {
            $this->templateFile = $mailOptions['templateFile'];
            $this->mailBody = $this->_readTemplate();
        }
    }

    private function _getConfig($key)
    {
        $config = $this->serviceManager->get('config');
        
        if (! empty($key)) {
            return $config[$key];
        }
        return $config;
    }

    private function _readTemplate()
    {
        $config = $this->serviceManager->get('config');
        $templateFile = $this->templatePath . $this->templateFile . ".phtml";
        $view = new PhpRenderer();
        $resolver = new TemplateMapResolver();
        
        $resolver->setMap(array(
            'mailTemplate' => $templateFile
        ));
        $view->setResolver($resolver);
        
        $viewModel = new ViewModel();
        $viewModel->setTemplate('mailTemplate');
        $viewModel->setVariables($this->params);
        $content = $view->render($viewModel);
        return $content;
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

<?php

namespace ZF2Mail;

use Zend\Mail\Transport\Smtp as SmtpTransport;

use Zend\Mail\Transport\SmtpOptions;

use Zend\Mime\Part;

use Zend\Mime\Mime;

use Zend\Mail\Message;

use Zend\Mime\Message as MimeMessage;

use Zend\View\Renderer\PhpRenderer;

use Zend\View\Resolver\TemplateMapResolver;

use Zend\View\Model\ViewModel;

class Mail

{

private $serviceManager = null;

private $useSMTP = false;

private $smtpName = '';

private $smtpHost = '';

private $smtpPort = '';

private $smtpConnectionClass = '';

private $smtpUsername = '';

private $smtpPassword = '';

private $smtpSsl = '';

private $mailBody = '';

private $mailFrom = '';

private $mailSubject = '';

private $mailFromNickName = '';

private $mailTo = '';

private $mailSenderType = '';

private $mailCc = array();

private $mailBcc = array();

private $fileNames = array();

private $filePaths = array();

private $params = array();

private $templateFile = '';

private $templatePath = '';

public function __construct($serviceManager)

{

$this->serviceManager = $serviceManager;

$emailConfig = $this->_getConfig("EMAIL");

$this->useSMTP = $emailConfig['USE_SMTP'];

$this->smtpSsl = $emailConfig['SMTP_SSL'];

$this->smtpName = $emailConfig['SMTP_NAME'];

$this->smtpHost = $emailConfig['SMTP_HOST'];

$this->smtpPort = $emailConfig['SMTP_PORT'];

$this->smtpUsername = $emailConfig['SMTP_USERNAME'];

$this->smtpPassword = $emailConfig['SMTP_PASSWORD'];

$this->smtpConnectionClass = $emailConfig['SMTP_CONNECTION_CLASS'];

$this->mailBody = $emailConfig['BODY'];

$this->mailFrom = $emailConfig['FROM'];

$this->mailSubject = $emailConfig['SUBJECT'];

$this->mailFromNickName = $emailConfig['FROM_NICK_NAME'];

$this->mailTo = $emailConfig['TO'];

$this->mailSenderType = $emailConfig['SMTP_SENDER_TYPE'];

$this->templatePath = $emailConfig['EMAIL_TEMPLATE_PATH'];

}

public function sendMail($mailOptions = array())

{

$this->_setMailOptions($mailOptions);

$text = new Part($this->mailBody);

$text->type = Mime::TYPE_HTML;

$mailBodyParts = new MimeMessage();

$mailBodyParts->addPart($text);

if (! empty($this->fileNames) && ! empty($this->filePaths)) {

foreach ($this->filePaths as $key => $filePath) {

$file = new Part(file_get_contents($filePath));

$file->encoding = Mime::ENCODING_BASE64;

$file->type = finfo_file(finfo_open(), $filePath, FILEINFO_MIME_TYPE);

$file->disposition = Mime::DISPOSITION_ATTACHMENT;

$file->filename = $this->fileNames[$key];

$mailBodyParts->addPart($file);

}

$options = array();

if ($this->useSMTP === false) {

$options = new SmtpOptions(array(

"name" => $this->smtpName,

"host" => $this->smtpHost,

"port" => $this->smtpPort

));

} else {

$options = new SmtpOptions(array(

'name' => $this->smtpName,

'host' => $this->smtpHost,

'port' => $this->smtpPort,

'connection_class' => $this->smtpConnectionClass,

'connection_config' => array(

'ssl' => $this->smtpSsl,

'username' => $this->smtpUsername,

'password' => $this->smtpPassword

)

));

}

$mail = new Message();

$mail->setBody($mailBodyParts);

$mail->setFrom($this->mailFrom, $this->mailFromNickName);

$mail->addTo($this->mailTo);

if (! empty($this->mailCc)) {

$mail->addCc($this->mailCc);

}

if (! empty($this->mailBcc)) {

$mail->addBcc($this->mailBcc);

}

$mail->setSubject($this->mailSubject);

$transport = new SmtpTransport();

$transport->setOptions($options);

$emailLogInfo = array(

'email_to' => $this->mailTo,

'email_from' => $this->mailFrom,

'email_body' => $this->mailBody,

'email_subject' => $this->mailSubject,

'sender_type' => $this->mailSenderType

);

$emailSend = 0;

try {

$transport->send($mail);

$emailSend = 1;

} catch (\Exception $e) {

$emailLogInfo['email_error'] = $e->getMessage();

throw $e;

}

return $emailSend;

}

private function _setMailOptions($mailOptions)

{

if (array_key_exists('useSMTP', $mailOptions)) {

$this->useSMTP = $mailOptions['useSMTP'];

}

if (array_key_exists('mailTo', $mailOptions)) {

$this->mailTo = $mailOptions['mailTo'];

}

if (array_key_exists('mailCc', $mailOptions)) {

$this->mailCc = $mailOptions['mailCc'];

}

if (array_key_exists('mailBcc', $mailOptions)) {

$this->mailBcc = $mailOptions['mailBcc'];

}

if (array_key_exists('mailFrom', $mailOptions)) {

$this->mailFrom = $mailOptions['mailFrom'];

}

if (array_key_exists('mailFromNickName', $mailOptions)) {

$this->mailFromNickName = $mailOptions['mailFromNickName'];

}

if (array_key_exists('mailSubject', $mailOptions)) {

$this->mailSubject = $mailOptions['mailSubject'];

}

if (array_key_exists('mailBody', $mailOptions)) {

$this->mailBody = $mailOptions['mailBody'];

}

if (array_key_exists('sender_type', $mailOptions)) {

$this->mailSenderType = $mailOptions['sender_type'];

}

if (array_key_exists('fileNames', $mailOptions)) {

$this->fileNames = $mailOptions['fileNames'];

}

if (array_key_exists('filePaths', $mailOptions)) {

$this->filePaths = $mailOptions['filePaths'];

}

if (array_key_exists('params', $mailOptions)) {

$this->params = $mailOptions['params'];

}

if (array_key_exists('templateFile', $mailOptions)) {

$this->templateFile = $mailOptions['templateFile'];

$this->mailBody = $this->_readTemplate();

}

private function _getConfig($key)

{

$config = $this->serviceManager->get('config');

if (! empty($key)) {

return $config[$key];

}

return $config;

}

private function _readTemplate()

{

$config = $this->serviceManager->get('config');

$templateFile = $this->templatePath . $this->templateFile . ".phtml";

$view = new PhpRenderer();

$resolver = new TemplateMapResolver();

$resolver->setMap(array(

'mailTemplate' => $templateFile

));

$view->setResolver($resolver);

$viewModel = new ViewModel();

$viewModel->setTemplate('mailTemplate');

$viewModel->setVariables($this->params);

$content = $view->render($viewModel);

return $content;

}

Step 4 : In /path/to/yourapp/vendor/ZF2Mail/Module.php

<?php 

namespace ZF2Mail;

use Zend\Mvc\MvcEvent;

class Module{
    
    public function onBootstrap(MvcEvent $e)
    {
        $eventManager   = $e->getApplication()->getEventManager();
        $serviceManager = $e->getApplication()->getServiceManager();
    }
    
    public function getConfig()
    {
        return include __DIR__ . '/config/module.config.php';
    }
    
    public function getAutoloaderConfig()
    {
        return array(
            'Zend\Loader\StandardAutoloader' => array(
                'namespaces' => array(
                    __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__
                )
            )
        );
    }
    
    public function getServiceConfig()
    {
        return array(
            'factories' => array(
                'ZF2Mail' => function ($serviceManager) {
                   return new Mail($serviceManager);
                }
            ),
        );
    }
}

<?php

namespace ZF2Mail;

use Zend\Mvc\MvcEvent;

class Module{

public function onBootstrap(MvcEvent $e)

{

$eventManager = $e->getApplication()->getEventManager();

$serviceManager = $e->getApplication()->getServiceManager();

}

public function getConfig()

{

return include __DIR__ . '/config/module.config.php';

}

public function getAutoloaderConfig()

{

return array(

'Zend\Loader\StandardAutoloader' => array(

'namespaces' => array(

__NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__

)

);

}

public function getServiceConfig()

{

return array(

'factories' => array(

'ZF2Mail' => function ($serviceManager) {

return new Mail($serviceManager);

}

);

}

Step 5 : In /path/to/yourapp/vendor/ZF2Mail/view/emails/templates/

Create email templates like custom-message.phtml in example module and use as per your requirement

1	Create email templates like custom-message.phtml in example module and use as per your requirement

Click here to download the module : Download