Initial commit
This commit is contained in:
root
464
application/Espo/Core/Mail/Parsers/MailMimeParser.php
Normal file
464
application/Espo/Core/Mail/Parsers/MailMimeParser.php
Normal file
@@ -0,0 +1,464 @@
|
||||
<?php
|
||||
/************************************************************************
|
||||
* This file is part of EspoCRM.
|
||||
*
|
||||
* EspoCRM – Open Source CRM application.
|
||||
* Copyright (C) 2014-2025 EspoCRM, Inc.
|
||||
* Website: https://www.espocrm.com
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program 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 Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://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 Affero General Public License version 3.
|
||||
*
|
||||
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
||||
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
||||
************************************************************************/
|
||||
|
||||
namespace Espo\Core\Mail\Parsers;
|
||||
|
||||
use Espo\Entities\Email;
|
||||
use Espo\Entities\Attachment;
|
||||
use Espo\ORM\EntityManager;
|
||||
use Espo\Core\Mail\Message;
|
||||
use Espo\Core\Mail\Parser;
|
||||
use Espo\Core\Mail\Message\Part;
|
||||
use Espo\Core\Mail\Message\MailMimeParser\Part as WrapperPart;
|
||||
|
||||
use ZBateson\MailMimeParser\Header\AddressHeader;
|
||||
use ZBateson\MailMimeParser\Header\HeaderConsts;
|
||||
use ZBateson\MailMimeParser\IMessage;
|
||||
use ZBateson\MailMimeParser\MailMimeParser as WrappeeParser;
|
||||
use ZBateson\MailMimeParser\Message\MessagePart;
|
||||
use ZBateson\MailMimeParser\Message\MimePart;
|
||||
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* An adapter for MailMimeParser library.
|
||||
*/
|
||||
class MailMimeParser implements Parser
|
||||
{
|
||||
/** @var array<string, string> */
|
||||
private array $extMimeTypeMap = [
|
||||
'jpg' => 'image/jpg',
|
||||
'jpeg' => 'image/jpeg',
|
||||
'png' => 'image/png',
|
||||
'gif' => 'image/gif',
|
||||
'webp' => 'image/webp',
|
||||
];
|
||||
|
||||
private ?WrappeeParser $parser = null;
|
||||
|
||||
private const FIELD_BODY = 'body';
|
||||
private const FIELD_ATTACHMENTS = 'attachments';
|
||||
|
||||
private const DISPOSITION_INLINE = 'inline';
|
||||
|
||||
public const TYPE_MESSAGE_RFC822 = 'message/rfc822';
|
||||
public const TYPE_OCTET_STREAM = 'application/octet-stream';
|
||||
|
||||
/** @var array<string, IMessage> */
|
||||
private array $messageHash = [];
|
||||
|
||||
public function __construct(private EntityManager $entityManager)
|
||||
{}
|
||||
|
||||
private function getParser(): WrappeeParser
|
||||
{
|
||||
if (!$this->parser) {
|
||||
$this->parser = new WrappeeParser();
|
||||
}
|
||||
|
||||
return $this->parser;
|
||||
}
|
||||
|
||||
private function loadContent(Message $message): void
|
||||
{
|
||||
$raw = $message->getFullRawContent();
|
||||
|
||||
$key = spl_object_hash($message);
|
||||
|
||||
$this->messageHash[$key] = $this->getParser()->parse($raw, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return IMessage
|
||||
*/
|
||||
private function getMessage(Message $message)
|
||||
{
|
||||
$key = spl_object_hash($message);
|
||||
|
||||
if (!array_key_exists($key, $this->messageHash)) {
|
||||
$raw = $message->getRawHeader();
|
||||
|
||||
if (!$raw) {
|
||||
$raw = $message->getFullRawContent();
|
||||
}
|
||||
|
||||
$this->messageHash[$key] = $this->getParser()->parse($raw, false);
|
||||
}
|
||||
|
||||
return $this->messageHash[$key];
|
||||
}
|
||||
|
||||
public function hasHeader(Message $message, string $name): bool
|
||||
{
|
||||
return $this->getMessage($message)->getHeaderValue($name) !== null;
|
||||
}
|
||||
|
||||
public function getHeader(Message $message, string $name): ?string
|
||||
{
|
||||
if (!$this->hasHeader($message, $name)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $this->getMessage($message)->getHeaderValue($name);
|
||||
}
|
||||
|
||||
public function getMessageId(Message $message): ?string
|
||||
{
|
||||
$messageId = $this->getHeader($message, 'Message-ID');
|
||||
|
||||
if (!$messageId) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if ($messageId[0] !== '<') {
|
||||
$messageId = '<' . $messageId . '>';
|
||||
}
|
||||
|
||||
return $messageId;
|
||||
}
|
||||
|
||||
public function getAddressNameMap(Message $message): stdClass
|
||||
{
|
||||
$map = (object) [];
|
||||
|
||||
foreach (['from', 'to', 'cc', 'reply-To'] as $type) {
|
||||
$header = $this->getMessage($message)->getHeader($type);
|
||||
|
||||
if (!$header || !method_exists($header, 'getAddresses')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
/** @var AddressHeader $header */
|
||||
|
||||
$list = $header->getAddresses();
|
||||
|
||||
foreach ($list as $item) {
|
||||
$address = $item->getEmail();
|
||||
$name = $item->getName();
|
||||
|
||||
if ($name && $address) {
|
||||
$map->$address = $name;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $map;
|
||||
}
|
||||
|
||||
public function getAddressData(Message $message, string $type): ?object
|
||||
{
|
||||
$header = $this->getMessage($message)->getHeader($type);
|
||||
|
||||
/** @var ?AddressHeader $header */
|
||||
|
||||
if ($header && method_exists($header, 'getAddresses')) {
|
||||
foreach ($header->getAddresses() as $item) {
|
||||
return (object) [
|
||||
'address' => $item->getEmail(),
|
||||
'name' => $item->getName(),
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getAddressList(Message $message, string $type): array
|
||||
{
|
||||
$addressList = [];
|
||||
|
||||
$header = $this->getMessage($message)->getHeader($type);
|
||||
|
||||
/** @var ?AddressHeader $header */
|
||||
|
||||
if ($header && method_exists($header, 'getAddresses')) {
|
||||
$list = $header->getAddresses();
|
||||
|
||||
foreach ($list as $address) {
|
||||
$addressList[] = $address->getEmail();
|
||||
}
|
||||
}
|
||||
|
||||
return $addressList;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Part[]
|
||||
*/
|
||||
public function getPartList(Message $message): array
|
||||
{
|
||||
$wrappeeList = $this->getMessage($message)->getChildParts();
|
||||
|
||||
$partList = [];
|
||||
|
||||
foreach ($wrappeeList as $wrappee) {
|
||||
$partList[] = new WrapperPart($wrappee);
|
||||
}
|
||||
|
||||
return $partList;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Attachment[]
|
||||
*/
|
||||
public function getInlineAttachmentList(Message $message, Email $email): array
|
||||
{
|
||||
$inlineAttachmentList = [];
|
||||
|
||||
$this->loadContent($message);
|
||||
|
||||
$bodyPlain = '';
|
||||
$bodyHtml = '';
|
||||
|
||||
$htmlPartCount = $this->getMessage($message)->getHtmlPartCount();
|
||||
$textPartCount = $this->getMessage($message)->getTextPartCount();
|
||||
|
||||
if (!$htmlPartCount) {
|
||||
$bodyHtml = $this->getMessage($message)->getHtmlContent();
|
||||
}
|
||||
|
||||
if (!$textPartCount) {
|
||||
$bodyPlain = $this->getMessage($message)->getTextContent();
|
||||
}
|
||||
|
||||
for ($i = 0; $i < $htmlPartCount; $i++) {
|
||||
if ($i) {
|
||||
$bodyHtml .= "<br>";
|
||||
}
|
||||
|
||||
$inlinePart = $this->getMessage($message)->getHtmlPart($i);
|
||||
|
||||
$bodyHtml .= $inlinePart?->getContent() ?? '';
|
||||
}
|
||||
|
||||
for ($i = 0; $i < $textPartCount; $i++) {
|
||||
if ($i) {
|
||||
$bodyPlain .= "\n";
|
||||
}
|
||||
|
||||
$inlinePart = $this->getMessage($message)->getTextPart($i);
|
||||
|
||||
$bodyPlain .= $inlinePart?->getContent() ?? '';
|
||||
}
|
||||
|
||||
if ($bodyHtml) {
|
||||
$email->setIsHtml();
|
||||
$email->setBody($bodyHtml);
|
||||
|
||||
if ($bodyPlain) {
|
||||
$email->setBodyPlain($bodyPlain);
|
||||
}
|
||||
} else {
|
||||
$email->setIsHtml(false);
|
||||
$email->setBody($bodyPlain);
|
||||
$email->setBodyPlain($bodyPlain);
|
||||
}
|
||||
|
||||
if (!$email->getBody() && $email->hasBodyPlain()) {
|
||||
$email->setBody($email->getBodyPlain());
|
||||
}
|
||||
|
||||
$attachmentPartList = $this->getMessage($message)->getAllAttachmentParts();
|
||||
|
||||
$inlineAttachmentMap = [];
|
||||
|
||||
foreach ($attachmentPartList as $i => $attachmentPart) {
|
||||
if (!$attachmentPart instanceof MimePart) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$attachment = $this->entityManager->getRDBRepositoryByClass(Attachment::class)->getNew();
|
||||
|
||||
$filename = $this->extractFileName($attachmentPart, $i);
|
||||
$contentType = $this->detectAttachmentContentType($attachmentPart, $filename);
|
||||
$disposition = $attachmentPart->getHeaderValue(HeaderConsts::CONTENT_DISPOSITION);
|
||||
|
||||
if ($contentType) {
|
||||
$contentType = strtolower($contentType);
|
||||
}
|
||||
|
||||
$attachment->setName($filename);
|
||||
$attachment->setType($contentType);
|
||||
|
||||
$content = '';
|
||||
|
||||
$binaryContentStream = $attachmentPart->getBinaryContentStream();
|
||||
|
||||
if ($binaryContentStream) {
|
||||
$content = $binaryContentStream->getContents();
|
||||
}
|
||||
|
||||
$contentId = $attachmentPart->getHeaderValue('Content-ID');
|
||||
|
||||
if ($contentId) {
|
||||
$contentId = trim($contentId, '<>');
|
||||
}
|
||||
|
||||
if ($disposition === self::DISPOSITION_INLINE) {
|
||||
$attachment->setRole(Attachment::ROLE_INLINE_ATTACHMENT);
|
||||
$attachment->setTargetField(self::FIELD_BODY);
|
||||
} else {
|
||||
$attachment->setRole(Attachment::ROLE_ATTACHMENT);
|
||||
$attachment->setTargetField(self::FIELD_ATTACHMENTS);
|
||||
}
|
||||
|
||||
$attachment->setContents($content);
|
||||
|
||||
$this->entityManager->saveEntity($attachment);
|
||||
|
||||
if ($attachment->getRole() === Attachment::ROLE_ATTACHMENT) {
|
||||
$email->addLinkMultipleId(self::FIELD_ATTACHMENTS, $attachment->getId());
|
||||
|
||||
if ($contentId) {
|
||||
$inlineAttachmentMap[$contentId] = $attachment;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// Inline disposition.
|
||||
|
||||
if ($contentId) {
|
||||
$inlineAttachmentMap[$contentId] = $attachment;
|
||||
|
||||
$inlineAttachmentList[] = $attachment;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// No ID found, fallback to attachment.
|
||||
$attachment
|
||||
->setRole(Attachment::ROLE_ATTACHMENT)
|
||||
->setTargetField(self::FIELD_ATTACHMENTS);
|
||||
|
||||
$this->entityManager->saveEntity($attachment);
|
||||
|
||||
$email->addLinkMultipleId(self::FIELD_ATTACHMENTS, $attachment->getId());
|
||||
}
|
||||
|
||||
$body = $email->getBody();
|
||||
|
||||
if ($body) {
|
||||
foreach ($inlineAttachmentMap as $cid => $attachment) {
|
||||
if (str_contains($body, 'cid:' . $cid)) {
|
||||
$body = str_replace(
|
||||
'cid:' . $cid,
|
||||
'?entryPoint=attachment&id=' . $attachment->getId(),
|
||||
$body
|
||||
);
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// Fallback to attachment.
|
||||
if ($attachment->getRole() === Attachment::ROLE_INLINE_ATTACHMENT) {
|
||||
$attachment
|
||||
->setRole(Attachment::ROLE_ATTACHMENT)
|
||||
->setTargetField(self::FIELD_ATTACHMENTS);
|
||||
|
||||
$this->entityManager->saveEntity($attachment);
|
||||
|
||||
$email->addLinkMultipleId(self::FIELD_ATTACHMENTS, $attachment->getId());
|
||||
}
|
||||
}
|
||||
|
||||
$email->setBody($body);
|
||||
}
|
||||
|
||||
/** @var ?MessagePart $textCalendarPart */
|
||||
$textCalendarPart =
|
||||
$this->getMessage($message)->getAllPartsByMimeType('text/calendar')[0] ??
|
||||
$this->getMessage($message)->getAllPartsByMimeType('application/ics')[0] ??
|
||||
null;
|
||||
|
||||
if ($textCalendarPart && $textCalendarPart->hasContent()) {
|
||||
$email->set('icsContents', $textCalendarPart->getContent());
|
||||
}
|
||||
|
||||
return $inlineAttachmentList;
|
||||
}
|
||||
|
||||
private function detectAttachmentContentType(MimePart $part, ?string $filename): ?string
|
||||
{
|
||||
$contentType = $part->getHeaderValue(HeaderConsts::CONTENT_TYPE);
|
||||
|
||||
if ($contentType && strtolower($contentType) !== self::TYPE_OCTET_STREAM) {
|
||||
return $contentType;
|
||||
}
|
||||
|
||||
if (!$filename) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$ext = $this->getAttachmentFilenameExtension($filename);
|
||||
|
||||
if (!$ext) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $this->extMimeTypeMap[$ext] ?? null;
|
||||
}
|
||||
|
||||
private function getAttachmentFilenameExtension(string $filename): ?string
|
||||
{
|
||||
if (!$filename) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$ext = explode('.', $filename)[1] ?? null;
|
||||
|
||||
if (!$ext) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return strtolower($ext);
|
||||
}
|
||||
|
||||
private function extractFileName(MimePart $attachmentPart, int $i): string
|
||||
{
|
||||
$filename = $attachmentPart->getHeaderParameter(HeaderConsts::CONTENT_DISPOSITION, 'filename');
|
||||
|
||||
if ($filename === null) {
|
||||
$filename = $attachmentPart->getHeaderParameter(HeaderConsts::CONTENT_TYPE, 'name');
|
||||
}
|
||||
|
||||
if ($filename === null && $attachmentPart->getContentType() === self::TYPE_MESSAGE_RFC822) {
|
||||
$filename = 'message-' . ($i + 1) . '.eml';
|
||||
}
|
||||
|
||||
if ($filename === null) {
|
||||
$filename = 'unnamed';
|
||||
}
|
||||
|
||||
return $filename;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user