EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Account\PersonalAccount;
use Espo\Core\Exceptions\Error;
use Espo\Core\Field\Date;
use Espo\Core\Field\DateTime;
use Espo\Core\Field\Link;
use Espo\Core\Field\LinkMultiple;
use Espo\Core\Field\LinkMultipleItem;
use Espo\Core\Mail\Exceptions\NoSmtp;
use Espo\Core\Mail\Account\ImapParams;
use Espo\Core\Mail\Smtp\HandlerProcessor;
use Espo\Core\Mail\SmtpParams;
use Espo\Core\ORM\Repository\Option\SaveOption;
use Espo\Core\ORM\Type\FieldType;
use Espo\Core\Utils\Config;
use Espo\Core\Utils\Crypt;
use Espo\Entities\EmailAccount;
use Espo\Entities\InboundEmail;
use Espo\Entities\User;
use Espo\Entities\Email;
use Espo\Core\Mail\Account\Account as AccountInterface;
use Espo\Core\Mail\Account\FetchData;
use Espo\ORM\EntityManager;
use Espo\ORM\Mapper\Util;
use Espo\ORM\Name\Attribute;
use Espo\ORM\Query\UpdateBuilder;
use RuntimeException;
class Account implements AccountInterface
{
private const PORTION_LIMIT = 10;
private User $user;
private Crypt $crypt;
/**
* @throws Error
*/
public function __construct(
private EmailAccount $entity,
private EntityManager $entityManager,
private Config $config,
private HandlerProcessor $handlerProcessor,
Crypt $crypt
) {
if (!$this->entity->getAssignedUser()) {
throw new Error("No assigned user.");
}
$userId = $this->entity->getAssignedUser()->getId();
$user = $this->entityManager->getRDBRepositoryByClass(User::class)->getById($userId);
if (!$user) {
throw new Error("Assigned user not found.");
}
$this->user = $user;
$this->crypt = $crypt;
}
public function updateFetchData(FetchData $fetchData): void
{
$query = UpdateBuilder::create()
->in(EmailAccount::ENTITY_TYPE)
->where([
InboundEmail::FIELD_FETCH_VALIDITY_NUMBER => $fetchData->getValidityNumber(),
Attribute::ID => $this->entity->getId(),
Attribute::DELETED => false,
])
->set([
InboundEmail::FIELD_FETCH_DATA => Util::prepareValue(FieldType::JSON_OBJECT, $fetchData->getRaw()),
])
->build();
$sth = $this->entityManager->getQueryExecutor()->execute($query);
if ($sth->rowCount() !== 0) {
$this->entity->setFetchData($fetchData);
$this->entity->setAsFetched();
}
}
public function updateConnectedAt(): void
{
$this->entity->set('connectedAt', DateTime::createNow()->toString());
$this->entityManager->saveEntity($this->entity, [SaveOption::SILENT => true]);
}
public function relateEmail(Email $email): void
{
$this->entityManager
->getRDBRepository(EmailAccount::ENTITY_TYPE)
->getRelation($this->entity, 'emails')
->relate($email);
}
public function getEntity(): EmailAccount
{
return $this->entity;
}
public function getPortionLimit(): int
{
return $this->config->get('personalEmailMaxPortionSize', self::PORTION_LIMIT);
}
public function isAvailableForFetching(): bool
{
return $this->entity->isAvailableForFetching();
}
public function getEmailAddress(): ?string
{
return $this->entity->getEmailAddress();
}
public function getUsers(): LinkMultiple
{
$linkMultiple = LinkMultiple::create();
$userLink = $this->getUser();
return $linkMultiple->withAdded(
LinkMultipleItem
::create($userLink->getId())
->withName($userLink->getName() ?? '')
);
}
/**
* A user to assign emails to. Not need for personal accounts.
*/
public function getAssignedUser(): ?Link
{
return null;
}
/**
* @throws Error
*/
public function getUser(): Link
{
$userLink = $this->entity->getAssignedUser();
if (!$userLink) {
throw new Error("No assigned user.");
}
return $userLink;
}
public function getTeams(): LinkMultiple
{
$linkMultiple = LinkMultiple::create();
$team = $this->user->getDefaultTeam();
if (!$team) {
return $linkMultiple;
}
return $linkMultiple->withAdded(
LinkMultipleItem
::create($team->getId())
->withName($team->getName() ?? '')
);
}
public function keepFetchedEmailsUnread(): bool
{
return $this->entity->keepFetchedEmailsUnread();
}
public function getFetchData(): FetchData
{
return FetchData::fromRaw(
$this->entity->getFetchData(),
$this->entity->getFetchValidityNumber(),
);
}
public function getFetchSince(): ?Date
{
return $this->entity->getFetchSince();
}
public function getEmailFolder(): ?Link
{
return $this->entity->getEmailFolder();
}
public function getMappedEmailFolder(string $folder): ?Link
{
return $this->entity->getMappedEmailFolder($folder);
}
/**
* @return string[]
*/
public function getMonitoredFolderList(): array
{
return $this->entity->getMonitoredFolderList();
}
public function getId(): ?string
{
return $this->entity->getId();
}
public function getEntityType(): string
{
return $this->entity->getEntityType();
}
/**
* @return ?class-string<object>
*/
public function getImapHandlerClassName(): ?string
{
return $this->entity->getImapHandlerClassName();
}
public function getSentFolder(): ?string
{
return $this->entity->getSentFolder();
}
public function getGroupEmailFolder(): ?Link
{
return null;
}
public function isAvailableForSending(): bool
{
return $this->entity->isAvailableForSending();
}
/**
* @throws NoSmtp
*/
public function getSmtpParams(): ?SmtpParams
{
$host = $this->entity->getSmtpHost();
if (!$host) {
return null;
}
$port = $this->entity->getSmtpPort();
if ($port === null) {
throw new NoSmtp("Empty port.");
}
$smtpParams = SmtpParams::create($host, $port)
->withSecurity($this->entity->getSmtpSecurity())
->withAuth($this->entity->getSmtpAuth());
if ($this->entity->getSmtpAuth()) {
$password = $this->entity->getSmtpPassword();
if ($password !== null) {
$password = $this->crypt->decrypt($password);
}
$smtpParams = $smtpParams
->withUsername($this->entity->getSmtpUsername())
->withPassword($password)
->withAuthMechanism($this->entity->getSmtpAuthMechanism());
}
$handlerClassName = $this->entity->getSmtpHandlerClassName();
if (!$handlerClassName) {
return $smtpParams;
}
return $this->handlerProcessor->handle($handlerClassName, $smtpParams, $this->getId());
}
public function storeSentEmails(): bool
{
return $this->entity->storeSentEmails();
}
public function getImapParams(): ?ImapParams
{
$host = $this->entity->getHost();
$port = $this->entity->getPort();
$username = $this->entity->getUsername();
$password = $this->entity->getPassword();
$security = $this->entity->getSecurity();
if (!$host) {
return null;
}
if ($port === null) {
throw new RuntimeException("No port.");
}
if ($username === null) {
throw new RuntimeException("No username.");
}
if ($password !== null) {
$password = $this->crypt->decrypt($password);
}
return new ImapParams(
$host,
$port,
$username,
$password,
$security
);
}
public function getConnectedAt(): ?DateTime
{
/** @var DateTime */
return $this->entity->getValueObject('connectedAt');
}
}