Taras Machyshyn
722 lines
20 KiB
PHP
722 lines
20 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
|
|
* Website: https://www.espocrm.com
|
|
*
|
|
* EspoCRM is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* EspoCRM is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
|
************************************************************************/
|
|
|
|
namespace Espo\Core\Mail;
|
|
|
|
use Laminas\{
|
|
Mime\Message as MimeMessage,
|
|
Mime\Part as MimePart,
|
|
Mime\Mime as Mime,
|
|
Mail\Header\Sender as SenderHeader,
|
|
Mail\Header\MessageId as MessageIdHeader,
|
|
Mail\Header\ContentType as ContentTypeHeader,
|
|
Mail\Message,
|
|
Mail\Transport\SmtpOptions,
|
|
Mail\Transport\Envelope,
|
|
Mail\Protocol\Exception\RuntimeException as ProtocolRuntimeException,
|
|
};
|
|
|
|
use Espo\Entities\{
|
|
Email,
|
|
InboundEmail,
|
|
};
|
|
|
|
use Espo\Services\InboundEmail as InboundEmailService;
|
|
|
|
use Espo\Core\{
|
|
Exceptions\Error,
|
|
Utils\Config,
|
|
ORM\EntityManager,
|
|
ServiceFactory,
|
|
};
|
|
|
|
use Traversable;
|
|
use Exception;
|
|
|
|
/**
|
|
* Sends emails. Builds parameters for sending. Should not be used directly.
|
|
*/
|
|
class Sender
|
|
{
|
|
protected $config;
|
|
|
|
protected $entityManager;
|
|
|
|
protected $serviceFactory;
|
|
|
|
protected $transportFactory;
|
|
|
|
protected $transport;
|
|
|
|
protected $isGlobal = false;
|
|
|
|
protected $params = [];
|
|
|
|
protected $overrideParams = [];
|
|
|
|
private $systemInboundEmail = null;
|
|
|
|
private $inboundEmailService = null;
|
|
|
|
private $systemInboundEmailIsCached = false;
|
|
|
|
private $envelope = null;
|
|
|
|
private $message = null;
|
|
|
|
private $attachmentList = null;
|
|
|
|
public function __construct(
|
|
Config $config,
|
|
EntityManager $entityManager,
|
|
ServiceFactory $serviceFactory,
|
|
SmtpTransportFactory $transportFactory,
|
|
?InboundEmailService $inboundEmailService = null,
|
|
?InboundEmail $systemInboundEmail = null
|
|
) {
|
|
$this->config = $config;
|
|
$this->entityManager = $entityManager;
|
|
$this->serviceFactory = $serviceFactory;
|
|
$this->transportFactory = $transportFactory;
|
|
|
|
$this->inboundEmailService = $inboundEmailService;
|
|
$this->systemInboundEmail = $systemInboundEmail;
|
|
|
|
if ($inboundEmailService) {
|
|
$this->systemInboundEmailIsCached = true;
|
|
}
|
|
|
|
$this->useGlobal();
|
|
}
|
|
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
public function resetParams() : self
|
|
{
|
|
$this->params = [];
|
|
$this->envelope = null;
|
|
$this->message = null;
|
|
$this->attachmentList = null;
|
|
$this->overrideParams = [];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* With parameters.
|
|
*
|
|
* Available parameters: fromAddress, fromName, replyToAddress, replyToName.
|
|
*/
|
|
public function withParams(array $params) : self
|
|
{
|
|
$paramList = [
|
|
'fromAddress',
|
|
'fromName',
|
|
'replyToAddress',
|
|
'replyToName',
|
|
];
|
|
|
|
foreach ($params as $key => $value) {
|
|
if (! in_array($key, $paramList)) {
|
|
unset($params[$key]);
|
|
}
|
|
}
|
|
|
|
$this->overrideParams = array_merge($this->overrideParams, $params);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* With specific SMTP parameters.
|
|
*/
|
|
public function withSmtpParams(array $params) : self
|
|
{
|
|
return $this->useSmtp($params);
|
|
}
|
|
|
|
/**
|
|
* With specific attachments.
|
|
*/
|
|
public function withAttachments(iterable $attachmentList) : self
|
|
{
|
|
$this->attachmentList = $attachmentList;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* With envelope options.
|
|
*/
|
|
public function withEnvelopeOptions(array $options) : self
|
|
{
|
|
return $this->setEnvelopeOptions($options);
|
|
}
|
|
|
|
/**
|
|
* Set a message instance.
|
|
*/
|
|
public function withMessage(Message $message) : self
|
|
{
|
|
$this->message = $message;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set params.
|
|
*
|
|
* @deprecated
|
|
*/
|
|
public function setParams(array $params = []) : self
|
|
{
|
|
$this->params = array_merge($this->params, $params);
|
|
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* Use specific SMTP parameters.
|
|
*
|
|
* @deprecated
|
|
*/
|
|
public function useSmtp(array $params = []) : self
|
|
{
|
|
$this->isGlobal = false;
|
|
$this->applySmtp($params);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Use the system SMTP parameters.
|
|
*
|
|
* @deprecated
|
|
*/
|
|
public function useGlobal() : self
|
|
{
|
|
$this->params = [];
|
|
$this->isGlobal = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
protected function applySmtp(array $params = [])
|
|
{
|
|
$this->params = $params;
|
|
|
|
$this->transport = $this->transportFactory->create();
|
|
|
|
$config = $this->config;
|
|
|
|
$localHostName = $config->get('smtpLocalHostName', gethostname());
|
|
|
|
$options = [
|
|
'name' => $localHostName,
|
|
'host' => $params['server'],
|
|
'port' => $params['port'],
|
|
'connectionConfig' => [],
|
|
];
|
|
|
|
$connectionOptions = $params['connectionOptions'] ?? [];
|
|
foreach ($connectionOptions as $key => $value) {
|
|
$options['connectionConfig'][$key] = $value;
|
|
}
|
|
|
|
if ($params['auth'] ?? false) {
|
|
$authMechanism = $params['authMechanism'] ?? $params['smtpAuthMechanism'] ?? null;
|
|
|
|
if ($authMechanism) {
|
|
$authMechanism = preg_replace("([\.]{2,})", '', $authMechanism);
|
|
|
|
if (in_array($authMechanism, ['login', 'crammd5', 'plain'])) {
|
|
$options['connectionClass'] = $authMechanism;
|
|
} else {
|
|
$options['connectionClass'] = 'login';
|
|
}
|
|
} else {
|
|
$options['connectionClass'] = 'login';
|
|
}
|
|
|
|
$options['connectionConfig']['username'] = $params['username'];
|
|
$options['connectionConfig']['password'] = $params['password'];
|
|
}
|
|
|
|
$authClassName = $params['authClassName'] ?? $params['smtpAuthClassName'] ?? null;
|
|
|
|
if ($authClassName) {
|
|
$options['connectionClass'] = $authClassName;
|
|
}
|
|
|
|
if ($params['security'] ?? null) {
|
|
$options['connectionConfig']['ssl'] = strtolower($params['security']);
|
|
}
|
|
|
|
if (array_key_exists('fromName', $params)) {
|
|
$this->params['fromName'] = $params['fromName'];
|
|
}
|
|
|
|
if (array_key_exists('fromAddress', $params)) {
|
|
$this->params['fromAddress'] = $params['fromAddress'];
|
|
}
|
|
|
|
$this->transport->setOptions(
|
|
new SmtpOptions($options)
|
|
);
|
|
|
|
if ($this->envelope) {
|
|
$this->transport->setEnvelope($this->envelope);
|
|
}
|
|
}
|
|
|
|
protected function applyGlobal()
|
|
{
|
|
$config = $this->config;
|
|
|
|
if (!$config->get('smtpServer') && $config->get('outboundEmailFromAddress')) {
|
|
$inboundEmail = $this->getSystemInboundEmail();
|
|
|
|
if ($inboundEmail) {
|
|
$service = $this->getInboundEmailService();
|
|
|
|
if ($service) {
|
|
$params = $service->getSmtpParamsFromAccount($inboundEmail);
|
|
$this->applySmtp($params);
|
|
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->applySmtp([
|
|
'server' => $config->get('smtpServer'),
|
|
'port' => $config->get('smtpPort'),
|
|
'auth' => $config->get('smtpAuth'),
|
|
'authMechanism' => $config->get('smtpAuthMechanism', 'login'),
|
|
'username' => $config->get('smtpUsername'),
|
|
'password' => $config->get('smtpPassword'),
|
|
'security' => $config->get('smtpSecurity'),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
public function hasSystemSmtp()
|
|
{
|
|
if ($this->config->get('smtpServer')) {
|
|
return true;
|
|
}
|
|
|
|
if ($this->getSystemInboundEmail()) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
protected function getSystemInboundEmail()
|
|
{
|
|
$address = $this->config->get('outboundEmailFromAddress');
|
|
|
|
if (!$this->systemInboundEmailIsCached && $address) {
|
|
$this->systemInboundEmail = $this->entityManager->getRepository('InboundEmail')->where([
|
|
'status' => 'Active',
|
|
'useSmtp' => true,
|
|
'emailAddress' => $address,
|
|
])->findOne();
|
|
}
|
|
|
|
$this->systemInboundEmailIsCached = true;
|
|
|
|
return $this->systemInboundEmail;
|
|
}
|
|
|
|
protected function getInboundEmailService()
|
|
{
|
|
if (!$this->serviceFactory) {
|
|
return null;
|
|
}
|
|
|
|
if (!$this->inboundEmailService) {
|
|
$this->inboundEmailService = $this->serviceFactory->create('InboundEmail');
|
|
}
|
|
|
|
return $this->inboundEmailService;
|
|
}
|
|
|
|
/**
|
|
* Send an email.
|
|
*
|
|
* @param $params @deprecated
|
|
* @param $message @deprecated
|
|
* @param $attachmentList @deprecated
|
|
*/
|
|
public function send(Email $email, ?array $params = [], ?Message $message = null, iterable $attachmentList = [])
|
|
{
|
|
if ($this->isGlobal) {
|
|
$this->applyGlobal();
|
|
}
|
|
|
|
$message = $this->message ?? $message ?? new Message();
|
|
|
|
$params = $params ?? [];
|
|
|
|
$config = $this->config;
|
|
|
|
$params = array_merge(
|
|
$this->params,
|
|
$params,
|
|
$this->overrideParams
|
|
);
|
|
|
|
$fromName = $params['fromName'] ?? $config->get('outboundEmailFromName');
|
|
|
|
if ($email->get('from')) {
|
|
$fromAddress = trim(
|
|
$email->get('from')
|
|
);
|
|
} else {
|
|
if (empty($params['fromAddress']) && !$config->get('outboundEmailFromAddress')) {
|
|
throw new Error('outboundEmailFromAddress is not specified in config.');
|
|
}
|
|
|
|
$fromAddress = $params['fromAddress'] ?? $config->get('outboundEmailFromAddress');
|
|
|
|
$email->set('from', $fromAddress);
|
|
}
|
|
|
|
$message->addFrom($fromAddress, $fromName);
|
|
|
|
$fromString = '<' . $fromAddress . '>';
|
|
|
|
if ($fromName) {
|
|
$fromString = $fromName . ' ' . $fromString;
|
|
}
|
|
|
|
$email->set('fromString', $fromString);
|
|
|
|
$senderHeader = new SenderHeader();
|
|
|
|
$senderHeader->setAddress($fromAddress);
|
|
|
|
$message->getHeaders()
|
|
->addHeader($senderHeader);
|
|
|
|
if (!empty($params['replyToAddress'])) {
|
|
$message->setReplyTo(
|
|
$params['replyToAddress'],
|
|
$params['replyToName'] ?? null
|
|
);
|
|
}
|
|
|
|
$this->addAddresses($email, $message);
|
|
|
|
$attachmentPartList = [];
|
|
|
|
$attachmentCollection = null;
|
|
|
|
if (!$email->isNew()) {
|
|
$attachmentCollection = $this->entityManager
|
|
->getRepository('Email')
|
|
->getRelation($email, 'attachments')
|
|
->find();
|
|
}
|
|
|
|
$attachmentList = $this->attachmentList ?? $attachmentList ?? [];
|
|
|
|
foreach ($attachmentList as $attachment) {
|
|
$attachmentCollection[] = $attachment;
|
|
}
|
|
|
|
if (!empty($attachmentCollection)) {
|
|
foreach ($attachmentCollection as $a) {
|
|
if ($a->get('contents')) {
|
|
$contents = $a->get('contents');
|
|
} else {
|
|
$fileName = $this->entityManager
|
|
->getRepository('Attachment')
|
|
->getFilePath($a);
|
|
|
|
if (!is_file($fileName)) {
|
|
continue;
|
|
}
|
|
|
|
$contents = file_get_contents($fileName);
|
|
}
|
|
|
|
$attachment = new MimePart($contents);
|
|
|
|
$attachment->disposition = Mime::DISPOSITION_ATTACHMENT;
|
|
$attachment->encoding = Mime::ENCODING_BASE64;
|
|
$attachment->filename ='=?utf-8?B?' . base64_encode($a->get('name')) . '?=';
|
|
|
|
if ($a->get('type')) {
|
|
$attachment->type = $a->get('type');
|
|
}
|
|
|
|
$attachmentPartList[] = $attachment;
|
|
}
|
|
}
|
|
|
|
$attachmentInlineList = $email->getInlineAttachments();
|
|
|
|
if (!empty($attachmentInlineList)) {
|
|
foreach ($attachmentInlineList as $a) {
|
|
if ($a->get('contents')) {
|
|
$contents = $a->get('contents');
|
|
} else {
|
|
$fileName = $this->entityManager->getRepository('Attachment')->getFilePath($a);
|
|
|
|
if (!is_file($fileName)) {
|
|
continue;
|
|
}
|
|
|
|
$contents = file_get_contents($fileName);
|
|
}
|
|
|
|
$attachment = new MimePart($contents);
|
|
$attachment->disposition = Mime::DISPOSITION_INLINE;
|
|
$attachment->encoding = Mime::ENCODING_BASE64;
|
|
$attachment->id = $a->id;
|
|
|
|
if ($a->get('type')) {
|
|
$attachment->type = $a->get('type');
|
|
}
|
|
$attachmentPartList[] = $attachment;
|
|
}
|
|
}
|
|
|
|
$message->setSubject($email->get('name'));
|
|
|
|
$body = new MimeMessage();
|
|
|
|
$textPart = new MimePart($email->getBodyPlainForSending());
|
|
$textPart->type = 'text/plain';
|
|
$textPart->encoding = Mime::ENCODING_QUOTEDPRINTABLE;
|
|
$textPart->charset = 'utf-8';
|
|
|
|
if ($email->get('isHtml')) {
|
|
$htmlPart = new MimePart($email->getBodyForSending());
|
|
$htmlPart->encoding = Mime::ENCODING_QUOTEDPRINTABLE;
|
|
$htmlPart->type = 'text/html';
|
|
$htmlPart->charset = 'utf-8';
|
|
}
|
|
|
|
if (!empty($attachmentPartList)) {
|
|
$messageType = 'multipart/related';
|
|
if ($email->get('isHtml')) {
|
|
$content = new MimeMessage();
|
|
$content->addPart($textPart);
|
|
$content->addPart($htmlPart);
|
|
|
|
$messageType = 'multipart/mixed';
|
|
|
|
$contentPart = new MimePart($content->generateMessage());
|
|
$contentPart->type = "multipart/alternative;\n boundary=\"" . $content->getMime()->boundary() . '"';
|
|
|
|
$body->addPart($contentPart);
|
|
} else {
|
|
$body->addPart($textPart);
|
|
}
|
|
|
|
foreach ($attachmentPartList as $attachmentPart) {
|
|
$body->addPart($attachmentPart);
|
|
}
|
|
} else {
|
|
if ($email->get('isHtml')) {
|
|
$body->setParts([$textPart, $htmlPart]);
|
|
$messageType = 'multipart/alternative';
|
|
} else {
|
|
$body = $email->getBodyPlainForSending();
|
|
$messageType = 'text/plain';
|
|
}
|
|
}
|
|
|
|
$message->setBody($body);
|
|
|
|
if ($messageType == 'text/plain') {
|
|
if ($message->getHeaders()->has('content-type')) {
|
|
$message->getHeaders()->removeHeader('content-type');
|
|
}
|
|
|
|
$message->getHeaders()->addHeaderLine('Content-Type', 'text/plain; charset=UTF-8');
|
|
} else {
|
|
if (!$message->getHeaders()->has('content-type')) {
|
|
$contentTypeHeader = new ContentTypeHeader();
|
|
$message->getHeaders()->addHeader($contentTypeHeader);
|
|
}
|
|
|
|
$message->getHeaders()->get('content-type')->setType($messageType);
|
|
}
|
|
|
|
$message->setEncoding('UTF-8');
|
|
|
|
try {
|
|
$messageId = $email->get('messageId');
|
|
|
|
if (empty($messageId) || !is_string($messageId) || strlen($messageId) < 4 || strpos($messageId, 'dummy:') === 0) {
|
|
$messageId = $this->generateMessageId($email);
|
|
$email->set('messageId', '<' . $messageId . '>');
|
|
|
|
if ($email->id) {
|
|
$this->entityManager->saveEntity($email, ['silent' => true]);
|
|
}
|
|
} else {
|
|
$messageId = substr($messageId, 1, strlen($messageId) - 2);
|
|
}
|
|
|
|
$messageIdHeader = new MessageIdHeader();
|
|
|
|
$messageIdHeader->setId($messageId);
|
|
|
|
$message->getHeaders()->addHeader($messageIdHeader);
|
|
|
|
$this->transport->send($message);
|
|
|
|
$email->set('status', 'Sent');
|
|
$email->set('dateSent', date("Y-m-d H:i:s"));
|
|
}
|
|
catch (Exception $e) {
|
|
$this->resetParams();
|
|
$this->useGlobal();
|
|
|
|
$this->handleException($e);
|
|
|
|
return;
|
|
}
|
|
|
|
$this->resetParams();
|
|
$this->useGlobal();
|
|
}
|
|
|
|
protected function handleException(Exception $e)
|
|
{
|
|
if ($e instanceof ProtocolRuntimeException) {
|
|
$message = "Email sending error.";
|
|
|
|
if (
|
|
stripos($e->getMessage(), 'password') !== false
|
|
||
|
|
stripos($e->getMessage(), 'credentials') !== false
|
|
||
|
|
stripos($e->getMessage(), '5.7.8') !== false
|
|
) {
|
|
$message .= ' Invalid credentials.';
|
|
}
|
|
|
|
$GLOBALS['log']->error("Email sending error. " . $e->getMessage());
|
|
|
|
throw new Error($message, 500);
|
|
}
|
|
|
|
throw new Error($e->getMessage(), 500);
|
|
}
|
|
|
|
static public function generateMessageId(Email $email) : string
|
|
{
|
|
$rand = mt_rand(1000, 9999);
|
|
|
|
if ($email->get('parentType') && $email->get('parentId')) {
|
|
$messageId = '' . $email->get('parentType') .'/' . $email->get('parentId') . '/' . time() . '/' . $rand . '@espo';
|
|
} else {
|
|
$messageId = '' . md5($email->get('name')) . '/' . time() . '/' . $rand . '@espo';
|
|
}
|
|
|
|
if ($email->get('isSystem')) {
|
|
$messageId .= '-system';
|
|
}
|
|
|
|
return $messageId;
|
|
}
|
|
|
|
/**
|
|
* @deprecated
|
|
*/
|
|
public function setEnvelopeOptions(array $options) : self
|
|
{
|
|
$this->envelope = new Envelope($options);
|
|
|
|
return $this;
|
|
}
|
|
|
|
protected function addAddresses(Email $email, Message $message)
|
|
{
|
|
$value = $email->get('to');
|
|
|
|
if ($value) {
|
|
$arr = explode(';', $value);
|
|
|
|
foreach ($arr as $address) {
|
|
$message->addTo(
|
|
trim($address)
|
|
);
|
|
}
|
|
}
|
|
|
|
$value = $email->get('cc');
|
|
|
|
if ($value) {
|
|
$arr = explode(';', $value);
|
|
|
|
foreach ($arr as $address) {
|
|
$message->addCC(
|
|
trim($address)
|
|
);
|
|
}
|
|
}
|
|
|
|
$value = $email->get('bcc');
|
|
|
|
if ($value) {
|
|
$arr = explode(';', $value);
|
|
|
|
foreach ($arr as $address) {
|
|
$message->addBCC(
|
|
trim($address)
|
|
);
|
|
}
|
|
}
|
|
|
|
$value = $email->get('replyTo');
|
|
|
|
if ($value) {
|
|
$arr = explode(';', $value);
|
|
|
|
foreach ($arr as $address) {
|
|
$message->addReplyTo(
|
|
trim($address)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|