Initial commit

application/Espo/Tools/EmailAddress/Api/GetSearch.php

@@ -0,0 +1,98 @@
+<?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\Tools\EmailAddress\Api;
+
+use Espo\Core\Acl;
+use Espo\Core\Api\Action;
+use Espo\Core\Api\Request;
+use Espo\Core\Api\Response;
+use Espo\Core\Api\ResponseComposer;
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Utils\Config;
+use Espo\Entities\Email;
+use Espo\Tools\Email\AddressService;
+
+/**
+ * Searches email addresses.
+ * @noinspection PhpUnused
+ */
+class GetSearch implements Action
+{
+    private const ADDRESS_MAX_SIZE = 50;
+
+    public function __construct(
+        private AddressService $service,
+        private Acl $acl,
+        private Config\ApplicationConfig $applicationConfig,
+    ) {}
+
+    public function process(Request $request): Response
+    {
+        if (!$this->acl->checkScope(Email::ENTITY_TYPE)) {
+            throw new Forbidden();
+        }
+
+        $entityType = $request->getQueryParam('entityType');
+        $q = $request->getQueryParam('q');
+        $onlyActual = $request->getQueryParam('onlyActual') === 'true';
+        $maxSize = intval($request->getQueryParam('maxSize'));
+
+        if (!$entityType && !$this->acl->checkScope(Email::ENTITY_TYPE, Acl\Table::ACTION_CREATE)) {
+            throw new Forbidden("No 'create' access for Email.");
+        }
+
+        if ($entityType && !$this->acl->checkScope($entityType, Acl\Table::ACTION_READ)) {
+            throw new Forbidden("No 'read' access for entity type.");
+        }
+
+        if (is_string($q)) {
+            $q = trim($q);
+        }
+
+        if (!$q) {
+            throw new BadRequest("No `q` parameter.");
+        }
+
+        if (!$maxSize || $maxSize > self::ADDRESS_MAX_SIZE) {
+            $maxSize = $this->applicationConfig->getRecordsPerPage();
+        }
+
+        if ($entityType) {
+            $result = $this->service->searchInEntityType($entityType, $q, $maxSize);
+
+            return ResponseComposer::json($result);
+        }
+
+        $result = $this->service->searchInAddressBook($q, $maxSize, $onlyActual);
+
+        return ResponseComposer::json($result);
+    }
+}