芝麻web文件管理V1.00
编辑当前文件:/home/pulsehostuk9/public_html/cloud.pulsehost.co.uk/modules/Mail/Module.php
aErrors = [ Enums\ErrorCodes::CannotConnectToMailServer => $this->i18N('ERROR_CONNECT_TO_MAIL_SERVER'), Enums\ErrorCodes::CannotLoginCredentialsIncorrect => $this->i18N('ERROR_CREDENTIALS_INCORRECT'), Enums\ErrorCodes::FolderAlreadyExists => $this->i18N('ERROR_FOLDER_EXISTS'), Enums\ErrorCodes::FolderNameContainsDelimiter => $this->i18N('ERROR_FOLDER_NAME_CONTAINS_DELIMITER'), Enums\ErrorCodes::CannotRenameNonExistenFolder => $this->i18N('ERROR_RENAME_NONEXISTEN_FOLDER'), Enums\ErrorCodes::CannotGetMessage => $this->i18N('ERROR_GET_MESSAGE'), Enums\ErrorCodes::CannotMoveMessage => $this->i18N('ERROR_MOVE_MESSAGE'), Enums\ErrorCodes::CannotSendMessageInvalidRecipients => $this->i18N('ERROR_SEND_MESSAGE_INVALID_RECIPIENTS'), Enums\ErrorCodes::CannotSendMessageToRecipients => $this->i18N('ERROR_SEND_MESSAGE_TO_RECIPIENTS'), Enums\ErrorCodes::CannotSendMessageToExternalRecipients => $this->i18N('ERROR_SEND_MESSAGE_TO_EXTERNAL_RECIPIENTS'), Enums\ErrorCodes::CannotSaveMessageToSentItems => $this->i18N('ERROR_SEND_MESSAGE_NOT_SAVED'), Enums\ErrorCodes::CannotUploadMessage => $this->i18N('ERROR_UPLOAD_MESSAGE'), Enums\ErrorCodes::CannotUploadMessageFileNotEml => $this->i18N('ERROR_UPLOAD_MESSAGE_FILE_NOT_EML'), Enums\ErrorCodes::DomainIsNotAllowedForLoggingIn => $this->i18N('DOMAIN_IS_NOT_ALLOWED_FOR_LOGGING_IN'), Enums\ErrorCodes::TenantQuotaExceeded => $this->i18N('ERROR_TENANT_QUOTA_EXCEEDED'), ]; $this->AddEntries( array( 'message-newtab' => 'EntryMessageNewtab', 'mail-attachment' => 'EntryDownloadAttachment', 'mail-attachments-cookieless' => 'EntryDownloadAttachmentCookieless' ) ); $this->subscribeEvent('Login', array($this, 'onLogin')); $this->subscribeEvent('Core::DeleteUser::before', array($this, 'onBeforeDeleteUser')); $this->subscribeEvent('Core::GetAccounts', array($this, 'onGetAccounts')); $this->subscribeEvent('Autodiscover::GetAutodiscover::after', array($this, 'onAfterGetAutodiscover')); $this->subscribeEvent('Core::DeleteTenant::after', array($this, 'onAfterDeleteTenant')); $this->subscribeEvent('Core::DeleteUser::after', array($this, 'onAfterDeleteUser')); $this->subscribeEvent('Core::GetDigestHash', array($this, 'onGetDigestHash')); $this->subscribeEvent('Core::GetAccountUsedToAuthorize', array($this, 'onGetAccountUsedToAuthorize')); $this->subscribeEvent('System::RunEntry::before', array($this, 'onBeforeRunEntry')); $this->subscribeEvent('System::CastExtendedProp', array($this, 'onCastExtendedProp')); $this->subscribeEvent('ChangePassword::after', array($this, 'onAfterChangePassword')); $this->aDeniedMethodsByWebApi = [ 'BuildMessage', 'checkAccountAccess' ]; \MailSo\Config::$PreferStartTlsIfAutoDetect = !!$this->oModuleSettings->PreferStarttls; } /** * @return Module */ public static function getInstance() { return parent::getInstance(); } /** * @return Module */ public static function Decorator() { return parent::Decorator(); } /** * @return Settings */ public function getModuleSettings() { return $this->oModuleSettings; } /** * * @return \Aurora\Modules\Mail\Managers\Accounts\Manager */ public function getAccountsManager() { if ($this->oAccountsManager === null) { $this->oAccountsManager = new Managers\Accounts\Manager($this); } return $this->oAccountsManager; } public function setAccountsManager($oManager) { $this->oAccountsManager = $oManager; } /** * * @return \Aurora\Modules\Mail\Managers\Servers\Manager */ public function getServersManager() { if ($this->oServersManager === null) { $this->oServersManager = new Managers\Servers\Manager($this); } return $this->oServersManager; } /** * * @return \Aurora\Modules\Mail\Managers\Identities\Manager */ public function getIdentitiesManager() { if ($this->oIdentitiesManager === null) { $this->oIdentitiesManager = new Managers\Identities\Manager($this); } return $this->oIdentitiesManager; } /** * * @return \Aurora\Modules\Mail\Managers\Main\Manager */ public function getMailManager() { if ($this->oMailManager === null) { $this->oMailManager = new Managers\Main\Manager($this); } return $this->oMailManager; } public function setMailManager($oManager) { $this->oMailManager = $oManager; } /** * * @return \Aurora\Modules\Mail\Managers\Sieve\Manager */ public function getSieveManager() { if ($this->oSieveManager === null) { $this->oSieveManager = new Managers\Sieve\Manager($this); } return $this->oSieveManager; } /** * * @return \Aurora\System\Managers\Filecache */ public function getFilecacheManager() { if ($this->oFilecacheManager === null) { $this->oFilecacheManager = new \Aurora\System\Managers\Filecache(); } return $this->oFilecacheManager; } /** * Checks if actions are allowed for authenticated user. * @param \Aurora\Modules\Mail\Models\MailAccount $oAccount Account should be checked if it belongs to authenticated user. If it's null check is not needed. * @throws \Aurora\System\Exceptions\ApiException */ public static function checkAccountAccess($oAccount) { if (\Aurora\System\Api::accessCheckIsSkipped()) { // if access check should be skipped don't check at all return; } $bAccessDenied = true; $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); $iUserRole = $oAuthenticatedUser instanceof User ? $oAuthenticatedUser->Role : \Aurora\System\Enums\UserRole::Anonymous; switch ($iUserRole) { case (\Aurora\System\Enums\UserRole::SuperAdmin): // everything is allowed for SuperAdmin $bAccessDenied = false; break; case (\Aurora\System\Enums\UserRole::TenantAdmin): // everything is allowed for TenantAdmin $oUser = null; if ($oAccount !== null) { $oUser = \Aurora\Modules\Core\Module::getInstance()->GetUser($oAccount->IdUser); } if ($oUser instanceof User) { if ($oAuthenticatedUser->IdTenant === $oUser->IdTenant) { $bAccessDenied = false; } } break; case (\Aurora\System\Enums\UserRole::NormalUser): // Account shoud be checked if ($oAccount !== null) { if ($oAccount instanceof Models\MailAccount && $oAccount->IdUser === $oAuthenticatedUser->Id) { $bAccessDenied = false; } } break; case (\Aurora\System\Enums\UserRole::Customer): case (\Aurora\System\Enums\UserRole::Anonymous): // everything is forbidden for Customer and Anonymous users break; } if ($bAccessDenied) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } } /***** public functions might be called with web API *****/ /** * @apiDefine Mail Mail Module * Main Mail module. It provides PHP and Web APIs for managing mail accounts, folders and messages. */ /** * @api {post} ?/Api/ GetSettings * @apiName GetSettings * @apiGroup Mail * @apiDescription Obtains list of module settings for authenticated user. * * @apiHeader {string} [Authorization] "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetSettings} Method Method name * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetSettings' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result List of module settings in case of success, otherwise **false**. * * @apiSuccess {array} Result.Result.Accounts="[]" List of accounts. * @apiSuccess {boolean} Result.Result.AllowAddAccounts=false Indicates if adding of new account is allowed. * @apiSuccess {boolean} Result.Result.AllowAutosaveInDrafts=false Indicates if autosave in Drafts folder on compose is allowed. * @apiSuccess {boolean} Result.Result.AllowDefaultAccountForUser=false Indicates if default account is allowed. * @apiSuccess {boolean} Result.Result.AllowIdentities=false Indicates if identities are allowed. * @apiSuccess {boolean} Result.Result.AllowInsertImage=false Indicates if insert of images in composed message body is allowed. * @apiSuccess {int} Result.Result.AutoSaveIntervalSeconds=60 Interval for autosave of message on compose in seconds. * @apiSuccess {int} Result.Result.ImageUploadSizeLimit=0 Max size of upload image in message text in bytes. * * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetSettings', * Result: { Accounts: [], AllowAddAccounts: true, AllowAutosaveInDrafts: true, * AllowDefaultAccountForUser: true, AllowIdentities: true, AllowInsertImage: true, * AutoSaveIntervalSeconds: 60, ImageUploadSizeLimit: 0 } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetSettings', * Result: false, * ErrorCode: 102 * } */ /** * Obtains list of module settings for authenticated user. * @return array */ public function GetSettings() { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::Anonymous); $aSettings = array( 'Accounts' => array(), 'AllowAddAccounts' => $this->oModuleSettings->AllowAddAccounts, 'AllowAutosaveInDrafts' => (bool)$this->oModuleSettings->AllowAutosaveInDrafts, 'AllowChangeMailQuotaOnMailServer' => $this->oModuleSettings->AllowChangeMailQuotaOnMailServer, 'AllowDefaultAccountForUser' => $this->oModuleSettings->AllowDefaultAccountForUser, 'AllowIdentities' => $this->oModuleSettings->AllowIdentities, 'OnlyUserEmailsInIdentities' => $this->oModuleSettings->OnlyUserEmailsInIdentities, 'AllowInsertImage' => $this->oModuleSettings->AllowInsertImage, 'AutoSaveIntervalSeconds' => $this->oModuleSettings->AutoSaveIntervalSeconds, 'AllowTemplateFolders' => $this->oModuleSettings->AllowTemplateFolders, 'AllowInsertTemplateOnCompose' => $this->oModuleSettings->AllowInsertTemplateOnCompose, 'MaxTemplatesCountOnCompose' => $this->oModuleSettings->MaxTemplatesCountOnCompose, 'AllowAlwaysRefreshFolders' => $this->oModuleSettings->AllowAlwaysRefreshFolders, 'AutocreateMailAccountOnNewUserFirstLogin' => $this->oModuleSettings->AutocreateMailAccountOnNewUserFirstLogin, 'IgnoreImapSubscription' => $this->oModuleSettings->IgnoreImapSubscription, 'ImageUploadSizeLimit' => $this->oModuleSettings->ImageUploadSizeLimit, 'AllowUnifiedInbox' => $this->oModuleSettings->AllowUnifiedInbox, 'SmtpAuthType' => (new \Aurora\Modules\Mail\Enums\SmtpAuthType())->getMap(), 'MessagesSortBy' => $this->oModuleSettings->MessagesSortBy, 'AllowScheduledAutoresponder' => $this->oModuleSettings->AllowScheduledAutoresponder, ); $oUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oUser && $oUser->isNormalOrTenant()) { $aAcc = $this->GetAccounts($oUser->Id); $aResponseAcc = []; foreach ($aAcc as $oAccount) { $aResponseAcc[] = $oAccount->toResponseArray(); } $aSettings['Accounts'] = $aResponseAcc; if (null !== $oUser->getExtendedProp(self::GetName() . '::AllowAutosaveInDrafts')) { $aSettings['AllowAutosaveInDrafts'] = $oUser->getExtendedProp(self::GetName() . '::AllowAutosaveInDrafts'); } } $aArgs = []; $this->broadcastEvent('GetSettings::after', $aArgs, $aSettings); // Added for compatibility with other modules return $aSettings; } /** * @api {post} ?/Api/ UpdateSettings * @apiName UpdateSettings * @apiGroup Mail * @apiDescription Updates module global or per user settings. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Files} Module Module name * @apiParam {string=UpdateSettings} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AutocreateMailAccountOnNewUserFirstLogin** *boolean* Allows auto-provisioning of new users.
* **AllowAddAccounts** *boolean* Allows users to add external mailboxes.
* **AllowAutosaveInDrafts** *boolean* Indicates if message should be saved automatically while compose.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateSettings', * Parameters: '{ AllowAutosaveInDrafts: false }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name * @apiSuccess {string} Result.Method Method name * @apiSuccess {boolean} Result.Result Indicates if settings were updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateSettings', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Files', * Method: 'UpdateSettings', * Result: false, * ErrorCode: 102 * } */ /** * Updates module global or per user settings. * @param boolean $AutocreateMailAccountOnNewUserFirstLogin Allows auto-provisioning of new users. * @param boolean $AllowAddAccounts Allows users to add external mailboxes. * @param boolean $AllowAutosaveInDrafts Indicates if message should be saved automatically while compose. * @return boolean */ public function UpdateSettings($AutocreateMailAccountOnNewUserFirstLogin = null, $AllowAddAccounts = null, $AllowAutosaveInDrafts = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oUser) { if ($oUser->isNormalOrTenant()) { if ($AllowAutosaveInDrafts !== null) { $oUser->setExtendedProp(self::GetName() . '::AllowAutosaveInDrafts', $AllowAutosaveInDrafts); } $oCoreDecorator = \Aurora\Modules\Core\Module::Decorator(); return $oCoreDecorator->UpdateUserObject($oUser); } if ($oUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin) { if ($AutocreateMailAccountOnNewUserFirstLogin !== null) { $this->setConfig('AutocreateMailAccountOnNewUserFirstLogin', $AutocreateMailAccountOnNewUserFirstLogin); } if ($AllowAddAccounts !== null) { $this->setConfig('AllowAddAccounts', $AllowAddAccounts); } return $this->saveModuleConfig(); } } return false; } public function GetEntitySpaceLimits($Type, $UserId = null, $TenantId = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::TenantAdmin); $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($Type === 'User' && is_int($UserId) && $UserId > 0) { $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserWithoutRoleCheck($UserId); if ($oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin || $oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::TenantAdmin && $oAuthenticatedUser->IdTenant === $oUser->IdTenant) { $oTenant = \Aurora\System\Api::getTenantById($oUser->IdTenant); return [ 'UserSpaceLimitMb' => $oUser->getExtendedProp(self::GetName() . '::UserSpaceLimitMb'), 'AllowChangeUserSpaceLimit' => $oTenant->getExtendedProp(self::GetName() . '::AllowChangeUserSpaceLimit'), ]; } } if ($Type === 'Tenant' && is_int($TenantId) && $TenantId > 0) { $oTenant = \Aurora\System\Api::getTenantById($TenantId); if ($oTenant instanceof Tenant && $oAuthenticatedUser instanceof User && ($oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin || $oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::TenantAdmin && $oAuthenticatedUser->IdTenant === $TenantId)) { return [ 'TenantSpaceLimitMb' => $oTenant->getExtendedProp(self::GetName() . '::TenantSpaceLimitMb'), 'UserSpaceLimitMb' => $oTenant->getExtendedProp(self::GetName() . '::UserSpaceLimitMb'), 'AllowChangeUserSpaceLimit' => $oTenant->getExtendedProp(self::GetName() . '::AllowChangeUserSpaceLimit'), 'AllocatedSpaceMb' => $oTenant->getExtendedProp(self::GetName() . '::AllocatedSpaceMb'), ]; } } return []; } protected function updateAllocatedTenantSpace($iTenantId, $iNewUserQuota, $iPrevUserQuota) { $oTenant = \Aurora\System\Api::getTenantById($iTenantId); if ($oTenant) { $iAllocatedSpaceMb = $oTenant->getExtendedProp(self::GetName() . '::AllocatedSpaceMb'); $iAllocatedSpaceMb += $iNewUserQuota - $iPrevUserQuota; if ($iAllocatedSpaceMb < 0) { $iAllocatedSpaceMb = 0; } $oTenant->setExtendedProp(self::GetName() . '::AllocatedSpaceMb', $iAllocatedSpaceMb); \Aurora\Modules\Core\Module::Decorator()->getTenantsManager()->updateTenant($oTenant); } } public function UpdateEntitySpaceLimits($Type, $UserId, $TenantId, $TenantSpaceLimitMb, $UserSpaceLimitMb = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::TenantAdmin); $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oAuthenticatedUser instanceof User && $Type === 'User' && is_int($UserId) && $UserId > 0) { $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserWithoutRoleCheck($UserId); if ($oUser instanceof User && ($oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin || $oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::TenantAdmin && $oAuthenticatedUser->IdTenant === $oUser->IdTenant)) { $aPrevUserQuota = self::Decorator()->GetEntitySpaceLimits('User', $UserId, $oUser->IdTenant); $aTenantQuota = self::Decorator()->GetEntitySpaceLimits('Tenant', $UserId, $oUser->IdTenant); $mResult = false; if (is_array($aTenantQuota) && isset($aTenantQuota['AllocatedSpaceMb']) && is_array($aPrevUserQuota) && isset($aPrevUserQuota['UserSpaceLimitMb'])) { $iNewAllocatedSpaceMb = $aTenantQuota['AllocatedSpaceMb'] - $aPrevUserQuota['UserSpaceLimitMb'] + $UserSpaceLimitMb; if ($aTenantQuota['TenantSpaceLimitMb'] > 0 && $aTenantQuota['TenantSpaceLimitMb'] < $iNewAllocatedSpaceMb) { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::TenantQuotaExceeded); } $aArgs = [ 'TenantId' => $TenantId, 'Email' => $oUser->PublicId, 'QuotaMb' => $UserSpaceLimitMb ]; $this->broadcastEvent( 'UpdateQuota', $aArgs, $mResult ); } if ($mResult !== false) { $this->updateAllocatedTenantSpace($TenantId, $UserSpaceLimitMb, $aPrevUserQuota['UserSpaceLimitMb']); $oUser->setExtendedProp(self::GetName() . '::UserSpaceLimitMb', $UserSpaceLimitMb); $oUser->save(); } return $mResult; } } if ($Type === 'Tenant' && is_int($TenantId) && $TenantId > 0) { $oTenant = \Aurora\Modules\Core\Module::Decorator()->GetTenantWithoutRoleCheck($TenantId); if ($oTenant && ($oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin || $oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::TenantAdmin && $oAuthenticatedUser->IdTenant === $TenantId)) { $oTenant->setExtendedProp(self::GetName() . '::TenantSpaceLimitMb', $TenantSpaceLimitMb); if (is_int($UserSpaceLimitMb)) { $oTenant->setExtendedProp(self::GetName() . '::UserSpaceLimitMb', $UserSpaceLimitMb); } return $oTenant->save(); } } return false; } /** * @api {post} ?/Api/ GetAccounts * @apiName GetAccounts * @apiGroup Mail * @apiDescription Obtains list of mail accounts for user. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetAccounts} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **UserId** *int* User identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetAccounts' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result List of mail accounts in case of success, otherwise **false**. Description of account properties are placed in GetAccount method description. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetAccounts', * Result: [ { "AccountID": 12, "UUID": "uuid_value", "UseToAuthorize": true, "Email": "test@email", * "FriendlyName": "", "IncomingLogin": "test@email", "UseSignature": false, "Signature": "", * "ServerId": 10, "Server": { "Id": 10, "UUID": "uuid_value", "TenantId": 0, "Name": "Mail server", * "IncomingServer": "mail.email", "IncomingPort": 143, "IncomingUseSsl": false, "OutgoingServer": "mail.email", * "OutgoingPort": 25, "OutgoingUseSsl": false, "SmtpAuthType": "0", "OwnerType": "superadmin", * "Domains": "", "ServerId": 10 }, "CanBeUsedToAuthorize": true, "UseThreading": true, * "AllowAutoresponder": false, "AllowAutoresponder": false, "AllowAutoresponder": false } ] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetAccounts', * Result: false, * ErrorCode: 102 * } */ /** * Obtains list of mail accounts for user. * @param int $UserId User identifier. * @return array|boolean */ public function GetAccounts($UserId) { $mResult = false; $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oAuthenticatedUser && $oAuthenticatedUser->Id === $UserId) { // If $UserId is equal to identifier of authenticated user, it is a situation when normal user is logged in. \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); } else { // Otherwise it is a super administrator or some code that is executed after \Aurora\System\Api::skipCheckUserRole method was called. // If it is a second case user identifier shouldn't be checked. It could be even an anonymous user. // There is no $oAuthenticatedUser for anonymous user. \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } $aAccounts = $this->getAccountsManager()->getUserAccounts($UserId); $mResult = []; foreach ($aAccounts as $oAccount) { if ($oAuthenticatedUser && $oAccount->IncomingLogin === $oAuthenticatedUser->PublicId) { array_unshift($mResult, $oAccount); } else { $mResult[] = $oAccount; } } return $mResult; } /** * @api {post} ?/Api/ GetAccount * @apiName GetAccount * @apiGroup Mail * @apiDescription Obtains mail account with specified identifier. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetAccount} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountId** *int* Identifier of mail account to obtain.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetAccount', * Parameters: '{ "AccountId": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Mail account properties in case of success, otherwise **false**. * @apiSuccess {int} Result.Result.AccountID Account identifier. * @apiSuccess {string} Result.Result.UUID Account UUID. * @apiSuccess {boolean} Result.Result.UseToAuthorize Indicates if account is used for authentication. * @apiSuccess {string} Result.Result.Email Account email. * @apiSuccess {string} Result.Result.FriendlyName Account friendly name. * @apiSuccess {string} Result.Result.IncomingLogin Login for connection to IMAP server. * @apiSuccess {boolean} Result.Result.UseSignature Indicates if signature should be used in outgoing messages. * @apiSuccess {string} Result.Result.Signature Signature in outgoing messages. * @apiSuccess {int} Result.Result.ServerId Server identifier. * @apiSuccess {object} Result.Result.Server Server properties that are used for connection to IMAP and SMTP servers. * @apiSuccess {boolean} Result.Result.CanBeUsedToAuthorize Indicates if account can be used for authentication. It is forbidden to use account for authentication if another user has account with the same credentials and it is allowed to authenticate. * @apiSuccess {boolean} Result.Result.UseThreading Indicates if account uses mail threading. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetAccount', * Result: { "AccountID": 12, "UUID": "uuid_value", "UseToAuthorize": true, "Email": "test@email", * "FriendlyName": "", "IncomingLogin": "test@email", "UseSignature": false, "Signature": "", * "ServerId": 10, "Server": { "Id": 10, "UUID": "uuid_value", "TenantId": 0, "Name": "Mail server", * "IncomingServer": "mail.email", "IncomingPort": 143, "IncomingUseSsl": false, "OutgoingServer": "mail.email", * "OutgoingPort": 25, "OutgoingUseSsl": false, "SmtpAuthType": "0", "OwnerType": "superadmin", * "Domains": "", "ServerId": 10 }, "CanBeUsedToAuthorize": true, "UseThreading": true } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetAccount', * Result: false, * ErrorCode: 102 * } */ /** * Obtains mail account with specified identifier. * @param int $AccountId Identifier of mail account to obtain. * @return \Aurora\Modules\Mail\Models\MailAccount|boolean */ public function GetAccount($AccountId) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountId); self::checkAccountAccess($oAccount); return $oAccount; } public function GetAccountByEmail($Email, $UserId = 0) { $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); $oUser = $UserId !== 0 ? \Aurora\Modules\Core\Module::Decorator()->GetUserWithoutRoleCheck($UserId) : null; // Method has its specific access check so checkAccess method isn't used. if ($oAuthenticatedUser instanceof User && $oUser instanceof User) { if ($oUser->Id === $oAuthenticatedUser->Id) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); } elseif ($oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::TenantAdmin && $oUser->IdTenant === $oAuthenticatedUser->IdTenant) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::TenantAdmin); } } else { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } $mResult = false; $oAccount = $this->getAccountsManager()->getAccountByEmail($Email, $UserId); if ($oAccount instanceof \Aurora\Modules\Mail\Models\MailAccount && $UserId === $oAccount->IdUser) { $mResult = $oAccount; } return $mResult; } /** * @api {post} ?/Api/ CreateAccount * @apiName CreateAccount * @apiGroup Mail * @apiDescription Creates mail account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=CreateAccount} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **UserId** *int* (optional) User identifier.
* **FriendlyName** *string* (optional) Friendly name.
* **Email** *string* Email.
* **IncomingLogin** *string* Login for IMAP connection.
* **IncomingPassword** *string* Password for IMAP connection.
* **Server** *object* List of settings for IMAP and SMTP connections.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'CreateAccount', * Parameters: '{ "Email": "test@email", "IncomingLogin": "test@email", "IncomingPassword": "pass_value", * "Server": { "ServerId": 10 } }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Mail account properties in case of success, otherwise **false**. * @apiSuccess {int} Result.Result.AccountID Created account identifier. * @apiSuccess {string} Result.Result.UUID Created account UUID. * @apiSuccess {boolean} Result.Result.UseToAuthorize Indicates if account is used for authentication. * @apiSuccess {string} Result.Result.Email Account email. * @apiSuccess {string} Result.Result.FriendlyName Account friendly name. * @apiSuccess {string} Result.Result.IncomingLogin Login for connection to IMAP server. * @apiSuccess {boolean} Result.Result.UseSignature Indicates if signature should be used in outgoing messages. * @apiSuccess {string} Result.Result.Signature Signature in outgoing messages. * @apiSuccess {int} Result.Result.ServerId Server identifier. * @apiSuccess {object} Result.Result.Server Server properties that are used for connection to IMAP and SMTP servers. * @apiSuccess {boolean} Result.Result.CanBeUsedToAuthorize Indicates if account can be used for authentication. It is forbidden to use account for authentication if another user has account with the same credentials and it is allowed to authenticate. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'CreateAccount', * Result: { "AccountID": 12, "UUID": "uuid_value", "UseToAuthorize": true, "Email": "test@email", * "FriendlyName": "", "IncomingLogin": "test@email", "UseSignature": false, "Signature": "", * "ServerId": 10, "Server": { "ServerId": 10, "Name": "Mail server", "IncomingServer": "mail.server", * "IncomingPort": 143, "IncomingUseSsl": false, "OutgoingServer": "mail.server", "OutgoingPort": 25, * "OutgoingUseSsl": false, "SmtpAuthType": "0", "Domains": "" }, "CanBeUsedToAuthorize": true } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'CreateAccount', * Result: false, * ErrorCode: 102 * } */ /** * Creates mail account. * @param int $UserId User identifier. * @param string $FriendlyName Friendly name. * @param string $Email Email. * @param string $IncomingLogin Login for IMAP connection. * @param string $IncomingPassword Password for IMAP connection. * @param array $Server List of settings for IMAP and SMTP connections. * @return \Aurora\Modules\Mail\Models\MailAccount|boolean */ public function CreateAccount( $UserId = 0, $FriendlyName = '', $Email = '', $IncomingLogin = '', $IncomingPassword = '', $Server = null, $XAuth = null ) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); \Aurora\System\Api::CheckAccess($UserId); $Email = \strtolower($Email); $IncomingLogin = strtolower($IncomingLogin); $oAccount = $this->GetAccountByEmail($Email, $UserId); $oServer = false; if ($oAccount instanceof \Aurora\Modules\Mail\Models\MailAccount) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccountExists); } else { if ($Email) { $sDomain = \MailSo\Base\Utils::GetDomainFromEmail($Email); $bCustomServerCreated = false; $iServerId = isset($Server) ? $Server['ServerId'] : 0; if ($Server !== null && $iServerId === 0) { $oNewServer = new \Aurora\Modules\Mail\Models\Server(); $oNewServer->Name = $Server['IncomingServer']; $oNewServer->IncomingServer = $Server['IncomingServer']; $oNewServer->IncomingPort = $Server['IncomingPort']; $oNewServer->IncomingUseSsl = $Server['IncomingUseSsl']; $oNewServer->OutgoingServer = $Server['OutgoingServer']; $oNewServer->OutgoingPort = $Server['OutgoingPort']; $oNewServer->OutgoingUseSsl = $Server['OutgoingUseSsl']; $oNewServer->SmtpAuthType = $Server['SmtpAuthType']; $oNewServer->Domains = $sDomain; $oNewServer->EnableThreading = $Server['EnableThreading']; $iServerId = $this->getServersManager()->createServer($oNewServer); $bCustomServerCreated = true; } if ($Server === null) { $aServerResult = self::Decorator()->GetMailServerByDomain($sDomain, /*AllowWildcardDomain*/true); if (isset($aServerResult['Server'])) { $oServer = $aServerResult['Server']; $iServerId = $oServer->Id; } } $oAccount = new \Aurora\Modules\Mail\Models\MailAccount(); $oAccount->IdUser = $UserId; $oAccount->FriendlyName = $FriendlyName; $oAccount->Email = $Email; $oAccount->IncomingLogin = $IncomingLogin; $oAccount->setPassword($IncomingPassword); if ($iServerId > 0) { $oServer = $this->getServersManager()->getServer($iServerId); } if ($oServer) { $oAccount->Server()->associate($oServer); $oAccount->UseThreading = $oServer->EnableThreading; } $oAccount->XOAuth = $XAuth; $bAccoutResult = false; $oResException = null; $bDoImapLoginOnAccountCreate = $this->oModuleSettings->DoImapLoginOnAccountCreate && is_null($XAuth); if ($bDoImapLoginOnAccountCreate) { $oResException = $this->getMailManager()->validateAccountConnection($oAccount, false); } $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserWithoutRoleCheck($UserId); $aQuota = []; $iQuota = 0; if ($oResException === null && $oUser instanceof User && $oUser->PublicId === $oAccount->Email) { $aTenantQuota = self::Decorator()->GetEntitySpaceLimits('Tenant', $UserId, $oUser->IdTenant); if (is_array($aTenantQuota) && isset($aTenantQuota['AllocatedSpaceMb']) && isset($aTenantQuota['TenantSpaceLimitMb'])) { if ($bDoImapLoginOnAccountCreate) { $aQuota = $this->getMailManager()->getQuota($oAccount); } else { $aQuota[1] = 0; } $iQuota = (is_array($aQuota) && isset($aQuota[1])) ? $aQuota[1] / 1024 : 0; $iNewAllocatedSpaceMb = $aTenantQuota['AllocatedSpaceMb'] + $iQuota; if ($aTenantQuota['TenantSpaceLimitMb'] > 0 && $aTenantQuota['TenantSpaceLimitMb'] < $iNewAllocatedSpaceMb) { $oResException = new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::TenantQuotaExceeded, null, $this->i18N('ERROR_TENANT_QUOTA_EXCEEDED')); } } } if ($oResException === null) { if ($oUser instanceof User && $oUser->PublicId === $Email && !$this->getAccountsManager()->useToAuthorizeAccountExists($Email)) { $oAccount->UseToAuthorize = true; } $bAccoutResult = $this->getAccountsManager()->createAccount($oAccount); } if ($bAccoutResult) { if ($oAccount->Email === $oUser->PublicId && $bDoImapLoginOnAccountCreate) { if (empty($aQuota)) { $aQuota = $this->getMailManager()->getQuota($oAccount); $iQuota = (is_array($aQuota) && isset($aQuota[1])) ? $aQuota[1] / 1024 : 0; } $this->updateAllocatedTenantSpace($oUser->IdTenant, $iQuota, 0); $oUser->setExtendedProp(self::GetName() . '::UserSpaceLimitMb', $iQuota); $oUser->save(); } if ($oServer && $oServer->EnableSieve && $this->oModuleSettings->EnableAllowBlockLists) { try { $this->getSieveManager()->setAllowBlockLists($oAccount, [], []); } catch (\Exception $oEx) { Api::LogException($oEx); } } return $oAccount; } elseif ($bCustomServerCreated) { $this->getServersManager()->deleteServer($iServerId); } if ($oResException !== null) { throw $oResException; } } } return false; } /** * @api {post} ?/Api/ UpdateAccount * @apiName UpdateAccount * @apiGroup Mail * @apiDescription Updates mail account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateAccount} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Identifier of account to update.
* **FriendlyName** *string* New friendly name.
* **Email** *string* New email.
* **IncomingLogin** *string* New loging for IMAP connection.
* **IncomingPassword** *string* New password for IMAP connection.
* **Server** *object* List of settings for IMAP and SMTP connections.
* **UseThreading** *boolean* Indicates if account uses mail threading.
* **SaveRepliesToCurrFolder** *boolean* Indicates if replies should be saved to current folder (not Sent Items).
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateAccount', * Parameters: '{ "Email": "test@email", "IncomingLogin": "test@email", * "IncomingPassword": "pass_value", "Server": { "ServerId": 10 }, "UseThreading": true, * "SaveRepliesToCurrFolder": false }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if account was updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateAccount', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateAccount', * Result: false, * ErrorCode: 102 * } */ /** * Updates mail account. * @param int $AccountID Identifier of account to update. * @param boolean $UseToAuthorize Indicates if account can be used to authorize user. * @param string $Email New email. * @param string $FriendlyName New friendly name. * @param string $IncomingLogin New login for IMAP connection. * @param string $IncomingPassword New password for IMAP connection. * @param array $Server List of settings for IMAP and SMTP connections. * @param boolean $UseThreading Indicates if account uses mail threading. * @param boolean $SaveRepliesToCurrFolder Indicates if replies should be saved to current folder (not Sent Items) * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function UpdateAccount( $AccountID, $UseToAuthorize = null, $Email = null, $FriendlyName = null, $IncomingLogin = null, $IncomingPassword = null, $Server = null, $UseThreading = null, $SaveRepliesToCurrFolder = null ) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if ($AccountID > 0) { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { if (!empty($Email)) { $oAccount->Email = $Email; } if ($UseToAuthorize === false || $UseToAuthorize === true && !$this->getAccountsManager()->useToAuthorizeAccountExists($oAccount->Email, $oAccount->Id)) { $oAccount->UseToAuthorize = $UseToAuthorize; } if ($FriendlyName !== null) { $oAccount->FriendlyName = $FriendlyName; } if (!empty($IncomingLogin)) { $oAccount->IncomingLogin = $IncomingLogin; } if (!empty($IncomingPassword)) { $oAccount->setPassword($IncomingPassword); } if ($Server !== null) { if ($Server['ServerId'] === 0) { $sDomains = explode('@', $oAccount->Email)[1]; $oNewServer = new \Aurora\Modules\Mail\Models\Server(); $oNewServer->Name = $Server['IncomingServer']; $oNewServer->IncomingServer = $Server['IncomingServer']; $oNewServer->IncomingPort = $Server['IncomingPort']; $oNewServer->IncomingUseSsl = $Server['IncomingUseSsl']; $oNewServer->OutgoingServer = $Server['OutgoingServer']; $oNewServer->OutgoingPort = $Server['OutgoingPort']; $oNewServer->OutgoingUseSsl = $Server['OutgoingUseSsl']; $oNewServer->SmtpAuthType = $Server['SmtpAuthType']; $oNewServer->Domains = $sDomains; $oNewServer->EnableThreading = $Server['EnableThreading']; $iNewServerId = $this->getServersManager()->createServer($oNewServer); $oAccount->ServerId = $iNewServerId; } elseif ($oAccount->ServerId === $Server['ServerId']) { $oAccServer = $oAccount->getServer(); if ($oAccServer && $oAccServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::Account) { $oAccServer->Name = $Server['IncomingServer']; $oAccServer->IncomingServer = $Server['IncomingServer']; $oAccServer->IncomingPort = $Server['IncomingPort']; $oAccServer->IncomingUseSsl = $Server['IncomingUseSsl']; $oAccServer->OutgoingServer = $Server['OutgoingServer']; $oAccServer->OutgoingPort = $Server['OutgoingPort']; $oAccServer->OutgoingUseSsl = $Server['OutgoingUseSsl']; $oAccServer->SmtpAuthType = $Server['SmtpAuthType']; $this->getServersManager()->updateServer($oAccServer); } } else { $oAccServer = $oAccount->getServer(); if ($oAccServer && $oAccServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::Account) { $this->getServersManager()->deleteServer($oAccServer->Id); } $oAccount->ServerId = $Server['ServerId']; } } if ($UseThreading !== null) { $oAccount->UseThreading = $UseThreading; } if ($SaveRepliesToCurrFolder !== null) { $oAccount->SaveRepliesToCurrFolder = $SaveRepliesToCurrFolder; } if ($this->getAccountsManager()->updateAccount($oAccount)) { return $oAccount; } } } else { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } return false; } public function UpdateAccountUnifiedMailbox( $AccountID, $IncludeInUnifiedMailbox, $ShowUnifiedMailboxLabel, $UnifiedMailboxLabelText, $UnifiedMailboxLabelColor ) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (!$this->oModuleSettings->AllowUnifiedInbox) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } if (!is_int($AccountID) || $AccountID <= 0 || !is_bool($IncludeInUnifiedMailbox) || !is_bool($ShowUnifiedMailboxLabel) || !is_string($UnifiedMailboxLabelText) || !is_string($UnifiedMailboxLabelColor)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($oAccount instanceof Models\MailAccount) { $oAccount->IncludeInUnifiedMailbox = $IncludeInUnifiedMailbox; $oAccount->ShowUnifiedMailboxLabel = $ShowUnifiedMailboxLabel; $oAccount->UnifiedMailboxLabelText = $UnifiedMailboxLabelText; $oAccount->UnifiedMailboxLabelColor = $UnifiedMailboxLabelColor; if ($this->getAccountsManager()->updateAccount($oAccount)) { return $oAccount; } } return false; } /** * @api {post} ?/Api/ DeleteAccount * @apiName DeleteAccount * @apiGroup Mail * @apiDescription Deletes mail account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=DeleteAccount} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Identifier of account to delete.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'DeleteAccount', * Parameters: '{ "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if account was deleted successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'DeleteAccount', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'DeleteAccount', * Result: false, * ErrorCode: 102 * } */ /** * Deletes mail account. * @param int $AccountID Account identifier. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function DeleteAccount($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $bResult = false; if ($AccountID > 0) { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $this->getIdentitiesManager()->deleteAccountIdentities($oAccount->Id); $this->getMailManager()->deleteSystemFolderNames($oAccount->Id); $oServer = $oAccount->getServer(); $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserWithoutRoleCheck($oAccount->IdUser); if ($oUser instanceof User && $oAccount->Email === $oUser->PublicId) { $iQuota = $oUser->getExtendedProp(self::GetName() . '::UserSpaceLimitMb'); $this->updateAllocatedTenantSpace($oUser->IdTenant, 0, $iQuota); } $aArgs = [ 'Account' => $oAccount, 'User' => $oUser ]; $this->broadcastEvent( 'BeforeDeleteAccount', $aArgs ); $bResult = $this->getAccountsManager()->deleteAccount($oAccount); if ($bResult && $oServer && $oServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::Account) { $this->getServersManager()->deleteServer($oServer->Id); } } return $bResult; } else { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } } /** * @api {post} ?/Api/ GetServers * @apiName GetServers * @apiGroup Mail * @apiDescription Obtains list of servers which contains settings for IMAP and SMTP connections. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetServers} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **TenantId** *int* (optional) Identifier of tenant which contains servers to return. If TenantId is 0 returns server which are belonged to SuperAdmin, not Tenant.
* **Offset** *int* (optional) Says to skip that many servers before beginning to return them.
* **Limit** *int* (optional) Limit says to return that many servers in the list.
* **Search** *string* (optional) Search string.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetServers' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result List of mail servers in case of success, otherwise **false**. Description of server properties are placed in GetServer method description. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetServers', * Result: [ { "Id": 10, "UUID": "uuid_value", "TenantId": 0, "Name": "Mail server", * "IncomingServer": "mail.email", "IncomingPort": 143, "IncomingUseSsl": false, "OutgoingServer": "mail.email", * "OutgoingPort": 25, "OutgoingUseSsl": false, "SmtpAuthType": "0", "OwnerType": "superadmin", * "Domains": "", "ServerId": 10 } ] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetServers', * Result: false, * ErrorCode: 102 * } */ /** * Obtains list of servers which contains settings for IMAP and SMTP connections. * @param int $TenantId Identifier of tenant which contains servers to return. If $TenantId is 0 returns server which are belonged to SuperAdmin, not Tenant. * @param int $Offset Says to skip that many servers before beginning to return them. * @param int $Limit Limit says to return that many servers in the list. * @param string $Search Search string. * @return array */ public function GetServers($TenantId = 0, $Offset = 0, $Limit = 0, $Search = '') { $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oAuthenticatedUser instanceof User && $oAuthenticatedUser->isNormalOrTenant()) { if ($TenantId === 0) { $TenantId = $oAuthenticatedUser->IdTenant; } elseif ($TenantId !== $oAuthenticatedUser->IdTenant) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } } else { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } return [ 'Items' => $this->getServersManager()->getServerList($TenantId, $Offset, $Limit, $Search)->all(), 'Count' => $this->getServersManager()->getServersCount($TenantId, $Search), ]; } /** * @api {post} ?/Api/ GetServer * @apiName GetServer * @apiGroup Mail * @apiDescription Obtains server with specified server identifier. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetServer} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **ServerId** *int* Server identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetServer', * Parameters: '{ "ServerId": 10 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Mail server properties in case of success, otherwise **false**. * @apiSuccess {int} Result.Result.ServerId Server identifier. * @apiSuccess {string} Result.Result.UUID Server UUID. * @apiSuccess {int} Result.Result.TenantId Tenant identifier. * @apiSuccess {string} Result.Result.Name Server name. * @apiSuccess {string} Result.Result.IncomingServer IMAP server. * @apiSuccess {int} Result.Result.IncomingPort IMAP port. * @apiSuccess {boolean} Result.Result.IncomingUseSsl Indicates if SSL should be used for IMAP connection. * @apiSuccess {string} Result.Result.OutgoingServer SMTP server. * @apiSuccess {int} Result.Result.OutgoingPort SMTP port. * @apiSuccess {boolean} Result.Result.OutgoingUseSsl Indicates if SSL should be used for SMTP connection. * @apiSuccess {string} Result.Result.SmtpAuthType SMTP authentication type: '0' - no authentication, '1' - specified credentials, '2' - user credentials * @apiSuccess {string} Result.Result.SmtpLogin * @apiSuccess {string} Result.Result.SmtpPassword * @apiSuccess {string} Result.Result.OwnerType Owner type: 'superadmin' - server was created by SuperAdmin user, 'tenant' - server was created by TenantAdmin user, 'account' - server was created when account was created and any existent server was chosen. * @apiSuccess {string} Result.Result.Domains List of server domain separated by comma. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetServer', * Result: { "ServerId": 10, "UUID": "uuid_value", "TenantId": 0, "Name": "Mail server", * "IncomingServer": "mail.email", "IncomingPort": 143, "IncomingUseSsl": false, "OutgoingServer": "mail.email", * "OutgoingPort": 25, "OutgoingUseSsl": false, "SmtpAuthType": "0", "OwnerType": "superadmin", * "Domains": "" } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetServer', * Result: false, * ErrorCode: 102 * } */ /** * Obtains server with specified server identifier. * @param int $ServerId Server identifier. * @return \Aurora\Modules\Mail\Models\Server|boolean */ public function GetServer($ServerId) { $oServer = $this->getServersManager()->getServer($ServerId); $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oAuthenticatedUser instanceof User && $oAuthenticatedUser->isNormalOrTenant()) { if ($oServer->TenantId !== $oAuthenticatedUser->IdTenant) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } } else { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } return $oServer; } /** * @api {post} ?/Api/ CreateServer * @apiName CreateServer * @apiGroup Mail * @apiDescription Creates mail server. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=CreateServer} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **Name** *string* Server name.
* **IncomingServer** *string* IMAP server.
* **IncomingPort** *int* Port for connection to IMAP server.
* **IncomingUseSsl** *boolean* Indicates if it is necessary to use SSL while connecting to IMAP server.
* **OutgoingServer** *string* SMTP server.
* **OutgoingPort** *int* Port for connection to SMTP server.
* **OutgoingUseSsl** *boolean* Indicates if it is necessary to use SSL while connecting to SMTP server.
* **SmtpAuthType** *string* SMTP authentication type: '0' - no authentication, '1' - specified credentials, '2' - user credentials.
* **SmtpLogin** *string* (optional)
* **SmtpPassword** *string* (optional)
* **Domains** *string* List of domains separated by comma.
* **TenantId** *int* (optional) If tenant identifier is specified creates mail server belonged to specified tenant.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'CreateServer', * Parameters: '{ "Name": "Server name", "IncomingServer": "mail.server", "IncomingPort": 143, * "IncomingUseSsl": false, "OutgoingServer": "mail.server", "OutgoingPort": 25, * "OutgoingUseSsl": false, "SmtpAuthType": "0", "Domains": "" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Identifier of created server in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'CreateServer', * Result: 10 * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'CreateServer', * Result: false, * ErrorCode: 102 * } */ /** * Creates mail server. * @param string $Name Server name. * @param string $IncomingServer IMAP server. * @param int $IncomingPort Port for connection to IMAP server. * @param boolean $IncomingUseSsl Indicates if it is necessary to use SSL while connecting to IMAP server. * @param string $OutgoingServer SMTP server. * @param int $OutgoingPort Port for connection to SMTP server. * @param boolean $OutgoingUseSsl Indicates if it is necessary to use SSL while connecting to SMTP server. * @param string $SmtpAuthType SMTP authentication type: '0' - no authentication, '1' - specified credentials, '2' - user credentials. * @param string $Domains List of domains separated by comma. * @param boolean $EnableThreading * @param boolean $EnableSieve * @param int $SievePort * @param string $SmtpLogin (optional) * @param string $SmtpPassword (optional) * @param boolean $UseFullEmailAddressAsLogin (optional) * @param int $TenantId (optional) If tenant identifier is specified creates mail server belonged to specified tenant. * @param boolean $SetExternalAccessServers * @param string $ExternalAccessImapServer * @param int $ExternalAccessImapPort * @param int $ExternalAccessImapAlterPort * @param boolean $ExternalAccessImapUseSsl * @param string $ExternalAccessPop3Server * @param int $ExternalAccessPop3Port * @param int $ExternalAccessPop3AlterPort * @param boolean $ExternalAccessPop3UseSsl * @param string $ExternalAccessSmtpServer * @param int $ExternalAccessSmtpPort * @param int $ExternalAccessSmtpAlterPort * @param boolean $ExternalAccessSmtpUseSsl * @param boolean $OAuthEnable * @param string $OAuthName * @param string $OAuthType * @param string $OAuthIconUrl * @return int|boolean */ public function CreateServer( $Name, $IncomingServer, $IncomingPort, $IncomingUseSsl, $OutgoingServer, $OutgoingPort, $OutgoingUseSsl, $SmtpAuthType, $Domains, $EnableThreading = true, $EnableSieve = false, $SievePort = 4190, $SmtpLogin = '', $SmtpPassword = '', $UseFullEmailAddressAsLogin = true, $TenantId = 0, $SetExternalAccessServers = false, $ExternalAccessImapServer = '', $ExternalAccessImapPort = 143, $ExternalAccessImapAlterPort = 0, $ExternalAccessImapUseSsl = false, $ExternalAccessPop3Server = '', $ExternalAccessPop3Port = 143, $ExternalAccessPop3AlterPort = 0, $ExternalAccessPop3UseSsl = false, $ExternalAccessSmtpServer = '', $ExternalAccessSmtpPort = 25, $ExternalAccessSmtpAlterPort = 0, $ExternalAccessSmtpUseSsl = false, $OAuthEnable = false, $OAuthName = '', $OAuthType = '', $OAuthIconUrl = '' ) { $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oAuthenticatedUser instanceof User && $oAuthenticatedUser->Role === \Aurora\Modules\Mail\Enums\ServerOwnerType::Tenant) { if ($TenantId !== $oAuthenticatedUser->IdTenant) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } } else { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } $sOwnerType = ($TenantId === 0) ? \Aurora\Modules\Mail\Enums\ServerOwnerType::SuperAdmin : \Aurora\Modules\Mail\Enums\ServerOwnerType::Tenant; $oServer = new \Aurora\Modules\Mail\Models\Server(); $oServer->OwnerType = $sOwnerType; $oServer->TenantId = $TenantId; $oServer->Name = $Name; $oServer->IncomingServer = $IncomingServer; $oServer->IncomingPort = $IncomingPort; $oServer->IncomingUseSsl = $IncomingUseSsl; $oServer->OutgoingServer = $OutgoingServer; $oServer->OutgoingPort = $OutgoingPort; $oServer->OutgoingUseSsl = $OutgoingUseSsl; $oServer->SmtpAuthType = $SmtpAuthType; $oServer->SmtpLogin = $SmtpLogin; $oServer->SmtpPassword = $SmtpPassword; $oServer->Domains = $this->getServersManager()->trimDomains($Domains); $oServer->EnableThreading = $EnableThreading; $oServer->EnableSieve = $EnableSieve; $oServer->SievePort = $SievePort; $oServer->UseFullEmailAddressAsLogin = $UseFullEmailAddressAsLogin; $oServer->SetExternalAccessServers = $SetExternalAccessServers; if ($oServer->SetExternalAccessServers) { $oServer->ExternalAccessImapServer = $ExternalAccessImapServer; $oServer->ExternalAccessImapPort = $ExternalAccessImapPort; $oServer->ExternalAccessImapAlterPort = $ExternalAccessImapAlterPort; $oServer->ExternalAccessImapUseSsl = $ExternalAccessImapUseSsl; $oServer->ExternalAccessPop3Server = $ExternalAccessPop3Server; $oServer->ExternalAccessPop3Port = $ExternalAccessPop3Port; $oServer->ExternalAccessPop3AlterPort = $ExternalAccessPop3AlterPort; $oServer->ExternalAccessPop3UseSsl = $ExternalAccessPop3UseSsl; $oServer->ExternalAccessSmtpServer = $ExternalAccessSmtpServer; $oServer->ExternalAccessSmtpPort = $ExternalAccessSmtpPort; $oServer->ExternalAccessSmtpAlterPort = $ExternalAccessSmtpAlterPort; $oServer->ExternalAccessSmtpUseSsl = $ExternalAccessSmtpUseSsl; } $oServer->OAuthEnable = $OAuthEnable; if ($oServer->OAuthEnable) { $oServer->OAuthName = $OAuthName; $oServer->OAuthType = $OAuthType; $oServer->OAuthIconUrl = $OAuthIconUrl; } return $this->getServersManager()->createServer($oServer); } /** * @api {post} ?/Api/ UpdateServer * @apiName UpdateServer * @apiGroup Mail * @apiDescription Updates mail server with specified identifier. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateServer} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **ServerId** *int* Server identifier.
* **Name** *string* New server name.
* **IncomingServer** *string* New IMAP server.
* **IncomingPort** *int* New port for connection to IMAP server.
* **IncomingUseSsl** *boolean* Indicates if it is necessary to use SSL while connecting to IMAP server.
* **OutgoingServer** *string* New SMTP server.
* **OutgoingPort** *int* New port for connection to SMTP server.
* **OutgoingUseSsl** *boolean* Indicates if it is necessary to use SSL while connecting to SMTP server.
* **SmtpAuthType** *string* SMTP authentication type: '0' - no authentication, '1' - specified credentials, '2' - user credentials.
* **SmtpLogin** *string* (optional)
* **SmtpPassword** *string* (optional)
* **Domains** *string* New list of domains separated by comma.
* **TenantId** *int* If tenant identifier is specified creates mail server belonged to specified tenant.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateServer', * Parameters: '{ "Name": "Server name", "IncomingServer": "mail.server", "IncomingPort": 143, * "IncomingUseSsl": false, "OutgoingServer": "mail.server", "OutgoingPort": 25, "OutgoingUseSsl": false, * "SmtpAuthType": "0", "Domains": "" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if server was updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateServer', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateServer', * Result: false, * ErrorCode: 102 * } */ /** * Updates mail server with specified identifier. * @param int $ServerId Server identifier. * @param string $Name New server name. * @param string $IncomingServer New IMAP server. * @param int $IncomingPort New port for connection to IMAP server. * @param boolean $IncomingUseSsl Indicates if it is necessary to use SSL while connecting to IMAP server. * @param string $OutgoingServer New SMTP server. * @param int $OutgoingPort New port for connection to SMTP server. * @param boolean $OutgoingUseSsl Indicates if it is necessary to use SSL while connecting to SMTP server. * @param boolean $SmtpAuthType SMTP authentication type: '0' - no authentication, '1' - specified credentials, '2' - user credentials. * @param string $Domains New list of domains separated by comma. * @param boolean $EnableThreading * @param boolean $EnableSieve * @param int $SievePort * @param string $SmtpLogin * @param string $SmtpPassword * @param boolean $UseFullEmailAddressAsLogin * @param int $TenantId If tenant identifier is specified updates mail server belonged to specified tenant. * @param boolean $SetExternalAccessServers * @param string $ExternalAccessImapServer * @param int $ExternalAccessImapPort * @param int $ExternalAccessImapAlterPort * @param boolean $ExternalAccessImapUseSsl * @param string $ExternalAccessPop3Server * @param int $ExternalAccessPop3Port * @param int $ExternalAccessPop3AlterPort * @param boolean $ExternalAccessPop3UseSsl * @param string $ExternalAccessSmtpServer * @param int $ExternalAccessSmtpPort * @param int $ExternalAccessSmtpAlterPort * @param boolean $ExternalAccessSmtpUseSsl * @param boolean $OAuthEnable * @param string $OAuthName * @param string $OAuthType * @param string $OAuthIconUrl * @return boolean */ public function UpdateServer( $ServerId, $Name, $IncomingServer, $IncomingPort, $IncomingUseSsl, $OutgoingServer, $OutgoingPort, $OutgoingUseSsl, $SmtpAuthType, $Domains, $EnableThreading, $EnableSieve, $SievePort, $SmtpLogin = '', $SmtpPassword = '', $UseFullEmailAddressAsLogin = true, $TenantId = 0, $SetExternalAccessServers = false, $ExternalAccessImapServer = '', $ExternalAccessImapPort = 143, $ExternalAccessImapAlterPort = 0, $ExternalAccessImapUseSsl = false, $ExternalAccessPop3Server = '', $ExternalAccessPop3Port = 143, $ExternalAccessPop3AlterPort = 0, $ExternalAccessPop3UseSsl = false, $ExternalAccessSmtpServer = '', $ExternalAccessSmtpPort = 25, $ExternalAccessSmtpAlterPort = 0, $ExternalAccessSmtpUseSsl = false, $OAuthEnable = false, $OAuthName = '', $OAuthType = '', $OAuthIconUrl = '' ) { $bResult = false; $oServer = $this->getServersManager()->getServer($ServerId); if ($oServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::SuperAdmin) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } else { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::TenantAdmin); } if ($oServer && ($oServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::SuperAdmin || $oServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::Tenant && $oServer->TenantId === $TenantId)) { $oServer->Name = $Name; $oServer->IncomingServer = $IncomingServer; $oServer->IncomingPort = $IncomingPort; $oServer->IncomingUseSsl = $IncomingUseSsl; $oServer->OutgoingServer = $OutgoingServer; $oServer->OutgoingPort = $OutgoingPort; $oServer->OutgoingUseSsl = $OutgoingUseSsl; $oServer->SmtpAuthType = $SmtpAuthType; $oServer->SmtpLogin = $SmtpLogin; // Dummy password could be passed to client side by toResponseArray method. // Password will not be updated it if this value were received from client. if ($SmtpPassword !== '*****') { $oServer->SmtpPassword = $SmtpPassword; } $oServer->Domains = $this->getServersManager()->trimDomains($Domains); $oServer->EnableThreading = $EnableThreading; $oServer->EnableSieve = $EnableSieve; $oServer->SievePort = $SievePort; $oServer->UseFullEmailAddressAsLogin = $UseFullEmailAddressAsLogin; $oServer->SetExternalAccessServers = $SetExternalAccessServers; if ($oServer->SetExternalAccessServers) { $oServer->ExternalAccessImapServer = $ExternalAccessImapServer; $oServer->ExternalAccessImapPort = $ExternalAccessImapPort; $oServer->ExternalAccessImapAlterPort = $ExternalAccessImapAlterPort; $oServer->ExternalAccessImapUseSsl = $ExternalAccessImapUseSsl; $oServer->ExternalAccessPop3Server = $ExternalAccessPop3Server; $oServer->ExternalAccessPop3Port = $ExternalAccessPop3Port; $oServer->ExternalAccessPop3AlterPort = $ExternalAccessPop3AlterPort; $oServer->ExternalAccessPop3UseSsl = $ExternalAccessPop3UseSsl; $oServer->ExternalAccessSmtpServer = $ExternalAccessSmtpServer; $oServer->ExternalAccessSmtpPort = $ExternalAccessSmtpPort; $oServer->ExternalAccessSmtpAlterPort = $ExternalAccessSmtpAlterPort; $oServer->ExternalAccessImapUseSsl = $ExternalAccessImapUseSsl; $oServer->ExternalAccessSmtpUseSsl = $ExternalAccessSmtpUseSsl; } $oServer->OAuthEnable = $OAuthEnable; if ($oServer->OAuthEnable) { $oServer->OAuthName = $OAuthName; $oServer->OAuthType = $OAuthType; $oServer->OAuthIconUrl = $OAuthIconUrl; } $bResult = $this->getServersManager()->updateServer($oServer); } else { $bResult = false; } return $bResult; } /** * @api {post} ?/Api/ DeleteServer * @apiName DeleteServer * @apiGroup Mail * @apiDescription Deletes mail server. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=DeleteServer} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **ServerId** *int* Identifier of server to delete.
* **TenantId** *int* (optional) Identifier of tenant that contains mail server.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'DeleteServer', * Parameters: '{ "ServerId": 10 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if server was deleted successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'DeleteServer', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'DeleteServer', * Result: false, * ErrorCode: 102 * } */ /** * Deletes mail server. * @param int $ServerId Identifier of server to delete. * @param int $TenantId Identifier of tenant that contains mail server. * @return boolean */ public function DeleteServer($ServerId, $TenantId = 0) { $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oAuthenticatedUser instanceof User && $oAuthenticatedUser->Role === \Aurora\Modules\Mail\Enums\ServerOwnerType::Tenant) { if ($TenantId !== $oAuthenticatedUser->IdTenant) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } } else { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::SuperAdmin); } $mPrimaryAccounts = $this->getAccountsManager()->getAccounts(['ServerId' => $ServerId, 'UseToAuthorize' => true]); if ($mPrimaryAccounts) { foreach ($mPrimaryAccounts as $oAccount) { \Aurora\Modules\Core\Module::Decorator()->DeleteUser($oAccount->IdUser); } } $mSecondaryAccounts = $this->getAccountsManager()->getAccounts(['ServerId' => $ServerId, 'UseToAuthorize' => false]); if ($mSecondaryAccounts) { foreach ($mSecondaryAccounts as $oAccount) { self::Decorator()->DeleteAccount($oAccount->Id); } } return $this->getServersManager()->deleteServer($ServerId, $TenantId); } /** * @api {post} ?/Api/ GetFolders * @apiName GetFolders * @apiGroup Mail * @apiDescription Obtains list of folders for specified account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetFolders} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountId** *int* Identifier of mail account that contains folders to obtain.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetFolders', * Parameters: '{ "AccountId": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Folder list data in case of success, otherwise **false**. * @apiSuccess {object[]} Result.Result.Folders List of folders. * @apiSuccess {int} Result.Result.Folders.Count Count of folders. * @apiSuccess {object[]} Result.Result.Folders.Collection Collection of folders. * @apiSuccess {int} Result.Result.Folders.Collection.Type Type of folder: 1 - Inbox; 2 - Sent; 3 - Drafts; 4 - Spam; 5 - Trash; 10 - other folders. * @apiSuccess {string} Result.Result.Folders.Collection.Name Name of folder. * @apiSuccess {string} Result.Result.Folders.Collection.FullName Folder full name. * @apiSuccess {string} Result.Result.Folders.Collection.FullNameRaw Folder full name. * @apiSuccess {string} Result.Result.Folders.Collection.FullNameHash Hash of folder full name. * @apiSuccess {string} Result.Result.Folders.Collection.Delimiter Delimiter that is used in folder full name. * @apiSuccess {boolean} Result.Result.Folders.Collection.IsSubscribed Indicates if folder is subscribed. * @apiSuccess {boolean} Result.Result.Folders.Collection.IsSelectable Indicates if folder can be selected. * @apiSuccess {boolean} Result.Result.Folders.Collection.Exists Indicates if folder exists. * @apiSuccess {boolean} Result.Result.Folders.Collection.Extended Indicates if folder is extended. * @apiSuccess {object[]} Result.Result.Folders.Collection.SubFolders List of sub folders. * @apiSuccess {string} Result.Result.Namespace * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetFolders', * Result: { "Folders": { * "@Count": 5, * "@Collection": [ * { "Type": 1, "Name": "INBOX", "FullName": "INBOX", "FullNameRaw": "INBOX", * "FullNameHash": "hash_value", "Delimiter": "/", "IsSubscribed": true, * "IsSelectable": true, "Exists": true, "Extended": null, "SubFolders": null }, * { "Type": 2, "Name": "Sent", "FullName": "Sent", "FullNameRaw": "Sent", * "FullNameHash": "hash_value", "Delimiter": "/", "IsSubscribed": true, * "IsSelectable": true, "Exists": true, "Extended": null, "SubFolders": null }, * ... * ]}, "Namespace": "" } } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetFolders', * Result: false, * ErrorCode: 102 * } */ /** * Obtains list of folders for specified account. * @param int $AccountID Account identifier. * @return array */ public function GetFolders($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $oFolderCollection = $this->getMailManager()->getFolders($oAccount); return array( 'Folders' => $oFolderCollection, 'Namespace' => $oFolderCollection->GetNamespace() ); } public function getSortInfo($SortBy, $SortOrder) { $aMessagesSortBy = $this->oModuleSettings->MessagesSortBy; if ($SortOrder === null && $aMessagesSortBy !== false && isset($aMessagesSortBy['Allow']) && (bool) $aMessagesSortBy['Allow'] === true) { $oSortOrder = new \Aurora\System\Enums\SortOrder(); $aSortOrderMap = $oSortOrder->getMap(); $SortOrder = isset($aMessagesSortBy['SortOrder']) ? $aSortOrderMap[\strtoupper($aMessagesSortBy['SortOrder'])] : ''; } if ($SortBy === null) { if ($aMessagesSortBy !== false && isset($aMessagesSortBy['Allow']) && (bool) $aMessagesSortBy['Allow'] === true) { $SortBy = isset($aMessagesSortBy['DefaultSortBy']) ? $aMessagesSortBy['DefaultSortBy'] : ''; } } else { if ($aMessagesSortBy === false || isset($aMessagesSortBy['Allow']) && (bool) $aMessagesSortBy['Allow'] === false) { $SortBy = ''; } } if (empty($SortBy)) { $SortOrder = \Aurora\System\Enums\SortOrder::ASC; } return [$SortBy, $SortOrder]; } /** * @api {post} ?/Api/ GetMessages * @apiName GetMessages * @apiGroup Mail * @apiDescription Obtains message list for specified account and folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetMessages} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Offset** *int* Says to skip that many messages before beginning to return them.
* **Limit** *int* Limit says to return that many messages in the list.
* **Search** *string* Search string.
* **Filters** *string* List of conditions to obtain messages.
* **UseThreading** *int* Indicates if it is necessary to return messages in threads.
* **InboxUidnext** *string* (optional) UIDNEXT Inbox last value that is known on client side.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetMessages', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "Offset": 0, "Limit": 20, "Search": "", * "Filters": "", "UseThreading": true }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Messages data in case of success, otherwise **false**. * @apiSuccess {int} Result.Result.Count Count of messages. * @apiSuccess {object[]} Result.Result.Collection List of messages * @apiSuccess {string} Result.Result.Collection.Folder Full name of folder that contains the message. * @apiSuccess {int} Result.Result.Collection.Uid Message uid. * @apiSuccess {string} Result.Result.Collection.Subject Message subject. * @apiSuccess {string} Result.Result.Collection.MessageId Message string identifier that is retrieved from message headers. * @apiSuccess {int} Result.Result.Collection.Size Message size. * @apiSuccess {int} Result.Result.Collection.TextSize Message text size. * @apiSuccess {int} Result.Result.Collection.InternalTimeStampInUTC Timestamp of message receiving date. * @apiSuccess {int} Result.Result.Collection.ReceivedOrDateTimeStampInUTC Timestamp of date that is retrieved from message. * @apiSuccess {int} Result.Result.Collection.TimeStampInUTC InternalTimeStampInUTC or ReceivedOrDateTimeStampInUTC depending on UseDateFromHeaders setting. * @apiSuccess {object} Result.Result.Collection.From Collection of sender addresses. Usually contains one address. * @apiSuccess {object} Result.Result.Collection.To Collection of recipient addresses. * @apiSuccess {object} Result.Result.Collection.Cc Collection of recipient addresses which receive copies of message. * @apiSuccess {object} Result.Result.Collection.Bcc Collection of recipient addresses which receive hidden copies of message. * @apiSuccess {object} Result.Result.Collection.ReplyTo Collection of address which is used for message reply. * @apiSuccess {boolean} Result.Result.Collection.IsSeen Indicates if message is seen. * @apiSuccess {boolean} Result.Result.Collection.IsFlagged Indicates if message is flagged. * @apiSuccess {boolean} Result.Result.Collection.IsAnswered Indicates if message is answered. * @apiSuccess {boolean} Result.Result.Collection.IsForwarded Indicates if message is forwarded. * @apiSuccess {boolean} Result.Result.Collection.HasAttachments Indicates if message has attachments. * @apiSuccess {boolean} Result.Result.Collection.HasVcardAttachment Indicates if message has attachment with VCARD. * @apiSuccess {boolean} Result.Result.Collection.HasIcalAttachment Indicates if message has attachment with ICAL. * @apiSuccess {int} Result.Result.Collection.Importance Importance value of the message, from 1 (highest) to 5 (lowest). * @apiSuccess {array} Result.Result.Collection.DraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @apiSuccess {int} Result.Result.Collection.Sensitivity If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @apiSuccess {string} Result.Result.Collection.DownloadAsEmlUrl Url for download message as .eml file. * @apiSuccess {string} Result.Result.Collection.Hash Message hash. * @apiSuccess {array} Result.Result.Collection.Threads List of uids of messages that are belonged to one thread. * @apiSuccess {array} Result.Result.Uids List determines order of messages. * @apiSuccess {string} Result.Result.UidNext Last value of folder UIDNEXT. * @apiSuccess {string} Result.Result.FolderHash Folder hash is used to determine if there were changes in folder. * @apiSuccess {int} Result.Result.MessageCount Total count of messages in folder. * @apiSuccess {int} Result.Result.MessageUnseenCount Count of unread messages in folder. * @apiSuccess {int} Result.Result.MessageResultCount Count of messages in obtained list. * @apiSuccess {string} Result.Result.FolderName Full name of folder. * @apiSuccess {int} Result.Result.Offset Says to skip that many messages before beginning to return them. * @apiSuccess {int} Result.Result.Limit Limit says to return that many messages in the list. * @apiSuccess {string} Result.Result.Search Search string. * @apiSuccess {string} Result.Result.Filters List of conditions to obtain messages. * @apiSuccess {array} Result.Result.New List of short information about new messages. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetMessages', * Result: { "@Count": 30, "@Collection": [ * { "Folder": "INBOX", "Uid": 1690, "Subject": "subject_value", "MessageId": "id_value", * "Size": 17381, "TextSize": 117, "InternalTimeStampInUTC": 1493370309, * "ReceivedOrDateTimeStampInUTC": 1493370308, "TimeStampInUTC": 1493370309, * "From": { "@Count": 1, "@Collection": [ { "DisplayName": "", "Email": "test@email" } ] }, * "To": { "@Count":1, "@Collection": [ { "DisplayName": "", "Email": "test2@email" } ] }, * "Cc": null, "Bcc": null, "ReplyTo": null, "IsSeen": true, "IsFlagged": false, * "IsAnswered": false, "IsForwarded": false, "HasAttachments": true, * "HasVcardAttachment": false, "HasIcalAttachment": false, "Importance": 3, * "DraftInfo": null, "Sensitivity": 0, * "DownloadAsEmlUrl": "url_value", "Hash": "hash_value", "Threads": [] }, * ... * ], * "Uids": [1690,1689,1667,1666,1651,1649,1648,1647,1646,1639], "UidNext": "1691", * "FolderHash": "hash_value", "MessageCount": 639, "MessageUnseenCount": 0, * "MessageResultCount": 602, "FolderName": "INBOX", "Offset": 0, "Limit": 30, "Search": "", * "Filters": "", "New": [] } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetMessages', * Result: false, * ErrorCode: 102 * } */ /** * Obtains message list for specified account and folder. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param int $Offset Says to skip that many messages before beginning to return them. * @param int $Limit Limit says to return that many messages in the list. * @param string $Search Search string. * @param string $Filters List of conditions to obtain messages. * @param bool $UseThreading Indicates if it is necessary to return messages in threads. * @param string $InboxUidnext UIDNEXT Inbox last value that is known on client side. * @return array * @throws \Aurora\System\Exceptions\ApiException */ public function GetMessages($AccountID, $Folder, $Offset = 0, $Limit = 20, $Search = '', $Filters = '', $UseThreading = false, $InboxUidnext = '', $SortBy = null, $SortOrder = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $sSearch = \trim((string) $Search); $aFilters = array(); $sFilters = \strtolower(\trim((string) $Filters)); if (0 < \strlen($sFilters)) { $aFilters = \array_filter(\explode(',', $sFilters), function ($sValue) { return '' !== trim($sValue); }); } $iOffset = (int) $Offset; $iLimit = (int) $Limit; if (0 === \strlen(trim($Folder)) || 0 > $iOffset || 0 >= $iLimit || 200 < $iLimit) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $aSortInfo = $this->getSortInfo($SortBy, $SortOrder); $sSortBy = \strtoupper($aSortInfo[0]); $sSortOrder = $aSortInfo[1] === \Aurora\System\Enums\SortOrder::DESC ? 'REVERSE' : ''; return $this->getMailManager()->getMessageList( $oAccount, $Folder, $iOffset, $iLimit, $sSearch, $UseThreading, $aFilters, $InboxUidnext, $sSortBy, $sSortOrder ); } protected function getFoldersForSearch($oAccount, $Folder, $Search, &$sSearch) { $iSearchInFoldersType = SearchInFoldersType::Cur; if (!empty(trim($Search))) { $aSearch = explode(' ', $Search); if (is_array($aSearch) && count($aSearch) > 0) { $iKey = array_search('folders:sub', $aSearch); if ($iKey !== false) { $iSearchInFoldersType = SearchInFoldersType::Sub; unset($aSearch[$iKey]); } else { $iKey = array_search('folders:all', $aSearch); if ($iKey !== false) { $iSearchInFoldersType = SearchInFoldersType::All; unset($aSearch[$iKey]); } } $sSearch = implode(' ', $aSearch); } } $aFolders = []; $bCreateUnExistenSystemFolders = $Folder === ''; if ($iSearchInFoldersType === SearchInFoldersType::Cur) { $oFoldersColl = $this->getMailManager()->getFolders($oAccount, $bCreateUnExistenSystemFolders); $oFolder = $oFoldersColl->getFolder($Folder); $aFolders = [$oFolder]; } else { if ($iSearchInFoldersType === SearchInFoldersType::All) { $Folder = ''; } $oFoldersColl = $this->getMailManager()->getFolders($oAccount, $bCreateUnExistenSystemFolders, $Folder); $oFoldersColl->foreachWithSubFolders(function ($oFolder) use (&$aFolders) { if ($oFolder->isSubscribed() && $oFolder->isSelectable()) { if ($oFolder->getFolderXListType() !== \Aurora\Modules\Mail\Enums\FolderType::All) { $aFolders[] = $oFolder; } } }); } return $aFolders; } public function GetMessagesByFolders($AccountID, $Folder = '', $Offset = 0, $Limit = 20, $Search = '', $Filters = '', $UseThreading = false, $InboxUidnext = '', $SortBy = null, $SortOrder = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $sSearch = \trim((string) $Search); $aFilters = []; $sFilters = \strtolower(\trim((string) $Filters)); if (0 < \strlen($sFilters)) { $aFilters = \array_filter(\explode(',', $sFilters), function ($sValue) { return '' !== trim($sValue); }); } $iOffset = (int) $Offset; $iLimit = (int) $Limit; if (0 > $iOffset || 0 >= $iLimit || 200 < $iLimit) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $aSortInfo = $this->getSortInfo($SortBy, $SortOrder); $sSortBy = \strtoupper($aSortInfo[0]); $sSortOrder = $aSortInfo[1] === \Aurora\System\Enums\SortOrder::DESC ? 'REVERSE' : ''; $oMessageCollectionResult = \Aurora\Modules\Mail\Classes\MessageCollection::createInstance(); $oMessageCollectionResult->FolderName = $Folder; $oMessageCollectionResult->Limit = $iLimit; $oMessageCollectionResult->Offset = $iOffset; $oMessageCollectionResult->Search = $Search; $oMessageCollectionResult->Filters = implode(',', $aFilters); $aFolderUids = []; $aUids = []; $iMessagesCount = 0; $iMessagesResultCount = 0; $iMessagesUnseenCount = 0; $aFoldersHash = []; $sSortBy = 'ARRIVAL'; $sSortOrder = $SortOrder === \Aurora\System\Enums\SortOrder::DESC ? 'REVERSE' : ''; $aFolders = $this->getFoldersForSearch($oAccount, $Folder, $Search, $sSearch); foreach ($aFolders as $oFolder) { $sFolder = $oFolder->getRawFullName(); $aUnifiedInfo = $this->getMailManager()->getUnifiedMailboxMessagesInfo($oAccount, $sFolder, $sSearch, $aFilters, $UseThreading, $iOffset + $iLimit, $sSortBy, $sSortOrder); if (is_array($aUnifiedInfo['Uids']) && count($aUnifiedInfo['Uids']) > 0) { foreach ($aUnifiedInfo['Uids'] as $iKey => $aUid) { $aUnifiedInfo['Uids'][$iKey]['folder'] = $sFolder; } $aUids = array_merge( $aUids, $aUnifiedInfo['Uids'] ); } $iMessagesCount += $aUnifiedInfo['Count']; $iMessagesResultCount += $aUnifiedInfo['ResultCount']; $iMessagesUnseenCount += $aUnifiedInfo['UnreadCount']; $aFoldersHash[] = $sFolder . ':' . $aUnifiedInfo['FolderHash']; } // sort by time usort($aUids, function ($a, $b) use ($SortOrder) { if ($SortOrder === \Aurora\System\Enums\SortOrder::DESC) { return (strtotime($a['internaldate']) < strtotime($b['internaldate'])) ? 1 : -1; } else { return (strtotime($a['internaldate']) > strtotime($b['internaldate'])) ? 1 : -1; } }); if (count($aUids) >= 0) { $aUids = array_slice($aUids, $iOffset, $iLimit); } $aAllMessages = []; $aNextUids = []; $aFoldersHash = []; $aInboxUidsNext = []; if (!empty($InboxUidnext)) { $aInboxUids = \explode('.', $InboxUidnext); foreach ($aInboxUids as $aUid) { $aUidsNext = \explode(':', $aUid); if (count($aUidsNext) === 2) { $aInboxUidsNext[$aUidsNext[0]] = $aUidsNext[1]; } } } foreach ($aUids as $aUid) { $aFolderUids[$aUid['folder']][] = $aUid['uid']; } foreach ($aFolderUids as $sFolder => $aFldUids) { $sFolder = (string) $sFolder; $sInboxUidnext = isset($aInboxUidsNext[$sFolder]) ? $aInboxUidsNext[$sFolder] : ''; $oMessageCollection = $this->getMailManager()->getMessageListByUids( $oAccount, $sFolder, $aFldUids, $sInboxUidnext ); if ($UseThreading) { $oMessageCollection->ForeachList(function (/* @var $oMessage \Aurora\Modules\Mail\Classes\Message */ $oMessage) use ($aUids, $sFolder) { $iUid = $oMessage->getUid(); $aUidInfo = current(array_filter($aUids, function ($aUid) use ($sFolder, $iUid) { return $aUid['folder'] === $sFolder && $aUid['uid'] == $iUid; })); if (isset($aUidInfo['threads']) && is_array($aUidInfo['threads'])) { $oMessage->setThreads($aUidInfo['threads']); } }); } foreach ($oMessageCollection->New as $aNew) { $aNew['Folder'] = $sFolder; $oMessageCollectionResult->New[] = $aNew; } $aNextUids[] = $sFolder . ':' . $oMessageCollection->UidNext; $aMessages = $oMessageCollection->GetAsArray(); foreach ($aMessages as $oMessage) { //TODO Remove because it must be set when Message instance is created // $oMessage->setAccountId($oAccount->Id); $oMessage->setUnifiedUid($oAccount->Id . ':' . $sFolder . ':' . $oMessage->getUid()); } $aAllMessages = array_merge($aAllMessages, $aMessages); } // sort by time usort($aAllMessages, function ($a, $b) use ($SortOrder) { if ($SortOrder === \Aurora\System\Enums\SortOrder::DESC) { return ($a->getReceivedOrDateTimeStamp() < $b->getReceivedOrDateTimeStamp()) ? 1 : -1; } else { return ($a->getReceivedOrDateTimeStamp() > $b->getReceivedOrDateTimeStamp()) ? 1 : -1; } }); $oMessageCollectionResult->Uids = array_map(function ($oMessage) { return $oMessage->getUnifiedUid(); }, $aAllMessages); $oMessageCollectionResult->MessageCount = $iMessagesCount; $oMessageCollectionResult->MessageResultCount = $iMessagesResultCount; $oMessageCollectionResult->MessageUnseenCount = $iMessagesUnseenCount; $oMessageCollectionResult->UidNext = implode('.', $aNextUids); $oMessageCollectionResult->FolderHash = implode('.', $aFoldersHash); $oMessageCollectionResult->AddArray($aAllMessages); return $oMessageCollectionResult; } public function GetUnifiedMailboxMessages($UserId, $Folder = 'INBOX', $Offset = 0, $Limit = 20, $Search = '', $Filters = '', $UseThreading = false, $InboxUidnext = '', $SortOrder = \Aurora\System\Enums\SortOrder::DESC) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); \Aurora\System\Api::CheckAccess($UserId); if (!$this->oModuleSettings->AllowUnifiedInbox) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } $aFilters = array(); $sFilters = \strtolower(\trim((string) $Filters)); if (0 < \strlen($sFilters)) { $aFilters = \array_filter(\explode(',', $sFilters), function ($sValue) { return '' !== trim($sValue); }); } $oMessageCollectionResult = \Aurora\Modules\Mail\Classes\MessageCollection::createInstance(); $oMessageCollectionResult->FolderName = $Folder; $oMessageCollectionResult->Limit = $Limit; $oMessageCollectionResult->Offset = $Offset; $oMessageCollectionResult->Search = $Search; $oMessageCollectionResult->Filters = implode(',', $aFilters); $aAccounts = $this->getAccountsManager()->getUserAccounts($UserId); $aAccountsCache = []; $aUids = []; $aAccountUids = []; $iMessagesCount = 0; $iMessagesResultCount = 0; $iMessagesUnseenCount = 0; $aFoldersHash = []; $sSortBy = 'ARRIVAL'; $sSortOrder = $SortOrder === \Aurora\System\Enums\SortOrder::DESC ? 'REVERSE' : ''; foreach ($aAccounts as $oAccount) { if ($oAccount->IncludeInUnifiedMailbox) { $aAccountsCache[$oAccount->Id]['Account'] = $oAccount; $aAccountUids[$oAccount->Id] = []; $sSearch = $Search; $aFolders = $this->getFoldersForSearch($oAccount, $Folder, $Search, $sSearch); $aFolderFullNamesRaw = array_map(function ($oFolder) { return $oFolder->getRawFullName(); }, $aFolders); $aFoldersInfo = $this->getMailManager()->getFolderListInformation($oAccount, $aFolderFullNamesRaw, true); foreach ($aFolderFullNamesRaw as $sFolder) { $aUnifiedInfo = $this->getMailManager()->getUnifiedMailboxMessagesInfo( $oAccount, $sFolder, $sSearch, $aFilters, $UseThreading, $Offset + $Limit, $sSortBy, $sSortOrder ); if (is_array($aUnifiedInfo['Uids']) && count($aUnifiedInfo['Uids']) > 0) { foreach ($aUnifiedInfo['Uids'] as $iKey => $aUid) { $aUnifiedInfo['Uids'][$iKey]['folder'] = $sFolder; } $aUids = array_merge( $aUids, $aUnifiedInfo['Uids'] ); } $iMessagesCount += (int) $aFoldersInfo[$sFolder][0]; $iMessagesResultCount += $aUnifiedInfo['ResultCount']; $iMessagesUnseenCount += $aFoldersInfo[$sFolder][1]; $aFoldersHash[] = $aFoldersInfo[$sFolder][3]; } } } // sort by time usort($aUids, function ($a, $b) use ($SortOrder) { if ($SortOrder === \Aurora\System\Enums\SortOrder::DESC) { return (strtotime($a['internaldate']) < strtotime($b['internaldate'])) ? 1 : -1; } else { return (strtotime($a['internaldate']) > strtotime($b['internaldate'])) ? 1 : -1; } }); if (count($aUids) >= 0) { $aUids = array_slice($aUids, $Offset, $Limit); } $aAllMessages = []; $aNextUids = []; $aInboxUidsNext = []; if (!empty($InboxUidnext)) { $aInboxUids = \explode('.', $InboxUidnext); foreach ($aInboxUids as $aUid) { $aUidsNext = \explode(':', $aUid); if (count($aUidsNext) === 3) { $aInboxUidsNext[$aUidsNext[0]][$aUidsNext[1]] = $aUidsNext[2]; } } } foreach ($aUids as $aUid) { $aAccountUids[$aUid['accountid']][$aUid['folder']][] = $aUid['uid']; } foreach ($aAccountUids as $iAccountId => $aFolders) { $oAccount = $aAccountsCache[$iAccountId]['Account']; foreach ($aFolders as $sFolder => $aFolderUids) { $sInboxUidnext = isset($aInboxUidsNext[$iAccountId][$sFolder]) ? $aInboxUidsNext[$iAccountId][$sFolder] : ''; $oMessageCollection = $this->getMailManager()->getMessageListByUids( $oAccount, $sFolder, $aFolderUids, $sInboxUidnext ); if ($UseThreading) { $oMessageCollection->ForeachList(function (/* @var $oMessage \Aurora\Modules\Mail\Classes\Message */ $oMessage) use ($aUids, $iAccountId, $sFolder) { $iUid = $oMessage->getUid(); $aUidInfo = current(array_filter($aUids, function ($aUid) use ($iAccountId, $iUid, $sFolder) { return $aUid['folder'] === $sFolder && $aUid['accountid'] === $iAccountId && $aUid['uid'] == $iUid; })); if (isset($aUidInfo['threads']) && is_array($aUidInfo['threads'])) { $oMessage->setThreads($aUidInfo['threads']); } }); } $sPrefix = $oAccount->Id . ':' . $sFolder . ':'; foreach ($oMessageCollection->New as $aNew) { $aNew['AccountId'] = $oAccount->Id; $aNew['Folder'] = $sFolder; $oMessageCollectionResult->New[] = $aNew; } $aNextUids[] = $sPrefix . $oMessageCollection->UidNext; $aMessages = $oMessageCollection->GetAsArray(); foreach ($aMessages as $oMessage) { //TODO Remove because it must be set when Message instance is created // $oMessage->setAccountId($oAccount->Id); $oMessage->setUnifiedUid($sPrefix . $oMessage->getUid()); } $aAllMessages = array_merge($aAllMessages, $aMessages); } } // sort by time usort($aAllMessages, function ($a, $b) use ($SortOrder) { if ($SortOrder === \Aurora\System\Enums\SortOrder::DESC) { return ($a->getReceivedOrDateTimeStamp() < $b->getReceivedOrDateTimeStamp()) ? 1 : -1; } else { return ($a->getReceivedOrDateTimeStamp() > $b->getReceivedOrDateTimeStamp()) ? 1 : -1; } }); $oMessageCollectionResult->Uids = array_map(function ($oMessage) { return $oMessage->getUnifiedUid(); }, $aAllMessages); $oMessageCollectionResult->MessageCount = $iMessagesCount; $oMessageCollectionResult->MessageResultCount = $iMessagesResultCount; $oMessageCollectionResult->MessageUnseenCount = $iMessagesUnseenCount; $oMessageCollectionResult->UidNext = implode('.', $aNextUids); $oMessageCollectionResult->FolderHash = implode('.', $aFoldersHash); $oMessageCollectionResult->AddArray($aAllMessages); return $oMessageCollectionResult; } public function GetMessagesInfo($AccountID, $Folder, $Search = null, $UseThreading = false, $SortBy = null, $SortOrder = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $aSortInfo = $this->getSortInfo($SortBy, $SortOrder); $sSortBy = \strtoupper($aSortInfo[0]); $sSortOrder = $aSortInfo[1] === \Aurora\System\Enums\SortOrder::DESC ? 'REVERSE' : ''; return $this->getMailManager()->GetMessagesInfo( $oAccount, $Folder, $Search, $UseThreading, $sSortBy, $sSortOrder ); } public function GetUnifiedRelevantFoldersInformation($AccountsData) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (!$this->oModuleSettings->AllowUnifiedInbox) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } if (!\is_array($AccountsData) || 0 === \count($AccountsData)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $aResult = []; $iUnifiedCount = 0; $iUnifiedUnseenCount = 0; $aUnifiedUidNext = []; $aUnifiedFolderHash = []; foreach ($AccountsData as $aAccountData) { $iAccountId = $aAccountData['AccountID']; $oAccount = $this->getAccountsManager()->getAccountById($iAccountId); if ($oAccount instanceof Models\MailAccount) { self::checkAccountAccess($oAccount); $aCounts = self::Decorator()->GetRelevantFoldersInformation($iAccountId, $aAccountData['Folders'], $aAccountData['UseListStatusIfPossible']); $aCounts['AccountId'] = $iAccountId; $aResult[] = $aCounts; if (isset($aCounts['Counts']['INBOX']) && $oAccount->IncludeInUnifiedMailbox) { $iUnifiedCount += $aCounts['Counts']['INBOX'][0]; $iUnifiedUnseenCount += $aCounts['Counts']['INBOX'][1]; $aUnifiedUidNext[] = $iAccountId . ':' . $aCounts['Counts']['INBOX'][2]; $aUnifiedFolderHash[] = $iAccountId . ':' . $aCounts['Counts']['INBOX'][3]; } } } return [ 'Accounts' => $aResult, 'Unified' => [$iUnifiedCount, $iUnifiedUnseenCount, implode('.', $aUnifiedUidNext), implode('.', $aUnifiedFolderHash)] ]; } /** * @api {post} ?/Api/ GetRelevantFoldersInformation * @apiName GetRelevantFoldersInformation * @apiGroup Mail * @apiDescription Obtains relevant information about total and unseen messages count in specified folders. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetRelevantFoldersInformation} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folders** *array* List of folders full names.
* **UseListStatusIfPossible** *boolean* Indicates if LIST-STATUS command should be used if it's supported by IMAP server. If LIST-STATUS is used information about all folders will be obtained, and not only about the requested ones. * } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetRelevantFoldersInformation', * Parameters: '{ "AccountID": 12, "Folders": [ "INBOX", "Spam" ] }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Mail account properties in case of success, otherwise **false**. * @apiSuccess {object[]} Result.Result.Counts List of folders data where key is folder full name and value is array like [message_count, unread_message_count, "next_message_uid", "hash_to_indicate_changes"] * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetRelevantFoldersInformation', * Result: { "Counts": { "INBOX": [638, 0, "1690", "97b2a280e7b9f2cbf86857e5cacf63b7"], * "Spam": [71, 69, "92", "3c9fe98367857e9930c725010e947d88" ] } } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetRelevantFoldersInformation', * Result: false, * ErrorCode: 102 * } */ /** * Obtains relevant information about total and unseen messages count in specified folders. * @param int $AccountID Account identifier. * @param array $Folders List of folders full names. * @param boolean $UseListStatusIfPossible Indicates if LIST-STATUS command should be used if it's supported by IMAP server. * @return array * @throws \Aurora\System\Exceptions\ApiException * @throws \MailSo\Net\Exceptions\ConnectionException */ public function GetRelevantFoldersInformation($AccountID, $Folders, $UseListStatusIfPossible) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (!\is_array($Folders) || 0 === \count($Folders)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $aResult = array(); try { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $aResult = $this->getMailManager()->getFolderListInformation($oAccount, $Folders, $UseListStatusIfPossible); } catch (\MailSo\Net\Exceptions\ConnectionException $oException) { throw $oException; } catch (\MailSo\Imap\Exceptions\LoginException $oException) { throw $oException; } catch (\Aurora\Modules\Mail\Exceptions\Exception $oException) { throw $oException; } catch (\Exception $oException) { \Aurora\System\Api::Log((string) $oException); } return array( 'Counts' => $aResult, ); } /** * @api {post} ?/Api/ GetQuota * @apiName GetQuota * @apiGroup Mail * @apiDescription Obtains mail account quota. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetQuota} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetQuota', * Parameters: '{ "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Array like [quota_limit, used_space] in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetQuota', * Result: [8976, 10240] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetQuota', * Result: false, * ErrorCode: 102 * } */ /** * Obtains mail account quota. * @param int $AccountID Account identifier. * @return array|boolean */ public function GetQuota($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $aQuota = $this->getMailManager()->getQuota($oAccount); $iQuota = (is_array($aQuota) && isset($aQuota[1])) ? $aQuota[1] / 1024 : 0; $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserWithoutRoleCheck($oAccount->IdUser); $iUserSpaceLimitMb = ($oUser instanceof User) ? $oUser->getExtendedProp(self::GetName() . '::UserSpaceLimitMb') : 0; if ($iQuota !== $iUserSpaceLimitMb) { $this->updateAllocatedTenantSpace($oUser->IdTenant, $iQuota, $iUserSpaceLimitMb); $oUser->setExtendedProp(self::GetName() . '::UserSpaceLimitMb', $iQuota); $oUser->save(); } return $aQuota; // Can be changed by subscribers } /** * @api {post} ?/Api/ GetMessagesBodies * @apiName GetMessagesBodies * @apiGroup Mail * @apiDescription Obtains full data of specified messages including plain text, HTML text and attachments. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetMessagesBodies} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uids** *array* List of messages' uids.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetMessagesBodies', * Parameters: '{ "AccountID": 12, "Folder": "INBOX", "Uids": [ "1591", "1589", "1588", "1587", "1586" ] }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Array of messages in case of success, otherwise **false**. * @apiSuccess {string} Result.Result.Folder Full name of folder that contains the message. * @apiSuccess {int} Result.Result.Uid Message uid. * @apiSuccess {string} Result.Result.Subject Message subject. * @apiSuccess {string} Result.Result.MessageId Message string identifier that is retrieved from message headers. * @apiSuccess {int} Result.Result.Size Message size. * @apiSuccess {int} Result.Result.TextSize Message text size. * @apiSuccess {int} Result.Result.InternalTimeStampInUTC Timestamp of message receiving date. * @apiSuccess {int} Result.Result.ReceivedOrDateTimeStampInUTC Timestamp of date that is retrieved from message. * @apiSuccess {int} Result.Result.TimeStampInUTC InternalTimeStampInUTC or ReceivedOrDateTimeStampInUTC depending on UseDateFromHeaders setting. * @apiSuccess {object} Result.Result.From Collection of sender addresses. Usually contains one address. * @apiSuccess {object} Result.Result.To Collection of recipient addresses. * @apiSuccess {object} Result.Result.Cc Collection of recipient addresses which receive copies of message. * @apiSuccess {object} Result.Result.Bcc Collection of recipient addresses which receive hidden copies of message. * @apiSuccess {object} Result.Result.ReplyTo Collection of address which is used for message reply. * @apiSuccess {boolean} Result.Result.IsSeen Indicates if message is seen. * @apiSuccess {boolean} Result.Result.IsFlagged Indicates if message is flagged. * @apiSuccess {boolean} Result.Result.IsAnswered Indicates if message is answered. * @apiSuccess {boolean} Result.Result.IsForwarded Indicates if message is forwarded. * @apiSuccess {boolean} Result.Result.HasAttachments Indicates if message has attachments. * @apiSuccess {boolean} Result.Result.HasVcardAttachment Indicates if message has attachment with VCARD. * @apiSuccess {boolean} Result.Result.HasIcalAttachment Indicates if message has attachment with ICAL. * @apiSuccess {int} Result.Result.Importance Importance value of the message, from 1 (highest) to 5 (lowest). * @apiSuccess {array} Result.Result.DraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @apiSuccess {int} Result.Result.Sensitivity If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @apiSuccess {string} Result.Result.DownloadAsEmlUrl Url for download message as .eml file. * @apiSuccess {string} Result.Result.Hash Message hash. * @apiSuccess {string} Result.Result.Headers Block of headers of the message. * @apiSuccess {string} Result.Result.InReplyTo Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads. * @apiSuccess {string} Result.Result.References Content of References header block of the message. * @apiSuccess {string} Result.Result.ReadingConfirmationAddressee Email address reading confirmation is to be sent to. * @apiSuccess {string} Result.Result.Html HTML body of the message. * @apiSuccess {boolean} Result.Result.Truncated Indicates if message body is truncated. * @apiSuccess {string} Result.Result.Plain Message plaintext body prepared for display. * @apiSuccess {string} Result.Result.PlainRaw Message plaintext body as is. * @apiSuccess {boolean} Result.Result.Rtl Indicates if message body contains symbols from one of rtl languages. * @apiSuccess {array} Result.Result.Extend List of custom content, implemented for use of ICAL/VCARD content. * @apiSuccess {boolean} Result.Result.Safety Indication of whether the sender is trustworthy so it's safe to display external images. * @apiSuccess {boolean} Result.Result.HasExternals Indicates if HTML message body contains images with external URLs. * @apiSuccess {array} Result.Result.FoundedCIDs List of content-IDs used for inline attachments. * @apiSuccess {array} Result.Result.FoundedContentLocationUrls * @apiSuccess {array} Result.Result.Attachments Information about attachments of the message. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetMessagesBodies', * Result: [ * { "Folder": "INBOX", "Uid": 1591, "Subject": "test", "MessageId": "string_id", "Size": 2578, * "TextSize": 243, "InternalTimeStampInUTC": 1490615414, "ReceivedOrDateTimeStampInUTC": 1490615414, * "TimeStampInUTC": 1490615414, "From": {"@Count": 1, "@Collection": [ { "DisplayName": "", * "Email": "test@afterlogic.com" } ] }, "To": { "@Count": 1, "@Collection": [ { "DisplayName": "test", * "Email":"test@afterlogic.com" } ] }, "Cc": null, "Bcc": null, "ReplyTo": null, "IsSeen": true, * "IsFlagged": false, "IsAnswered": false, "IsForwarded": false, "HasAttachments": false, * "HasVcardAttachment": false, "HasIcalAttachment": false, "Importance": 3, "DraftInfo": null, * "Sensitivity": 0, "DownloadAsEmlUrl": "url_value", "Hash": "hash_value", * "Headers": "headers_value", "InReplyTo": "", "References": "", "ReadingConfirmationAddressee": "", * "Html": "html_text_of_message", "Truncated": false, "Plain": "", "PlainRaw": "", "Rtl": false, * "Extend": [], "Safety": false, "HasExternals": false, "FoundedCIDs": [], * "FoundedContentLocationUrls": [], "Attachments": null }, * ... * ] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetMessagesBodies', * Result: false, * ErrorCode: 102 * } */ /** * Obtains full data of specified messages including plain text, HTML text and attachments. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param array $Uids List of messages' uids. * @return array * @throws \Aurora\System\Exceptions\ApiException */ public function GetMessagesBodies($AccountID, $Folder, $Uids, $MessageBodyTruncationThreshold = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(\trim($Folder)) || !\is_array($Uids) || 0 === \count($Uids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); $oImapClient = &$this->getMailManager()->_getImapClient($oAccount); $oImapClient->FolderExamine($Folder); $aBodystructuresFetchResponse = $oImapClient->Fetch(array( \MailSo\Imap\Enumerations\FetchType::BODYSTRUCTURE), \implode(',', $Uids), true); $aBodystructures = []; foreach ($aBodystructuresFetchResponse as $oBodystructureFetchResponse) { $aBodystructures[(int) $oBodystructureFetchResponse->GetFetchValue('UID')] = $oBodystructureFetchResponse; } unset($aBodystructuresFetchResponse); // access will be checked in GetMessage method $aList = array(); foreach ($Uids as $iUid) { if (\is_numeric($iUid)) { $oBody = isset($aBodystructures[$iUid]) ? $aBodystructures[$iUid] : null; $oMessage = $this->Decorator()->GetMessage($AccountID, $Folder, (string) $iUid, '', $MessageBodyTruncationThreshold, $oBody); if ($oMessage instanceof \Aurora\Modules\Mail\Classes\Message) { $aList[] = $oMessage; } unset($oMessage); } } return $aList; } /** * @api {post} ?/Api/ GetMessage * @apiName GetMessage * @apiGroup Mail * @apiDescription Obtains full data of specified message including plain text, HTML text and attachments. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetMessage} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountId** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uid** *string* Message uid.
* **Rfc822MimeIndex** *string* (optional) If specified obtains message from attachment of another message.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetMessage', * Parameters: '{ "AccountId": 12, "Folder": "Inbox", "Uid": 1232 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Message properties in case of success, otherwise **false**. * @apiSuccess {string} Result.Result.Folder Full name of folder that contains the message. * @apiSuccess {int} Result.Result.Uid Message uid. * @apiSuccess {string} Result.Result.Subject Message subject. * @apiSuccess {string} Result.Result.MessageId Message string identifier that is retrieved from message headers. * @apiSuccess {int} Result.Result.Size Message size. * @apiSuccess {int} Result.Result.TextSize Message text size. * @apiSuccess {int} Result.Result.InternalTimeStampInUTC Timestamp of message receiving date. * @apiSuccess {int} Result.Result.ReceivedOrDateTimeStampInUTC Timestamp of date that is retrieved from message. * @apiSuccess {int} Result.Result.TimeStampInUTC InternalTimeStampInUTC or ReceivedOrDateTimeStampInUTC depending on UseDateFromHeaders setting. * @apiSuccess {object} Result.Result.From Collection of sender addresses. Usually contains one address. * @apiSuccess {object} Result.Result.To Collection of recipient addresses. * @apiSuccess {object} Result.Result.Cc Collection of recipient addresses which receive copies of message. * @apiSuccess {object} Result.Result.Bcc Collection of recipient addresses which receive hidden copies of message. * @apiSuccess {object} Result.Result.ReplyTo Collection of address which is used for message reply. * @apiSuccess {boolean} Result.Result.IsSeen Indicates if message is seen. * @apiSuccess {boolean} Result.Result.IsFlagged Indicates if message is flagged. * @apiSuccess {boolean} Result.Result.IsAnswered Indicates if message is answered. * @apiSuccess {boolean} Result.Result.IsForwarded Indicates if message is forwarded. * @apiSuccess {boolean} Result.Result.HasAttachments Indicates if message has attachments. * @apiSuccess {boolean} Result.Result.HasVcardAttachment Indicates if message has attachment with VCARD. * @apiSuccess {boolean} Result.Result.HasIcalAttachment Indicates if message has attachment with ICAL. * @apiSuccess {int} Result.Result.Importance Importance value of the message, from 1 (highest) to 5 (lowest). * @apiSuccess {array} Result.Result.DraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @apiSuccess {int} Result.Result.Sensitivity If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @apiSuccess {string} Result.Result.DownloadAsEmlUrl Url for download message as .eml file. * @apiSuccess {string} Result.Result.Hash Message hash. * @apiSuccess {string} Result.Result.Headers Block of headers of the message. * @apiSuccess {string} Result.Result.InReplyTo Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads. * @apiSuccess {string} Result.Result.References Content of References header block of the message. * @apiSuccess {string} Result.Result.ReadingConfirmationAddressee Email address reading confirmation is to be sent to. * @apiSuccess {string} Result.Result.Html HTML body of the message. * @apiSuccess {boolean} Result.Result.Truncated Indicates if message body is truncated. * @apiSuccess {string} Result.Result.Plain Message plaintext body prepared for display. * @apiSuccess {string} Result.Result.PlainRaw Message plaintext body as is. * @apiSuccess {boolean} Result.Result.Rtl Indicates if message body contains symbols from one of rtl languages. * @apiSuccess {array} Result.Result.Extend List of custom content, implemented for use of ICAL/VCARD content. * @apiSuccess {boolean} Result.Result.Safety Indication of whether the sender is trustworthy so it's safe to display external images. * @apiSuccess {boolean} Result.Result.HasExternals Indicates if HTML message body contains images with external URLs. * @apiSuccess {array} Result.Result.FoundedCIDs List of content-IDs used for inline attachments. * @apiSuccess {array} Result.Result.FoundedContentLocationUrls * @apiSuccess {array} Result.Result.Attachments Information about attachments of the message. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetMessage', * Result: { "Folder": "INBOX", "Uid": 1591, "Subject": "test", "MessageId": "string_id", "Size": 2578, * "TextSize": 243, "InternalTimeStampInUTC": 1490615414, "ReceivedOrDateTimeStampInUTC": 1490615414, * "TimeStampInUTC": 1490615414, "From": {"@Count": 1, "@Collection": [ { "DisplayName": "", * "Email": "test@afterlogic.com" } ] }, "To": { "@Count": 1, "@Collection": [ { "DisplayName": "test", * "Email":"test@afterlogic.com" } ] }, "Cc": null, "Bcc": null, "ReplyTo": null, "IsSeen": true, * "IsFlagged": false, "IsAnswered": false, "IsForwarded": false, "HasAttachments": false, * "HasVcardAttachment": false, "HasIcalAttachment": false, "Importance": 3, "DraftInfo": null, * "Sensitivity": 0, "DownloadAsEmlUrl": "url_value", "Hash": "hash_value", * "Headers": "headers_value", "InReplyTo": "", "References": "", "ReadingConfirmationAddressee": "", * "Html": "html_text_of_message", "Truncated": false, "Plain": "", "PlainRaw": "", "Rtl": false, "Extend": [], * "Safety": false, "HasExternals": false, "FoundedCIDs": [], "FoundedContentLocationUrls": [], "Attachments": null } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetMessage', * Result: false, * ErrorCode: 102 * } */ /** * Obtains full data of specified message including plain text, HTML text and attachments. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param string $Uid Message uid. * @param string $Rfc822MimeIndex If specified obtains message from attachment of another message. * @return \Aurora\Modules\Mail\Classes\Message * @throws \Aurora\System\Exceptions\ApiException * @throws InvalidArgumentException */ public function GetMessage($AccountID, $Folder, $Uid, $Rfc822MimeIndex = '', $MessageBodyTruncationThreshold = null, $oBody = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $iUid = 0 < \strlen($Uid) && \is_numeric($Uid) ? (int) $Uid : 0; if (0 === \strlen(\trim($Folder)) || 0 >= $iUid) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if (0 === \strlen($Folder) || !\is_numeric($iUid) || 0 >= (int) $iUid) { throw new InvalidArgumentException(); } $oImapClient = &$this->getMailManager()->_getImapClient($oAccount); $oImapClient->FolderExamine($Folder); $oMessage = false; $aTextMimeIndexes = array(); if (!isset($oBody)) { $aFetchResponse = $oImapClient->Fetch(array( \MailSo\Imap\Enumerations\FetchType::BODYSTRUCTURE), $iUid, true); $oBodyStructure = (0 < \count($aFetchResponse)) ? $aFetchResponse[0]->GetFetchBodyStructure($Rfc822MimeIndex) : null; } else { $oBodyStructure = $oBody->GetFetchBodyStructure($Rfc822MimeIndex); } $aCustomParts = array(); if ($oBodyStructure) { $aTextParts = $oBodyStructure->SearchHtmlOrPlainParts(); if (\is_array($aTextParts) && 0 < \count($aTextParts)) { foreach ($aTextParts as $oPart) { $aTextMimeIndexes[] = array($oPart->PartID(), $oPart->Size()); } } $aParts = $oBodyStructure->GetAllParts(); $this->broadcastEvent( 'GetBodyStructureParts', $aParts, $aCustomParts ); } $bTruncated = false; $aFetchItems = array( \MailSo\Imap\Enumerations\FetchType::INDEX, \MailSo\Imap\Enumerations\FetchType::UID, \MailSo\Imap\Enumerations\FetchType::RFC822_SIZE, \MailSo\Imap\Enumerations\FetchType::INTERNALDATE, \MailSo\Imap\Enumerations\FetchType::FLAGS, 0 < strlen($Rfc822MimeIndex) ? \MailSo\Imap\Enumerations\FetchType::BODY_PEEK . '[' . $Rfc822MimeIndex . '.HEADER]' : \MailSo\Imap\Enumerations\FetchType::BODY_HEADER_PEEK ); if (0 < \count($aTextMimeIndexes)) { if (0 < \strlen($Rfc822MimeIndex) && \is_numeric($Rfc822MimeIndex)) { $sLine = \MailSo\Imap\Enumerations\FetchType::BODY_PEEK . '[' . $aTextMimeIndexes[0][0] . '.1]'; if (\is_numeric($MessageBodyTruncationThreshold) && 0 < $MessageBodyTruncationThreshold && $MessageBodyTruncationThreshold < $aTextMimeIndexes[0][1]) { $sLine .= '<0.' . ((int) $MessageBodyTruncationThreshold) . '>'; $bTruncated = true; } $aFetchItems[] = $sLine; } else { foreach ($aTextMimeIndexes as $aTextMimeIndex) { $sLine = \MailSo\Imap\Enumerations\FetchType::BODY_PEEK . '[' . $aTextMimeIndex[0] . ']'; if (\is_numeric($MessageBodyTruncationThreshold) && 0 < $MessageBodyTruncationThreshold && $MessageBodyTruncationThreshold < $aTextMimeIndex[1]) { $sLine .= '<0.' . ((int) $MessageBodyTruncationThreshold) . '>'; $bTruncated = true; } $aFetchItems[] = $sLine; } } } foreach ($aCustomParts as $oCustomPart) { $aFetchItems[] = \MailSo\Imap\Enumerations\FetchType::BODY_PEEK . '[' . $oCustomPart->PartID() . ']'; } if (!$oBodyStructure) { $aFetchItems[] = \MailSo\Imap\Enumerations\FetchType::BODYSTRUCTURE; } $aFetchResponse = $oImapClient->Fetch($aFetchItems, $iUid, true); if (0 < \count($aFetchResponse)) { $oMessage = \Aurora\Modules\Mail\Classes\Message::createInstance($Folder, $aFetchResponse[0], $oBodyStructure, $Rfc822MimeIndex, $bTruncated); } if ($oMessage) { $oMessage->setAccountId($oAccount->Id); $sFromEmail = ''; $oFromCollection = $oMessage->getFrom(); if ($oFromCollection && 0 < $oFromCollection->Count()) { $oFrom = &$oFromCollection->GetByIndex(0); if ($oFrom) { $sFromEmail = trim($oFrom->GetEmail()); } } if (0 < \strlen($sFromEmail)) { $bAlwaysShowImagesInMessage = !!$this->oModuleSettings->AlwaysShowImagesInMessage; $oMessage->setSafety($bAlwaysShowImagesInMessage ? true : $this->getMailManager()->isSafetySender($oAccount->IdUser, $sFromEmail)); } $aData = array(); foreach ($aCustomParts as $oCustomPart) { $sData = $aFetchResponse[0]->GetFetchValue(\MailSo\Imap\Enumerations\FetchType::BODY . '[' . $oCustomPart->PartID() . ']'); if (!empty($sData)) { $sData = \MailSo\Base\Utils::DecodeEncodingValue($sData, $oCustomPart->MailEncodingName()); $sData = \MailSo\Base\Utils::ConvertEncoding( $sData, \MailSo\Base\Utils::NormalizeCharset($oCustomPart->Charset(), true), \MailSo\Base\Enumerations\Charset::UTF_8 ); } $aData[] = array( 'Data' => $sData, 'Part' => $oCustomPart ); } $this->broadcastEvent('ExtendMessageData', $aData, $oMessage); } if (!($oMessage instanceof \Aurora\Modules\Mail\Classes\Message)) { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::CannotGetMessage); } return $oMessage; } /** * Unsubscribe the account from the mailing list. * * @param $AccountID * @param $Folder * @param $Uid * @return bool */ public function Unsubscribe($AccountID, $Folder, $Uid) { $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $validate = false; $this->getMailManager()->directMessageToStream( $oAccount, function ($rResource) use (&$validate) { if (\is_resource($rResource)) { $rawMessage = stream_get_contents($rResource); try { $dkimValidator = new DKIMValidator($rawMessage); $validateResult = @$dkimValidator->validate(); $validateCount = count($validateResult); $validateSuccessCount = 0; if ($validateCount > 0) { foreach ($validateResult as $val) { if ($val[0]['status'] === 'SUCCESS') { $validateSuccessCount++; } } } $validate = $validateCount === $validateSuccessCount; } catch (DKIMException $e) { $validate = false; } } }, $Folder, $Uid ); if ($validate) { $oMessage = self::Decorator()->GetMessage($AccountID, $Folder, $Uid); if ($oMessage instanceof Message) { $aParsedHeaders = $oMessage->parseUnsubscribeHeaders(); if ($aParsedHeaders['OneClick']) { if (!empty($aParsedHeaders['Url'])) { $iCode = 0; $this->oHttp->SendPostRequest( $aParsedHeaders['Url'], ['List-Unsubscribe' => 'One-Click'], '', $iCode, \Aurora\Api::SystemLogger() ); $mResult = ($iCode == 200); } elseif (!empty($aParsedHeaders['Email'])) { $sEmailCheck = str_ireplace('mailto:', '', $aParsedHeaders['Email']); $aEmailData = explode('?', $sEmailCheck); $mResult = self::Decorator()->SendMessage( $AccountID, null, null, 0, [], "", $aEmailData[0], "", "", [], 'Unsubscribe' ); } } } } return $mResult; } public function GetMessageByMessageID($AccountID, $Folder, $UidFrom, $MessageID) { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $mResult = false; $iUID = $this->getMailManager()->getMessageUIDByMessageID($oAccount, $Folder, $UidFrom, $MessageID); if ($iUID !== false) { $aMessages = $this->GetMessagesBodies($AccountID, $Folder, [$iUID]); if (is_array($aMessages) && count($aMessages) > 0) { $mResult = $aMessages[0]; } } return $mResult; } /** * @api {post} ?/Api/ SetMessagesSeen * @apiName SetMessagesSeen * @apiGroup Mail * @apiDescription Puts on or off seen flag of message. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SetMessagesSeen} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uids** *string* List of messages' uids.
* **SetAction** *boolean* Indicates if flag should be set or removed.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SetMessagesSeen', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "Uids": "1243,1244,1245", "SetAction": false }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if seen flag was set successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SetMessagesSeen', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SetMessagesSeen', * Result: false, * ErrorCode: 102 * } */ /** * Puts on or off seen flag of message. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param string $Uids List of messages' uids. * @param boolean $SetAction Indicates if flag should be set or removed. * @return boolean */ public function SetMessagesSeen($AccountID, $Folder, $Uids, $SetAction) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->setMessageFlag($AccountID, $Folder, $Uids, $SetAction, \MailSo\Imap\Enumerations\MessageFlag::SEEN); } /** * @api {post} ?/Api/ SetMessageFlagged * @apiName SetMessageFlagged * @apiGroup Mail * @apiDescription Puts on or off flagged flag of message. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SetMessageFlagged} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uids** *string* List of messages' uids.
* **SetAction** *boolean* Indicates if flag should be set or removed.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SetMessageFlagged', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "Uids": "1243,1244,1245", "SetAction": false }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if flagged flag was set successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SetMessageFlagged', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SetMessageFlagged', * Result: false, * ErrorCode: 102 * } */ /** * Puts on or off flagged flag of message. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param string $Uids List of messages' uids. * @param boolean $SetAction Indicates if flag should be set or removed. * @return boolean */ public function SetMessageFlagged($AccountID, $Folder, $Uids, $SetAction) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->setMessageFlag($AccountID, $Folder, $Uids, $SetAction, \MailSo\Imap\Enumerations\MessageFlag::FLAGGED); } /** * @api {post} ?/Api/ SetAllMessagesSeen * @apiName SetAllMessagesSeen * @apiGroup Mail * @apiDescription Puts on seen flag for all messages in folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SetAllMessagesSeen} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SetAllMessagesSeen', * Parameters: '{ "AccountID": 12, "Folder": "Inbox" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if seen flag was set successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SetAllMessagesSeen', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SetAllMessagesSeen', * Result: false, * ErrorCode: 102 * } */ /** * Puts on seen flag for all messages in folder. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SetAllMessagesSeen($AccountID, $Folder) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(\trim($Folder))) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getMailManager()->setMessageFlag( $oAccount, $Folder, array(), \MailSo\Imap\Enumerations\MessageFlag::SEEN, \Aurora\Modules\Mail\Enums\MessageStoreAction::Add, true ); } /** * @api {post} ?/Api/ MoveMessages * @apiName MoveMessages * @apiGroup Mail * @apiDescription Moves messages from one folder to another. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=MoveMessages} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Full name of the folder messages will be moved from.
* **ToFolder** *string* Full name of the folder messages will be moved to.
* **Uids** *string* Uids of messages to move.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'MoveMessages', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "ToFolder": "Trash", "Uids": "1212,1213,1215" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if messages were moved successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'MoveMessages', * Result: true * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'MoveMessages', * Result: false, * ErrorCode: 102 * } */ /** * Moves messages from one folder to another. * @param int $AccountID Account identifier. * @param string $Folder Full name of the folder messages will be moved from. * @param string $ToFolder Full name of the folder which messages will be moved to. * @param string $Uids Uids of messages to move. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function CopyMessages($AccountID, $Folder, $ToFolder, $Uids) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $aUids = \Aurora\System\Utils::ExplodeIntUids((string) $Uids); if (0 === \strlen(\trim($Folder)) || 0 === \strlen(\trim($ToFolder)) || !\is_array($aUids) || 0 === \count($aUids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); try { $this->getMailManager()->copyMessage($oAccount, $Folder, $ToFolder, $aUids); } catch (\MailSo\Imap\Exceptions\NegativeResponseException $oException) { $oResponse = /* @var $oResponse \MailSo\Imap\Response */ $oException->GetLastResponse(); throw new \Aurora\Modules\Mail\Exceptions\Exception( Enums\ErrorCodes::CannotMoveMessageQuota, $oException, $oResponse instanceof \MailSo\Imap\Response ? $oResponse->Tag . ' ' . $oResponse->StatusOrIndex . ' ' . $oResponse->HumanReadable : '' ); } catch (\Exception $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception( Enums\ErrorCodes::CannotMoveMessage, $oException, $oException->getMessage() ); } return true; } /** * @api {post} ?/Api/ MoveMessages * @apiName MoveMessages * @apiGroup Mail * @apiDescription Moves messages from one folder to another. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=MoveMessages} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Full name of the folder messages will be moved from.
* **ToFolder** *string* Full name of the folder messages will be moved to.
* **Uids** *string* Uids of messages to move.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'MoveMessages', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "ToFolder": "Trash", "Uids": "1212,1213,1215" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if messages were moved successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'MoveMessages', * Result: true * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'MoveMessages', * Result: false, * ErrorCode: 102 * } */ /** * Moves messages from one folder to another. * @param int $AccountID Account identifier. * @param string $Folder Full name of the folder messages will be moved from. * @param string $ToFolder Full name of the folder which messages will be moved to. * @param string $Uids Uids of messages to move. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function MoveMessages($AccountID, $Folder, $ToFolder, $Uids) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $aUids = \Aurora\System\Utils::ExplodeIntUids((string) $Uids); if (0 === \strlen(\trim($Folder)) || 0 === \strlen(\trim($ToFolder)) || !\is_array($aUids) || 0 === \count($aUids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); try { $this->getMailManager()->moveMessage($oAccount, $Folder, $ToFolder, $aUids); } catch (\MailSo\Imap\Exceptions\NegativeResponseException $oException) { $oResponse = /* @var $oResponse \MailSo\Imap\Response */ $oException->GetLastResponse(); throw new \Aurora\Modules\Mail\Exceptions\Exception( Enums\ErrorCodes::CannotMoveMessageQuota, $oException, $oResponse instanceof \MailSo\Imap\Response ? $oResponse->Tag . ' ' . $oResponse->StatusOrIndex . ' ' . $oResponse->HumanReadable : '' ); } catch (\Exception $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception( Enums\ErrorCodes::CannotMoveMessage, $oException, $oException->getMessage() ); } return true; } /** * @api {post} ?/Api/ DeleteMessages * @apiName DeleteMessages * @apiGroup Mail * @apiDescription Deletes messages from folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=DeleteMessages} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uids** *string* Uids of messages to delete.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'DeleteMessages', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "Uids": "1212,1213,1215" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if messages were deleted successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'DeleteMessages', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'DeleteMessages', * Result: false, * ErrorCode: 102 * } */ /** * Deletes messages from folder. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param string $Uids Uids of messages to delete. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function DeleteMessages($AccountID, $Folder, $Uids) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $aUids = \Aurora\System\Utils::ExplodeIntUids((string) $Uids); if (0 === \strlen(\trim($Folder)) || !\is_array($aUids) || 0 === \count($aUids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $this->getMailManager()->deleteMessage($oAccount, $Folder, $aUids); return true; } /** * @api {post} ?/Api/ CreateFolder * @apiName CreateFolder * @apiGroup Mail * @apiDescription Creates folder in mail account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=CreateFolder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **FolderNameInUtf8** *string* Name of folder to create.
* **FolderParentFullNameRaw** *string* Full name of parent folder.
* **Delimiter** *string* Delimiter that is used if full folder name.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'CreateFolder', * Parameters: '{ "AccountID": 12, "FolderNameInUtf8": "new_folder", * "FolderParentFullNameRaw": "parent_folder", "Delimiter": "/" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if folder was created successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'CreateFolder', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'CreateFolder', * Result: false, * ErrorCode: 102 * } */ /** * Creates folder in mail account. * @param int $AccountID Account identifier. * @param string $FolderNameInUtf8 Name of folder to create. * @param string $FolderParentFullNameRaw Full name of parent folder. * @param string $Delimiter Delimiter that is used if full folder name. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function CreateFolder($AccountID, $FolderNameInUtf8, $FolderParentFullNameRaw, $Delimiter) { $bResult = true; \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen($FolderNameInUtf8) || 1 !== \strlen($Delimiter)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); try { $this->getMailManager()->createFolder($oAccount, $FolderNameInUtf8, $Delimiter, $FolderParentFullNameRaw); } catch (\MailSo\Mail\Exceptions\AlreadyExistsFolder $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception( Enums\ErrorCodes::FolderAlreadyExists, $oException, $oException->getMessage() ); } $aFoldersOrderList = $this->getMailManager()->getFoldersOrder($oAccount); if (\is_array($aFoldersOrderList) && 0 < \count($aFoldersOrderList)) { $aFoldersOrderListNew = $aFoldersOrderList; $sFolderNameInUtf7Imap = \MailSo\Base\Utils::ConvertEncoding( $FolderNameInUtf8, \MailSo\Base\Enumerations\Charset::UTF_8, \MailSo\Base\Enumerations\Charset::UTF_7_IMAP ); $sFolderFullNameRaw = (0 < \strlen($FolderParentFullNameRaw) ? $FolderParentFullNameRaw . $Delimiter : '') . $sFolderNameInUtf7Imap; $sFolderFullNameUtf8 = \MailSo\Base\Utils::ConvertEncoding( $sFolderFullNameRaw, \MailSo\Base\Enumerations\Charset::UTF_7_IMAP, \MailSo\Base\Enumerations\Charset::UTF_8 ); $aFoldersOrderListNew[] = $sFolderFullNameRaw; $aFoldersOrderListUtf8 = \array_map(function ($sValue) { return \MailSo\Base\Utils::ConvertEncoding( $sValue, \MailSo\Base\Enumerations\Charset::UTF_7_IMAP, \MailSo\Base\Enumerations\Charset::UTF_8 ); }, $aFoldersOrderListNew); \usort($aFoldersOrderListUtf8, 'strnatcasecmp'); $iKey = \array_search($sFolderFullNameUtf8, $aFoldersOrderListUtf8, true); if (\is_int($iKey) && 0 < $iKey && isset($aFoldersOrderListUtf8[$iKey - 1])) { $sUpperName = $aFoldersOrderListUtf8[$iKey - 1]; $iUpperKey = \array_search(\MailSo\Base\Utils::ConvertEncoding( $sUpperName, \MailSo\Base\Enumerations\Charset::UTF_8, \MailSo\Base\Enumerations\Charset::UTF_7_IMAP ), $aFoldersOrderList, true); if (\is_int($iUpperKey) && isset($aFoldersOrderList[$iUpperKey])) { \Aurora\System\Api::Log('insert order index:' . $iUpperKey); \array_splice($aFoldersOrderList, $iUpperKey + 1, 0, $sFolderFullNameRaw); $this->getMailManager()->updateFoldersOrder($oAccount, $aFoldersOrderList); } } } return $bResult; } /** * @api {post} ?/Api/ RenameFolder * @apiName RenameFolder * @apiGroup Mail * @apiDescription Renames folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=RenameFolder} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **PrevFolderFullNameRaw** *int* Full name of folder to rename.
* **NewFolderNameInUtf8** *int* New folder name.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'RenameFolder', * Parameters: '{ "AccountID": 12, "PrevFolderFullNameRaw": "old_folder_name", * "NewFolderNameInUtf8": "new_folder_name" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result New folder name information in case of success, otherwise **false**. * @apiSuccess {string} Result.Result.FullName New full name of folder. * @apiSuccess {string} Result.Result.FullNameHash Hash of new full name of folder. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'RenameFolder', * Result: { "FullName": "new_folder_name", "FullNameHash": "hash_value" } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'RenameFolder', * Result: false, * ErrorCode: 102 * } */ /** * Renames folder. * @param int $AccountID Account identifier. * @param string $PrevFolderFullNameRaw Full name of folder to rename. * @param string $NewFolderNameInUtf8 New folder name. * @return array | boolean * @throws \Aurora\System\Exceptions\ApiException */ public function RenameFolder($AccountID, $PrevFolderFullNameRaw, $NewFolderNameInUtf8, $ChangeParent, $NewParentFolder) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen($PrevFolderFullNameRaw) || 0 === \strlen($NewFolderNameInUtf8)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $mResult = $this->getMailManager()->renameFolder($oAccount, $PrevFolderFullNameRaw, $NewFolderNameInUtf8, $ChangeParent, $NewParentFolder); return (0 < \strlen($mResult) ? array( 'FullName' => $mResult, 'FullNameHash' => \md5($mResult) ) : false); } /** * @api {post} ?/Api/ DeleteFolder * @apiName DeleteFolder * @apiGroup Mail * @apiDescription Deletes folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=DeleteFolder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Full name of folder to delete.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'DeleteFolder', * Parameters: '{ "AccountID": 12, "Folder": "folder2" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if folder was deleted successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'DeleteFolder', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'DeleteFolder', * Result: false, * ErrorCode: 102 * } */ /** * Deletes folder. * @param int $AccountID Account identifier. * @param string $Folder Full name of folder to delete. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function DeleteFolder($AccountID, $Folder) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(\trim($Folder))) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $this->getMailManager()->deleteFolder($oAccount, $Folder); return true; } /** * @api {post} ?/Api/ SubscribeFolder * @apiName SubscribeFolder * @apiGroup Mail * @apiDescription Subscribes/unsubscribes folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SubscribeFolder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Full name of folder to subscribe/unsubscribe.
* **SetAction** *boolean* Indicates if folder should be subscribed or unsubscribed.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SubscribeFolder', * Parameters: '{ "AccountID": 12, "Folder": "folder2", "SetAction": true }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if folder was subscribed/unsubscribed successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SubscribeFolder', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SubscribeFolder', * Result: false, * ErrorCode: 102 * } */ /** * Subscribes/unsubscribes folder. * @param int $AccountID Account identifier. * @param string $Folder Full name of folder to subscribe/unsubscribe. * @param boolean $SetAction Indicates if folder should be subscribed or unsubscribed. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SubscribeFolder($AccountID, $Folder, $SetAction) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if ($this->oModuleSettings->IgnoreImapSubscription) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } if (0 === \strlen(\trim($Folder))) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $this->getMailManager()->subscribeFolder($oAccount, $Folder, $SetAction); return true; } /** * @api {post} ?/Api/ UpdateFoldersOrder * @apiName UpdateFoldersOrder * @apiGroup Mail * @apiDescription Updates order of folders. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateFoldersOrder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **FolderList** *array* List of folders with new order.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateFoldersOrder', * Parameters: '{ "AccountID": 12, "FolderList": [ "INBOX", "Sent", "Drafts", "Trash", "Spam", "folder1" ] }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if folders' order was changed successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateFoldersOrder', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateFoldersOrder', * Result: false, * ErrorCode: 102 * } */ /** * Updates order of folders. * @param int $AccountID Account identifier. * @param array $FolderList List of folders with new order. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function UpdateFoldersOrder($AccountID, $FolderList) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (!\is_array($FolderList)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getMailManager()->updateFoldersOrder($oAccount, $FolderList); } /** * @api {post} ?/Api/ ClearFolder * @apiName ClearFolder * @apiGroup Mail * @apiDescription Removes all messages from folder. Method is used for Trash and Spam folders. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=ClearFolder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'ClearFolder', * Parameters: '{ "AccountID": 12, "Folder": "Trash" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if folder was cleared successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'ClearFolder', * Result: true * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'ClearFolder', * Result: false, * ErrorCode: 102 * } */ /** * Removes all messages from folder. Method is used for Trash and Spam folders. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function ClearFolder($AccountID, $Folder) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(\trim($Folder))) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $this->getMailManager()->clearFolder($oAccount, $Folder); return true; } /** * @api {post} ?/Api/ GetMessagesByUids * @apiName GetMessagesByUids * @apiGroup Mail * @apiDescription Obtains message list for specified messages' uids. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetMessagesByUids} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uids** *array* Uids of messages to obtain.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetMessagesByUids', * Parameters: '{ "AccountID": 12, "Folder": "Inbox", "Uids": [ "1221", "1222", "1226" ] }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Messages data in case of success, otherwise **false**. * @apiSuccess {int} Result.Result.Count Count of messages. * @apiSuccess {object[]} Result.Result.Collection List of messages * @apiSuccess {string} Result.Result.Collection.Folder Full name of folder that contains the message. * @apiSuccess {int} Result.Result.Collection.Uid Message uid. * @apiSuccess {string} Result.Result.Collection.Subject Message subject. * @apiSuccess {string} Result.Result.Collection.MessageId Message string identifier that is retrieved from message headers. * @apiSuccess {int} Result.Result.Collection.Size Message size. * @apiSuccess {int} Result.Result.Collection.TextSize Message text size. * @apiSuccess {int} Result.Result.Collection.InternalTimeStampInUTC Timestamp of message receiving date. * @apiSuccess {int} Result.Result.Collection.ReceivedOrDateTimeStampInUTC Timestamp of date that is retrieved from message. * @apiSuccess {int} Result.Result.Collection.TimeStampInUTC InternalTimeStampInUTC or ReceivedOrDateTimeStampInUTC depending on UseDateFromHeaders setting. * @apiSuccess {object} Result.Result.Collection.From Collection of sender addresses. Usually contains one address. * @apiSuccess {object} Result.Result.Collection.To Collection of recipient addresses. * @apiSuccess {object} Result.Result.Collection.Cc Collection of recipient addresses which receive copies of message. * @apiSuccess {object} Result.Result.Collection.Bcc Collection of recipient addresses which receive hidden copies of message. * @apiSuccess {object} Result.Result.Collection.ReplyTo Collection of address which is used for message reply. * @apiSuccess {boolean} Result.Result.Collection.IsSeen Indicates if message is seen. * @apiSuccess {boolean} Result.Result.Collection.IsFlagged Indicates if message is flagged. * @apiSuccess {boolean} Result.Result.Collection.IsAnswered Indicates if message is answered. * @apiSuccess {boolean} Result.Result.Collection.IsForwarded Indicates if message is forwarded. * @apiSuccess {boolean} Result.Result.Collection.HasAttachments Indicates if message has attachments. * @apiSuccess {boolean} Result.Result.Collection.HasVcardAttachment Indicates if message has attachment with VCARD. * @apiSuccess {boolean} Result.Result.Collection.HasIcalAttachment Indicates if message has attachment with ICAL. * @apiSuccess {int} Result.Result.Collection.Importance Importance value of the message, from 1 (highest) to 5 (lowest). * @apiSuccess {array} Result.Result.Collection.DraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @apiSuccess {int} Result.Result.Collection.Sensitivity If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @apiSuccess {string} Result.Result.Collection.DownloadAsEmlUrl Url for download message as .eml file. * @apiSuccess {string} Result.Result.Collection.Hash Message hash. * @apiSuccess {array} Result.Result.Collection.Threads List of uids of messages that are belonged to one thread. * @apiSuccess {array} Result.Result.Uids List determines order of messages. * @apiSuccess {string} Result.Result.UidNext Last value of folder UIDNEXT. * @apiSuccess {string} Result.Result.FolderHash Folder hash is used to determine if there were changes in folder. * @apiSuccess {int} Result.Result.MessageCount Total count of messages in folder. * @apiSuccess {int} Result.Result.MessageUnseenCount Count of unread messages in folder. * @apiSuccess {int} Result.Result.MessageResultCount Count of messages in obtained list. * @apiSuccess {string} Result.Result.FolderName Full name of folder. * @apiSuccess {int} Result.Result.Offset Says to skip that many messages before beginning to return them. * @apiSuccess {int} Result.Result.Limit Limit says to return that many messages in the list. * @apiSuccess {string} Result.Result.Search Search string. * @apiSuccess {string} Result.Result.Filters List of conditions to obtain messages. * @apiSuccess {array} Result.Result.New List of short information about new messages. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetMessagesByUids', * Result: { * "@Count": 30,"@Collection": [ * { "Folder": "INBOX", "Uid": 1689, "Subject": "subject_value", "MessageId": "string_id", * "Size": 2947, "TextSize": 321, "InternalTimeStampInUTC": 1493290584, * "ReceivedOrDateTimeStampInUTC": 1493290584, "TimeStampInUTC": 1493290584, * "From": {"@Count": 1, "@Collection": [ { "DisplayName": "","Email": "test@email" } ] }, * "To": {"@Count": 1, "@Collection": [ { "DisplayName": "", "Email": "test2@email" } ] }, * "Cc": null, "Bcc": null, * "ReplyTo": { "@Count": 1, "@Collection": [ { "DisplayName": "Afterlogic", "Email":"test@email" } ] }, * "IsSeen": true, "IsFlagged": false, "IsAnswered": false, "IsForwarded": false, * "HasAttachments": false, "HasVcardAttachment": false, "HasIcalAttachment": false, "Importance": 3, * "DraftInfo": null, "Sensitivity": 0, "DownloadAsEmlUrl": "url_value", * "Hash": "hash_value", "Threads": [] }, * ... ], * "Uids": [1689,1667,1666,1651,1649,1648,1647,1646,1639,1638], * "UidNext": "1690", "FolderHash": "97b2a280e7b9f2cbf86857e5cacf63b7", "MessageCount": 638, * "MessageUnseenCount": 0, "MessageResultCount": 601, "FolderName": "INBOX", "Offset": 0, * "Limit": 30, "Search": "", "Filters": "", "New": [] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetMessagesByUids', * Result: false, * ErrorCode: 102 * } */ /** * Obtains message list for specified messages' uids. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param array $Uids Uids of messages to obtain. * @return array * @throws \Aurora\System\Exceptions\ApiException */ public function GetMessagesByUids($AccountID, $Folder, $Uids) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(trim($Folder)) || !\is_array($Uids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getMailManager()->getMessageListByUids($oAccount, $Folder, $Uids); } /** * @api {post} ?/Api/ GetMessagesFlags * @apiName GetMessagesFlags * @apiGroup Mail * @apiDescription Obtains infomation about flagged flags for specified messages. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetMessagesFlags} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* **Uids** *array* Uids of messages.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetMessagesFlags' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result List of flags for every message uid in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetMessagesFlags', * Result: { "1649": ["\flagged", "\seen"], "1666": ["\flagged", "\seen"] } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetMessagesFlags', * Result: false, * ErrorCode: 102 * } */ /** * Obtains infomation about flagged flags for specified messages. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param array $Uids Uids of messages. * @return array * @throws \Aurora\System\Exceptions\ApiException */ public function GetMessagesFlags($AccountID, $Folder, $Uids) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(\trim($Folder)) || !\is_array($Uids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getMailManager()->getMessagesFlags($oAccount, $Folder, $Uids); } /** * @api {post} ?/Api/ SaveMessage * @apiName SaveMessage * @apiGroup Mail * @apiDescription Saves message to Drafts folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SaveMessage} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **FetcherID** *int* Fetcher identifier.
* **AliasID** *int* Alias identifier.
* **IdentityID** *int* Identity identifier.
* **DraftInfo** *array* Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder.
* **DraftUid** *string* Uid of message to save in Drafts folder.
* **To** *string* Message recipients.
* **Cc** *string* Recipients which will get a copy of the message.
* **Bcc** *string* Recipients which will get a hidden copy of the message.
* **Subject** *string* Subject of the message.
* **Text** *string* Text of the message.
* **IsHtml** *boolean* Indicates if text of the message is HTML or plain.
* **Importance** *int* Importance of the message - LOW = 5, NORMAL = 3, HIGH = 1.
* **SendReadingConfirmation** *boolean* Indicates if it is necessary to include header that says.
* **Attachments** *array* List of attachments.
* **InReplyTo** *string* Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads.
* **References** *string* Content of References header block of the message.
* **Sensitivity** *int* Sensitivity header for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal".
* **DraftFolder** *string* Full name of Drafts folder.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SaveMessage', * Parameters: '{ "AccountID": 12, "FetcherID": 0, "AliasID": 0, "IdentityID": 14, "DraftInfo": [], "DraftUid": "", * "To": "test@email", "Cc": "", "Bcc": "", "Subject": "", "Text": "text_value", "IsHtml": true, * "Importance": 3, "SendReadingConfirmation": false, "Attachments": [], "InReplyTo": "", "References": "", * "Sensitivity": 0, "DraftFolder": "Drafts" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if message was saved successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SaveMessage', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SaveMessage', * Result: false, * ErrorCode: 102 * } */ /** * Saves message to Drafts folder. * @param int $AccountID Account identifier. * @param int $Fetcher Fetcher object is filled in by subscription. Webclient sends FetcherID parameter. * @param int $Alias Alias object is filled in by subscription. Webclient sends AliasID parameter. * @param int $IdentityID Identity identifier. * @param array $DraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @param string $DraftUid Uid of message to save in Drafts folder. * @param string $To Message recipients. * @param string $Cc Recipients which will get a copy of the message. * @param string $Bcc Recipients which will get a hidden copy of the message. * @param string $Subject Subject of the message. * @param string $Text Text of the message. * @param boolean $IsHtml Indicates if text of the message is HTML or plain. * @param int $Importance Importance of the message - LOW = 5, NORMAL = 3, HIGH = 1. * @param boolean $SendReadingConfirmation Indicates if it is necessary to include header that says * @param array $Attachments List of attachments. * @param string $InReplyTo Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads. * @param string $References Content of References header block of the message. * @param int $Sensitivity Sensitivity header for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @param string $DraftFolder Full name of Drafts folder. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SaveMessage( $AccountID, $Fetcher = null, $Alias = null, $IdentityID = 0, $DraftInfo = [], $DraftUid = "", $To = "", $Cc = "", $Bcc = "", $Subject = "", $Text = "", $IsHtml = false, $Importance = \MailSo\Mime\Enumerations\MessagePriority::NORMAL, $SendReadingConfirmation = false, $Attachments = array(), $InReplyTo = "", $References = "", $Sensitivity = \MailSo\Mime\Enumerations\Sensitivity::NOTHING, $DraftFolder = "" ) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if (0 === \strlen($DraftFolder)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oIdentity = $IdentityID !== 0 ? $this->getIdentitiesManager()->getIdentity($IdentityID, $AccountID) : null; $oMessage = self::Decorator()->BuildMessage( $oAccount, $To, $Cc, $Bcc, $Subject, $IsHtml, $Text, $Attachments, $DraftInfo, $InReplyTo, $References, $Importance, $Sensitivity, $SendReadingConfirmation, $Fetcher, $Alias, true, $oIdentity ); if ($oMessage) { try { $mResult = $this->getMailManager()->saveMessage($oAccount, $oMessage, $DraftFolder, $DraftUid); } catch (\Aurora\System\Exceptions\ManagerException $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::CannotSaveMessage, $oException, $oException->getMessage()); } } return $mResult; } /** * @api {post} ?/Api/ SendMessage * @apiName SendMessage * @apiGroup Mail * @apiDescription Sends message. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SendMessage} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **FetcherID** *int* Fetcher identifier.
* **AliasID** *int* Alias identifier.
* **IdentityID** *int* Identity identifier.
* **DraftInfo** *array* Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder.
* **DraftUid** *string* Uid of message to save in Drafts folder.
* **To** *string* Message recipients.
* **Cc** *string* Recipients which will get a copy of the message.
* **Bcc** *string* Recipients which will get a hidden copy of the message.
* **Subject** *string* Subject of the message.
* **Text** *string* Text of the message.
* **IsHtml** *boolean* Indicates if text of the message is HTML or plain.
* **Importance** *int* Importance of the message - LOW = 5, NORMAL = 3, HIGH = 1.
* **SendReadingConfirmation** *boolean* Indicates if it is necessary to include header that says.
* **Attachments** *array* List of attachments.
* **InReplyTo** *string* Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads.
* **References** *string* Content of References header block of the message.
* **Sensitivity** *int* Sensitivity header for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal".
* **SentFolder** *string* Full name of Sent folder.
* **DraftFolder** *string* Full name of Drafts folder.
* **ConfirmFolder** *string* Full name of folder that contains a message that should be marked as confirmed read.
* **ConfirmUid** *string* Uid of message that should be marked as confirmed read.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SendMessage', * Parameters: '{ "AccountID": 12, "FetcherID": 0, "AliasID": 0, "IdentityID": 14, "DraftInfo": [], "DraftUid": "", * "To": "test@email", "Cc": "", "Bcc": "", "Subject": "", "Text": "text_value", "IsHtml": true, * "Importance": 3, "SendReadingConfirmation": false, "Attachments": [], "InReplyTo": "", "References": "", * "Sensitivity": 0, "SentFolder": "Sent", "DraftFolder": "Drafts", "ConfirmFolder": "", "ConfirmUid": "" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if message was sent successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SendMessage', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SendMessage', * Result: false, * ErrorCode: 102 * } */ /** * Sends message. * @param int $AccountID Account identifier. * @param int $Fetcher Fetcher object is filled in by subscription. Webclient sends FetcherID parameter. * @param int $Alias Alias object is filled in by subscription. Webclient sends AliasID parameter. * @param int $IdentityID Identity identifier. * @param array $DraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @param string $DraftUid Uid of message to save in Drafts folder. * @param string $To Message recipients. * @param string $Cc Recipients which will get a copy of the message. * @param string $Bcc Recipients which will get a hidden copy of the message. * @param array $Recipients Recipients that will be used to send messages through the SMTP. Use this parameter if you want real recipients to differ from those specified in the message body (To, CC, BCC). * @param string $Subject Subject of the message. * @param string $Text Text of the message. * @param boolean $IsHtml Indicates if text of the message is HTML or plain. * @param int $Importance Importance of the message - LOW = 5, NORMAL = 3, HIGH = 1. * @param boolean $SendReadingConfirmation Indicates if it is necessary to include header that says * @param array $Attachments List of attachments. * @param string $InReplyTo Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads. * @param string $References Content of References header block of the message. * @param int $Sensitivity Sensitivity header for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @param string $SentFolder Full name of Sent folder. * @param string $DraftFolder Full name of Drafts folder. * @param string $ConfirmFolder Full name of folder that contains a message that should be marked as confirmed read. * @param string $ConfirmUid Uid of message that should be marked as confirmed read. * @param array $CustomHeaders list of custom headers * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SendMessage( $AccountID, $Fetcher = null, $Alias = null, $IdentityID = 0, $DraftInfo = [], $DraftUid = "", $To = "", $Cc = "", $Bcc = "", $Recipients = array(), $Subject = "", $Text = "", $IsHtml = false, $Importance = \MailSo\Mime\Enumerations\MessagePriority::NORMAL, $SendReadingConfirmation = false, $Attachments = array(), $InReplyTo = "", $References = "", $Sensitivity = \MailSo\Mime\Enumerations\Sensitivity::NOTHING, $SentFolder = "", $DraftFolder = "", $ConfirmFolder = "", $ConfirmUid = "", $CustomHeaders = [] ) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $oIdentity = $IdentityID !== 0 ? $this->getIdentitiesManager()->getIdentity($IdentityID, $AccountID) : null; $oMessage = self::Decorator()->BuildMessage( $oAccount, $To, $Cc, $Bcc, $Subject, $IsHtml, $Text, $Attachments, $DraftInfo, $InReplyTo, $References, $Importance, $Sensitivity, $SendReadingConfirmation, $Fetcher, $Alias, false, $oIdentity, $CustomHeaders ); if ($oMessage) { $mResult = $this->getMailManager()->sendMessage($oAccount, $oMessage, $Fetcher, $oIdentity, $SentFolder, $DraftFolder, $DraftUid, $Recipients); if ($mResult) { $aCollection = $oMessage->GetRcpt(); $aEmails = array(); $aCollection->ForeachList(function ($oEmail) use (&$aEmails) { $aEmails[strtolower($oEmail->GetEmail(true))] = trim($oEmail->GetDisplayName()); }); if (\is_array($aEmails)) { $aArgs = ['IdUser' => $oAccount->IdUser, 'Emails' => $aEmails]; $this->broadcastEvent('AfterUseEmails', $aArgs); } } if (\is_array($DraftInfo) && 3 === \count($DraftInfo)) { $sDraftInfoType = $DraftInfo[0]; $sDraftInfoUid = $DraftInfo[1]; $sDraftInfoFolder = $DraftInfo[2]; try { switch (\strtolower($sDraftInfoType)) { case 'reply': case 'reply-all': $this->getMailManager()->setMessageFlag( $oAccount, $sDraftInfoFolder, array($sDraftInfoUid), \MailSo\Imap\Enumerations\MessageFlag::ANSWERED, \Aurora\Modules\Mail\Enums\MessageStoreAction::Add ); break; case 'forward': $this->getMailManager()->setMessageFlag( $oAccount, $sDraftInfoFolder, array($sDraftInfoUid), '$Forwarded', \Aurora\Modules\Mail\Enums\MessageStoreAction::Add ); break; } } catch (\Exception $oException) { } } if (0 < \strlen($ConfirmFolder) && 0 < \strlen($ConfirmUid)) { try { $mResult = $this->getMailManager()->setMessageFlag( $oAccount, $ConfirmFolder, array($ConfirmUid), '$ReadConfirm', \Aurora\Modules\Mail\Enums\MessageStoreAction::Add, false, true ); } catch (\Exception $oException) { } } } \Aurora\System\Api::LogEvent('message-send: ' . $oAccount->Email, self::GetName()); return $mResult; } /** * @api {post} ?/Api/ SetupSystemFolders * @apiName SetupSystemFolders * @apiGroup Mail * @apiDescription Sets up new values of special folders. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SetupSystemFolders} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Sent** *string* New value of Sent folder full name.
* **Drafts** *string* New value of Drafts folder full name.
* **Trash** *string* New value of Trash folder full name.
* **Spam** *string* New value of Spam folder full name.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SetupSystemFolders', * Parameters: '{ "AccountID": 12, "Sent": "Sent", "Drafts": "Drafts", "Trash": "Trash", "Spam": "Spam" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if system folders were set up successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SetupSystemFolders', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SetupSystemFolders', * Result: false, * ErrorCode: 102 * } */ /** * Sets up new values of special folders. * @param int $AccountID Account identifier. * @param string $Sent New value of Sent folder full name. * @param string $Drafts New value of Drafts folder full name. * @param string $Trash New value of Trash folder full name. * @param string $Spam New value of Spam folder full name. * @return boolean */ public function SetupSystemFolders($AccountID, $Sent, $Drafts, $Trash, $Spam) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $aSystemNames = [ \Aurora\Modules\Mail\Enums\FolderType::Sent => \trim($Sent), \Aurora\Modules\Mail\Enums\FolderType::Drafts => \trim($Drafts), \Aurora\Modules\Mail\Enums\FolderType::Trash => \trim($Trash), \Aurora\Modules\Mail\Enums\FolderType::Spam => \trim($Spam) ]; return $this->getMailManager()->updateSystemFolderNames($oAccount, $aSystemNames); } /** * @param int $AccountID Account identifier. * @param string $FolderFullName folder full name. * @param bool $AlwaysRefresh * @return boolean */ public function SetAlwaysRefreshFolder($AccountID, $FolderFullName, $AlwaysRefresh) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getMailManager()->setAlwaysRefreshFolder($oAccount, $FolderFullName, $AlwaysRefresh); } /** * Marks (or unmarks) folder as template folder. * @param int $AccountID Account identifier. * @param string $FolderFullName Full name of folder that should be marked/unmarked as template. * @param boolean $SetTemplate Indicates if template should be set or unset. * @return boolean */ public function SetTemplateFolderType($AccountID, $FolderFullName, $SetTemplate) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if ($this->oModuleSettings->AllowTemplateFolders) { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getMailManager()->setSystemFolder($oAccount, $FolderFullName, \Aurora\Modules\Mail\Enums\FolderType::Template, $SetTemplate); } return false; } /** * @api {post} ?/Api/ SetEmailSafety * @apiName SetEmailSafety * @apiGroup Mail * @apiDescription Marks sender email as safety for authenticated user. So pictures in messages from this sender will be always displayed. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SetEmailSafety} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Email** *string* Sender email.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SetEmailSafety', * Parameters: '{ "AccountID": 12, "Email": "test@email" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if email was marked as safety successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SetEmailSafety', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SetEmailSafety', * Result: false, * ErrorCode: 102 * } */ /** * Marks sender email as safety for authenticated user. So pictures in messages from this sender will be always displayed. * @param int $AccountID Account identifier. * @param string $Email Sender email. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SetEmailSafety($AccountID, $Email) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if (0 === \strlen(\trim($Email))) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $this->getMailManager()->setSafetySender($oAccount->IdUser, $Email); return true; } /** * @api {post} ?/Api/ CreateIdentity * @apiName CreateIdentity * @apiGroup Mail * @apiDescription Creates identity. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=CreateIdentity} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **UserId** *int* (optional) User identifier.
* **AccountID** *int* Account identifier.
* **FriendlyName** *string* Identity friendly name.
* **Email** *string* Identity email.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'CreateIdentity', * Parameters: '{ "AccountID": 12, "FriendlyName": "My name", "Email": "test@email" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Identifier of created identity in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'CreateIdentity', * Result: 14 * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'CreateIdentity', * Result: false, * ErrorCode: 102 * } */ /** * Creates identity. * @param int $UserId User identifier. * @param int $AccountID Account identifier. * @param string $FriendlyName Identity friendly name. * @param string $Email Identity email. * @return int|boolean */ public function CreateIdentity($UserId, $AccountID, $FriendlyName, $Email) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($this->oModuleSettings->OnlyUserEmailsInIdentities) { $Email = $oAccount->Email; } return $this->getIdentitiesManager()->createIdentity($UserId, $AccountID, $FriendlyName, $Email); } /** * @api {post} ?/Api/ UpdateIdentity * @apiName UpdateIdentity * @apiGroup Mail * @apiDescription Updates identity. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateIdentity} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **UserId** *int* (optional) User identifier.
* **AccountID** *int* Account identifier.
* **Id** *int* Identity identifier.
* **FriendlyName** *string* New value of identity friendly name.
* **Email** *string* New value of identity email.
* **Default** *boolean* Indicates if identity should be used by default.
* **AccountPart** *boolean* Indicated if account should be updated, not any identity.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateIdentity', * Parameters: '{ "AccountID": 12, "Id": 14, "FriendlyName": "New my name", "Email": "test@email", * "Default": false, "AccountPart": false }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if identity was updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateIdentity', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateIdentity', * Result: false, * ErrorCode: 102 * } */ /** * Updates identity. * @param int $UserId User identifier. * @param int $AccountID Account identifier. * @param int $EntityId Identity identifier. * @param string $FriendlyName New value of identity friendly name. * @param string $Email New value of identity email. * @param boolean $Default Indicates if identity should be used by default. * @return boolean */ public function UpdateIdentity($UserId, $AccountID, $EntityId, $FriendlyName, $Email, $Default = false) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if ($this->oModuleSettings->AllowIdentities) { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($Default) { $this->getIdentitiesManager()->resetDefaultIdentity($UserId, $AccountID); } if ($this->oModuleSettings->OnlyUserEmailsInIdentities) { $Email = $oAccount->Email; } if ($EntityId === null) { return !!$this->UpdateAccount($AccountID, null, $Email, $FriendlyName); } else { return $this->getIdentitiesManager()->updateIdentity($EntityId, $AccountID, $FriendlyName, $Email, $Default); } } else { return false; } } /** * @api {post} ?/Api/ DeleteIdentity * @apiName DeleteIdentity * @apiGroup Mail * @apiDescription Deletes identity. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=DeleteIdentity} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **Id** *int* Identity identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'DeleteIdentity', * Parameters: '{ "Id": 14 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if identity was deleted successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'DeleteIdentity', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'DeleteIdentity', * Result: false, * ErrorCode: 102 * } */ /** * Deletes identity. * @param int $EntityId Identity identifier. * @return boolean */ public function DeleteIdentity($AccountID, $EntityId) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); return $this->getIdentitiesManager()->deleteIdentity($EntityId, $AccountID); } /** * @api {post} ?/Api/ GetIdentities * @apiName GetIdentities * @apiGroup Mail * @apiDescription Obtaines all identities of specified user. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetServers} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **UserId** *int* (optional) User identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetIdentities' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result List identities in case of success, otherwise **false**. * @apiSuccess {int} Result.Result.Id Identity identifier. * @apiSuccess {int} Result.Result.UUID Identity UUID. * @apiSuccess {int} Result.Result.IdUser User identifier. * @apiSuccess {int} Result.Result.IdAccount Identifier of account owns identity. * @apiSuccess {int} Result.Result.Default Indicates if signature should be used as default on compose screen. * @apiSuccess {int} Result.Result.Email Identity email. * @apiSuccess {int} Result.Result.FriendlyName Identity friendly name. * @apiSuccess {boolean} Result.Result.UseSignature Indicates if signature should be used in outgoing mails. * @apiSuccess {string} Result.Result.Signature Identity signature. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetIdentities', * Result: [ { "Id": 14, "UUID": "uuid_value", "IdUser": 3, "IdAccount": 12, * "Default": false, "Email": "test@email", "FriendlyName": "My name", * "UseSignature": true, "Signature": "signature_value" }, * ... ] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetIdentities', * Result: false, * ErrorCode: 102 * } */ /** * Obtains all identities of specified user. * @param int $UserId User identifier. * @return array|false */ public function GetIdentities($UserId) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); \Aurora\System\Api::CheckAccess($UserId); return $this->getIdentitiesManager()->getIdentities($UserId)->all(); } /** * @api {post} ?/Api/ UpdateSignature * @apiName UpdateSignature * @apiGroup Mail * @apiDescription Updates signature. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateSignature} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **UseSignature** *boolean* Indicates if signature should be used in outgoing mails.
* **Signature** *string* Account or identity signature.
* **IdentityID** *int* (optional) Identity identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateSignature', * Parameters: '{ "AccountID": 12, "UseSignature": true, "Signature": "signature_value", "IdentityID": 14 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if signature was updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateSignature', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateSignature', * Result: false, * ErrorCode: 102 * } */ /** * Updates signature. * @param int $AccountID Account identifier. * @param boolean $UseSignature Indicates if signature should be used in outgoing mails. * @param string $Signature Account or identity signature. * @param int $IdentityId Identity identifier. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function UpdateSignature($AccountID, $UseSignature = null, $Signature = null, $IdentityId = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if ($AccountID > 0) { $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($Signature !== null) { $Signature = HtmlUtils::ClearHtml($Signature); } if ($this->oModuleSettings->AllowIdentities && $IdentityId !== null) { return $this->getIdentitiesManager()->updateIdentitySignature($IdentityId, $AccountID, $UseSignature, $Signature); } else { if ($oAccount) { if ($UseSignature !== null) { $oAccount->UseSignature = $UseSignature; } if ($Signature !== null) { $oAccount->Signature = $Signature; } return !!$this->getAccountsManager()->updateAccount($oAccount); } } } else { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } return false; } /** * @api {post} ?/Api/ UploadAttachment * @apiName UploadAttachment * @apiGroup Mail * @apiDescription Uploads attachment. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UploadAttachment} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **UserId** *int* (optional) User identifier.
* **AccountID** *int* Account identifier.
* } * @apiParam {string} UploadData Data of uploaded file. * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UploadAttachment', * Parameters: '{ "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Attachment properties in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UploadAttachment', * Result: { "Attachment": { "Name": "name.txt", "TempName": "temp_name_value", "MimeType": "text/plain", * "Size": 14, "Hash": "hash_value", "Actions": { "view": { "url": "url_value" }, * "download": { "url": "url_value" } }, "ThumbnailUrl": "" } } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UploadAttachment', * Result: false, * ErrorCode: 102 * } */ /** * Uploads attachment. * @param int $UserId User identifier. * @param int $AccountID Account identifier. * @param array $UploadData Information about uploaded file. * @return array */ public function UploadAttachment($UserId, $AccountID, $UploadData) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $sUUID = \Aurora\System\Api::getUserUUIDById($UserId); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); $sError = ''; $aResponse = array(); if ($oAccount instanceof \Aurora\Modules\Mail\Models\MailAccount) { if (\is_array($UploadData)) { $sSavedName = 'upload-post-' . \md5($UploadData['name'] . $UploadData['tmp_name']); $rData = false; if (\is_resource($UploadData['tmp_name'])) { $rData = $UploadData['tmp_name']; } else { if ($this->getFilecacheManager()->moveUploadedFile($sUUID, $sSavedName, $UploadData['tmp_name'])) { $rData = $this->getFilecacheManager()->getFile($sUUID, $sSavedName); } } if ($rData) { $sUploadName = $UploadData['name']; $iSize = $UploadData['size']; $aResponse['Attachment'] = \Aurora\System\Utils::GetClientFileResponse( null, $UserId, $sUploadName, $sSavedName, $iSize ); } else { $sError = 'unknown'; } } else { $sError = 'unknown'; } } else { $sError = 'auth'; } if (0 < strlen($sError)) { $aResponse['Error'] = $sError; } return $aResponse; } /** * @api {post} ?/Api/ SaveAttachmentsAsTempFiles * @apiName SaveAttachmentsAsTempFiles * @apiGroup Mail * @apiDescription Retrieves attachments from message and saves them as files in temporary folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SaveAttachmentsAsTempFiles} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Attachments** *array* List of attachments hashes.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SaveAttachmentsAsTempFiles', * Parameters: '{ "Attachments": [ "hash_value" ], "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Attachments' properties in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SaveAttachmentsAsTempFiles', * Result: { "temp_name_value": "hash_value" } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SaveAttachmentsAsTempFiles', * Result: false, * ErrorCode: 102 * } */ /** * Retrieves attachments from message and saves them as files in temporary folder. * @param int $AccountID Account identifier. * @param array $Attachments List of attachments hashes. * @return array|boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SaveAttachmentsAsTempFiles($AccountID, $Attachments = array()) { $mResult = false; $self = $this; \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($oAccount instanceof \Aurora\Modules\Mail\Models\MailAccount) { $sUUID = \Aurora\System\Api::getUserUUIDById($oAccount->IdUser); try { if (is_array($Attachments) && 0 < count($Attachments)) { $mResult = array(); foreach ($Attachments as $sAttachment) { $aValues = \Aurora\System\Api::DecodeKeyValues($sAttachment); if (is_array($aValues) && isset($aValues['AccountID']) && $aValues['AccountID'] === $AccountID) { $sFolder = isset($aValues['Folder']) ? $aValues['Folder'] : ''; $iUid = (int) isset($aValues['Uid']) ? $aValues['Uid'] : 0; $sMimeIndex = (string) isset($aValues['MimeIndex']) ? $aValues['MimeIndex'] : ''; $sTempName = md5($sAttachment); if (!$this->getFilecacheManager()->isFileExists($sUUID, $sTempName)) { $this->getMailManager()->directMessageToStream( $oAccount, function ($rResource, $sContentType, $sFileName, $sMimeIndex = '') use ($sUUID, &$mResult, $sTempName, $sAttachment, $self) { if (is_resource($rResource)) { $sContentType = (empty($sFileName)) ? 'text/plain' : \MailSo\Base\Utils::MimeContentType($sFileName); $sFileName = \Aurora\System\Utils::clearFileName($sFileName, $sContentType, $sMimeIndex); if ($self->getFilecacheManager()->putFile($sUUID, $sTempName, $rResource)) { $mResult[$sTempName] = $sAttachment; } } }, $sFolder, $iUid, $sMimeIndex ); } else { $mResult[$sTempName] = $sAttachment; } } else { Api::Log('Error: can\'t read attachment data from hash.'); } } } } catch (\Exception $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::CannotConnectToMailServer, $oException, $oException->getMessage()); } } return $mResult; } /** * @api {post} ?/Api/ SaveMessageAsTempFile * @apiName SaveMessageAsTempFile * @apiGroup Mail * @apiDescription Retrieves message and saves it as .eml file in temporary folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=SaveMessageAsTempFile} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **MessageFolder** *string* Full name of folder.
* **MessageUid** *string* Message uid.
* **FileName** *string* Name of created .eml file.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'SaveMessageAsTempFile', * Parameters: '{ "MessageFolder": "INBOX", "MessageUid": "1691", "FileName": "subject.eml", * "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result .eml attachment properties in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'SaveMessageAsTempFile', * Result: { "Name": "subject.eml", "FileName": "subject.eml", "TempName":"temp_name_value", * "MimeType": "message/rfc822", "Size": 1669, "Hash": "hash_value", * "Actions": { "view": { "url": "view_url" }, "download": { "url": "download_url" } }, * "ThumbnailUrl": "" } } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'SaveMessageAsTempFile', * Result: false, * ErrorCode: 102 * } */ /** * Retrieves message and saves it as .eml file in temporary folder. * @param int $AccountID Account identifier. * @param string $MessageFolder Full name of folder. * @param string $MessageUid Message uid. * @param string $FileName Name of created .eml file. * @return array|boolean * @throws \Aurora\System\Exceptions\ApiException */ public function SaveMessageAsTempFile($AccountID, $MessageFolder, $MessageUid, $FileName) { $mResult = false; $self = $this; \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oAccount = $this->getAccountsManager()->getAccountById($AccountID); self::checkAccountAccess($oAccount); if ($oAccount instanceof \Aurora\Modules\Mail\Models\MailAccount) { $sUUID = \Aurora\System\Api::getUserUUIDById($oAccount->IdUser); try { $sMimeType = 'message/rfc822'; $sTempName = md5($MessageFolder . $MessageUid); if (!$this->getFilecacheManager()->isFileExists($sUUID, $sTempName)) { $this->getMailManager()->directMessageToStream( $oAccount, function ($rResource, $sContentType, $sFileName) use ($sUUID, $sTempName, &$sMimeType, $self) { if (is_resource($rResource)) { $sMimeType = $sContentType; $sFileName = \Aurora\System\Utils::clearFileName($sFileName, $sMimeType, ''); $self->getFilecacheManager()->putFile($sUUID, $sTempName, $rResource); } }, $MessageFolder, $MessageUid ); } if ($this->getFilecacheManager()->isFileExists($sUUID, $sTempName)) { $iSize = $this->getFilecacheManager()->fileSize($sUUID, $sTempName); $mResult = \Aurora\System\Utils::GetClientFileResponse( null, $oAccount->IdUser, $FileName, $sTempName, $iSize ); } } catch (\Exception $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::CannotConnectToMailServer, $oException, $oException->getMessage()); } } return $mResult; } /** * @api {post} ?/Api/ UploadMessage * @apiName UploadMessage * @apiGroup Mail * @apiDescription Uploads message and puts it to specified folder. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UploadMessage} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Folder** *string* Folder full name.
* } * @apiParam {string} UploadData Information about uploaded .eml file. * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UploadMessage', * Parameters: '{ "AccountID": 12, "Folder": "INBOX" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if message was uploaded successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UploadMessage', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UploadMessage', * Result: false, * ErrorCode: 102 * } */ /** * Uploads message and puts it to specified folder. * @param int $AccountID Account identifier. * @param string $Folder Folder full name. * @param array $UploadData Information about uploaded .eml file. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ public function UploadMessage($AccountID, $Folder, $UploadData) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $bResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int)$AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $sUUID = \Aurora\System\Api::getUserUUIDById($oAccount->IdUser); if (is_array($UploadData)) { $sUploadName = $UploadData['name']; $bIsEmlExtension = strtolower(pathinfo($sUploadName, PATHINFO_EXTENSION)) === 'eml'; if ($bIsEmlExtension) { $sSavedName = 'upload-post-' . md5($UploadData['name'] . $UploadData['tmp_name']); if (is_resource($UploadData['tmp_name'])) { $this->getFilecacheManager()->putFile($sUUID, $sSavedName, $UploadData['tmp_name']); } else { $this->getFilecacheManager()->moveUploadedFile($sUUID, $sSavedName, $UploadData['tmp_name']); } if ($this->getFilecacheManager()->isFileExists($sUUID, $sSavedName)) { $sSavedFullName = $this->getFilecacheManager()->generateFullFilePath($sUUID, $sSavedName); try { $this->getMailManager()->appendMessageFromFile($oAccount, $sSavedFullName, $Folder); $bResult = true; } catch (\Exception $oException) { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::CannotUploadMessage, $oException, $oException->getMessage()); } } else { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::UnknownError); } } else { throw new \Aurora\Modules\Mail\Exceptions\Exception(Enums\ErrorCodes::CannotUploadMessageFileNotEml); } } } else { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } return $bResult; } /** * @api {post} ?/Api/ ChangePassword * @apiName ChangePassword * @apiGroup Mail * @apiDescription Changes account password. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=ChangePassword} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountId** *int* Account identifier.
* **CurrentPassword** *string* Current password.
* **NewPassword** *string* New password.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'ChangePassword', * Parameters: '{ "AccountId": 12, "CurrentPassword": "pass_value", "NewPassword": "new_pass_value" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if password was changed successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'ChangePassword', * Result: true * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'ChangePassword', * Result: false, * ErrorCode: 102 * } */ /** * This method will trigger some event, subscribers of which perform all change password process * * @param int $AccountId Account identifier. * @param string $CurrentPassword Current password. * @param string $NewPassword New password. * @return boolean */ public function ChangePassword($AccountId, $CurrentPassword, $NewPassword) { $mResult = false; $oAccount = null; if ($AccountId > 0) { $oAccount = $this->getAccountsManager()->getAccountById($AccountId); self::checkAccountAccess($oAccount); if ($oAccount instanceof Models\MailAccount) { $oUser = \Aurora\Modules\Core\Module::getInstance()->GetUser($oAccount->IdUser); if ($oAccount->getPassword() !== $CurrentPassword) { \Aurora\System\Api::LogEvent('password-change-failed: ' . $oAccount->Email, self::GetName()); throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccountOldPasswordNotCorrect); } $aArgs = [ 'Account' => $oAccount, 'CurrentPassword' => $CurrentPassword, 'NewPassword' => $NewPassword ]; $aResponse = [ 'AccountPasswordChanged' => false ]; $this->broadcastEvent( 'ChangeAccountPassword', $aArgs, $aResponse ); if ($aResponse['AccountPasswordChanged']) { $oAccount->setPassword($NewPassword); if ($this->getAccountsManager()->updateAccount($oAccount)) { $mResult = $oAccount; $mResult->RefreshToken = \Aurora\System\Api::UserSession()->UpdateTimestamp(\Aurora\System\Api::getAuthToken(), time()); \Aurora\System\Api::LogEvent('password-change-success: ' . $oAccount->Email, self::GetName()); \Aurora\System\Api::UserSession()->DeleteAllUserSessions($oUser->Id); } } } } if (!$mResult) { \Aurora\System\Api::LogEvent('password-change-failed: ' . ($oAccount ? $oAccount->Email : 'Account ID ') . $AccountId, self::GetName()); } return $mResult; } /** * @api {post} ?/Api/ GetFilters * @apiName GetFilters * @apiGroup Mail * @apiDescription Obtains filters for specified account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetFilters} Method Method name * @apiParam {string} [Parameters] JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetFilters', * Parameters: '{ "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result List of filters in case of success, otherwise **false**. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetFilters', * Result: [] * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetFilters', * Result: false, * ErrorCode: 102 * } */ /** * Obtains filters for specified account. * @param int $AccountID Account identifier. * @return array|boolean */ public function GetFilters($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->getSieveFilters($oAccount); } return $mResult; } /** * @api {post} ?/Api/ UpdateFilters * @apiName UpdateFilters * @apiGroup Mail * @apiDescription Updates filters. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateFilters} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier
* **Filters** *array* New filters data.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateFilters', * Parameters: '{ "AccountID": 12, "Filters": [ { "Enable": "1", "Field": 0, "Filter": "test", * "Condition": 0, "Action": 3, "FolderFullName": "test" } ] }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if filters were updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateFilters', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateFilters', * Result: false, * ErrorCode: 102 * } */ /** * Updates filters. * @param int $AccountID Account identifier * @param array $Filters New filters data. * @return boolean */ public function UpdateFilters($AccountID, $Filters) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $bResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $aFilters = array(); if (is_array($Filters)) { foreach ($Filters as $aFilterData) { $oFilter = $this->getSieveManager()->createFilterInstance($oAccount, $aFilterData); $aArgs = [ 'Account' => $oAccount, 'Filter' => &$oFilter, ]; $this->broadcastEvent('CreateFilterInstance', $aArgs); if ($oFilter) { $aFilters[] = $oFilter; } } } $bResult = $this->getSieveManager()->updateSieveFilters($oAccount, $aFilters); } return $bResult; } /** * @api {post} ?/Api/ GetForward * @apiName GetForward * @apiGroup Mail * @apiDescription Obtains forward data for specified account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetForward} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetForward', * Parameters: '{ "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Forward properties in case of success, otherwise **false**. * @apiSuccess {boolean} Result.Result.Enable Indicates if forward is enabled. * @apiSuccess {string} Result.Result.Email Forward email. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetForward', * Result: { "Enable": false, "Email": "" } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetForward', * Result: false, * ErrorCode: 102 * } */ /** * Obtains forward data for specified account. * @param int $AccountID Account identifier. * @return array|boolean */ public function GetForward($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->getForward($oAccount); } return $mResult; } /** * @api {post} ?/Api/ UpdateForward * @apiName UpdateForward * @apiGroup Mail * @apiDescription Updates forward. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateForward} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Enable** *boolean* Indicates if forward is enabled.
* **Email** *string* Email that should be used for message forward.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateForward', * Parameters: '{ "AccountID": 12, "Enable": true, "Email": "test2@email" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if server was updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateForward', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateForward', * Result: false, * ErrorCode: 102 * } */ /** * Updates forward. * @param int $AccountID Account identifier. * @param boolean $Enable Indicates if forward is enabled. * @param string $Email Email that should be used for message forward. * @param boolean $KeepMessageCopy Indicates if message copy should be kept in mailbox. * @return boolean */ public function UpdateForward($AccountID, $Enable = false, $Email = "", $KeepMessageCopy = true) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->setForward($oAccount, $Email, $Enable, $KeepMessageCopy); } return $mResult; } /** * @api {post} ?/Api/ GetAutoresponder * @apiName GetAutoresponder * @apiGroup Mail * @apiDescription Obtains autoresponder for specified account. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=GetAutoresponder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'GetAutoresponder', * Parameters: '{ "AccountID": 12 }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {mixed} Result.Result Autoresponder properties in case of success, otherwise **false**. * @apiSuccess {boolean} Result.Result.Enable Indicates if autoresponder is enabled. * @apiSuccess {string} Result.Result.Subject Subject of auto-respond message. * @apiSuccess {string} Result.Result.Message Text of auto-respond message. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'GetAutoresponder', * Result: { Enable: false, Subject: "", Message: "" } * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'GetAutoresponder', * Result: false, * ErrorCode: 102 * } */ /** * Obtains autoresponder for specified account. * @param int $AccountID Account identifier. * @return array|boolean */ public function GetAutoresponder($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->getAutoresponder($oAccount); if ($mResult) { if ($this->oModuleSettings->AllowScheduledAutoresponder) { $mResult['Scheduled'] = $oAccount->getExtendedProp(self::GetName() . '::' . 'AutoresponderScheduled', false); $mResult['Start'] = $oAccount->getExtendedProp(self::GetName() . '::' . 'AutoresponderStart'); $mResult['End'] = $oAccount->getExtendedProp(self::GetName() . '::' . 'AutoresponderEnd'); if ($mResult['Scheduled'] && !$mResult['Enable']) { $mResult['Enable'] = true; } } } } return $mResult; } /** * @api {post} ?/Api/ UpdateAutoresponder * @apiName UpdateAutoresponder * @apiGroup Mail * @apiDescription Updates autoresponder data. * * @apiHeader {string} Authorization "Bearer " + Authentication token which was received as the result of Core.Login method. * @apiHeaderExample {json} Header-Example: * { * "Authorization": "Bearer 32b2ecd4a4016fedc4abee880425b6b8" * } * * @apiParam {string=Mail} Module Module name * @apiParam {string=UpdateAutoresponder} Method Method name * @apiParam {string} Parameters JSON.stringified object
* {
* **AccountID** *int* Account identifier.
* **Enable** *boolean* Indicates if autoresponder is enabled.
* **Subject** *string* Subject of auto-respond message.
* **Message** *string* Text of auto-respond message.
* } * * @apiParamExample {json} Request-Example: * { * Module: 'Mail', * Method: 'UpdateAutoresponder', * Parameters: '{ "AccountID": 12, "Enable": true, "Subject": "subject_value", "Text": "text_value" }' * } * * @apiSuccess {object[]} Result Array of response objects. * @apiSuccess {string} Result.Module Module name. * @apiSuccess {string} Result.Method Method name. * @apiSuccess {boolean} Result.Result Indicates if Autoresponder was updated successfully. * @apiSuccess {int} [Result.ErrorCode] Error code * * @apiSuccessExample {json} Success response example: * { * Module: 'Mail', * Method: 'UpdateAutoresponder', * Result: true * } * * @apiSuccessExample {json} Error response example: * { * Module: 'Mail', * Method: 'UpdateAutoresponder', * Result: false, * ErrorCode: 102 * } */ /** * Updates autoresponder data. * @param int $AccountID Account identifier. * @param boolean $Enable Indicates if autoresponder is enabled. * @param string $Subject Subject of auto-respond message. * @param string $Message Text of auto-respond message. * @return boolean */ public function UpdateAutoresponder($AccountID, $Enable = false, $Subject = "", $Message = "", $Scheduled = false, $Start = null, $End = null) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($Enable && \trim($Subject) === "" && \trim($Message) === "") { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } if ($oAccount) { $currentAutoresponderScheduled = $oAccount->getExtendedProp(self::GetName() . '::' . 'AutoresponderScheduled'); if ($this->oModuleSettings->AllowScheduledAutoresponder) { if ($Scheduled && $Start > time()) { $Enable = false; } $oAccount->setExtendedProp(self::GetName() . '::' . 'AutoresponderScheduled', $Scheduled); $oAccount->setExtendedProp(self::GetName() . '::' . 'AutoresponderStart', $Start); $oAccount->setExtendedProp(self::GetName() . '::' . 'AutoresponderEnd', $End); $oAccount->save(); } elseif ($currentAutoresponderScheduled === true) { $oAccount->setExtendedProp(self::GetName() . '::' . 'AutoresponderScheduled', false); $oAccount->save(); } $mResult = $this->getSieveManager()->setAutoresponder($oAccount, $Subject, $Message, $Enable); } return $mResult; } public function SetAccountSpamSettings($AccountID, $SpamScore, $AllowList, $BlockList) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->setAllowBlockLists($oAccount, $AllowList, $BlockList, $SpamScore); } return $mResult; } public function GetAccountSpamSettings($AccountID) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->getAllowBlockLists($oAccount); } return $mResult; } public function AddEmailToAllowList($AccountID, $Email) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->addRowToAllowList($oAccount, $Email); } return $mResult; } public function AddEmailToBlockList($AccountID, $Email) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $mResult = false; $oAccount = $this->getAccountsManager()->getAccountById((int) $AccountID); self::checkAccountAccess($oAccount); if ($oAccount) { $mResult = $this->getSieveManager()->addRowToBlockList($oAccount, $Email); } return $mResult; } /***** public functions might be called with web API *****/ /***** private functions *****/ /** * Deletes all mail accounts which are belonged to the specified user. * Called from subscribed event. * @ignore * @param array $aArgs * @param int $mResult User identifier. */ public function onBeforeDeleteUser($aArgs, &$mResult) { $mResult = $this->getAccountsManager()->getUserAccounts($aArgs["UserId"]); foreach ($mResult as $oItem) { self::Decorator()->DeleteAccount($oItem->Id); } } public function onAfterDeleteUser($aArgs, &$mResult) { if ($mResult) { Identity::where('IdUser', $aArgs["UserId"])->delete(); TrustedSender::where('IdUser', $aArgs["UserId"])->delete(); } } /** * Obtains a server object for the specified domain. * @param string $Domain * @param bool $AllowWildcardDomain the parameter indicates whether the wildcard server should be returned if no servers found * @return array */ public function GetMailServerByDomain($Domain, $AllowWildcardDomain = false) { $aResult = []; $bFoundWithWildcard = false; $oServer = $this->getServersManager()->getServerByDomain($Domain); if (!($oServer instanceof \Aurora\Modules\Mail\Models\Server) && $AllowWildcardDomain) { $oServer = $this->getServersManager()->getServerByDomain('*'); $bFoundWithWildcard = true; } if (!($oServer instanceof \Aurora\Modules\Mail\Models\Server) && $AllowWildcardDomain) { $oServer = $this->getServersManager()->getServerByDomain(''); $bFoundWithWildcard = true; } if ($oServer instanceof \Aurora\Modules\Mail\Models\Server) { $aResult = [ 'Server' => $oServer, 'FoundWithWildcard' => $bFoundWithWildcard ]; } return $aResult; } /** * Attempts to authorize user via mail account with specified credentials. * Called from subscribed event. * @ignore * @param array $aArgs Credentials. * @param array|boolean $mResult List of results values. * @return boolean */ public function onLogin($aArgs, &$mResult) { $bResult = false; $iUserId = 0; $sEmail = $sMailLogin = $aArgs['Login']; $sEmail = str_replace(" ", "", $sEmail); $oAccount = $this->getAccountsManager()->getAccountUsedToAuthorize($sEmail); $bNewAccount = false; $bAutocreateMailAccountOnNewUserFirstLogin = $this->oModuleSettings->AutocreateMailAccountOnNewUserFirstLogin; if (!$bAutocreateMailAccountOnNewUserFirstLogin && !$oAccount) { $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserByPublicId($sEmail); if ($oUser instanceof User) { $bAutocreateMailAccountOnNewUserFirstLogin = true; } } $oServer = null; if ($bAutocreateMailAccountOnNewUserFirstLogin && !$oAccount) { $sEmail = \strtolower($sEmail); $sDomain = \MailSo\Base\Utils::GetDomainFromEmail($sEmail); if (!empty(trim($sDomain))) { $aGetMailServerResult = self::Decorator()->GetMailServerByDomain($sDomain, /*AllowWildcardDomain*/true); if (!empty($aGetMailServerResult) && isset($aGetMailServerResult['Server']) && $aGetMailServerResult['Server'] instanceof \Aurora\Modules\Mail\Models\Server) { $oServer = $aGetMailServerResult['Server']; } $oTenant = \Aurora\System\Api::getTenantByWebDomain(); if ($oServer && (!$oTenant || $oServer->OwnerType === \Aurora\Modules\Mail\Enums\ServerOwnerType::SuperAdmin || $oServer->TenantId === $oTenant->Id)) { $sMailLogin = !$oServer->UseFullEmailAddressAsLogin && preg_match('/(.+)@.+$/', $sEmail, $matches) && $matches[1] ? $matches[1] : $sEmail; $oAccount = new \Aurora\Modules\Mail\Models\MailAccount(); $oAccount->Email = $sEmail; $oAccount->IncomingLogin = $sMailLogin; $oAccount->setPassword($aArgs['Password']); $oAccount->ServerId = $oServer->Id; $bNewAccount = true; } else { throw new \Aurora\System\Exceptions\ApiException( Enums\ErrorCodes::DomainIsNotAllowedForLoggingIn, null, '', [], $this ); } } } if ($oAccount instanceof \Aurora\Modules\Mail\Models\MailAccount) { try { if ($bAutocreateMailAccountOnNewUserFirstLogin || !$bNewAccount) { $sOldPassword = $oAccount->getPassword(); $sNewPassword = $aArgs['Password']; $oAccount->setPassword($sNewPassword); $mValidResult = $this->getMailManager()->validateAccountConnection($oAccount, false); $bResult = !($mValidResult instanceof \Exception); if ($bResult && $sNewPassword !== $sOldPassword) { // Update password in DB only if account passed connection validation $this->getAccountsManager()->updateAccount($oAccount); if (!$bNewAccount) { $oCoreModule = \Aurora\Modules\Core\Module::getInstance(); $oUser = $oCoreModule->GetUserWithoutRoleCheck($oAccount->IdUser); if ($oUser instanceof User) { $oCoreModule->UpdateTokensValidFromTimestamp($oUser); Api::UserSession()->DeleteAllUserSessions($oUser->Id); } } } } if ($bResult && $bAutocreateMailAccountOnNewUserFirstLogin && $bNewAccount) { $oUser = null; $aSubArgs = array( 'UserName' => $sEmail, 'Email' => $sEmail, 'UserId' => $iUserId, 'TenantId' => $oServer->TenantId ); $this->broadcastEvent( 'CreateAccount', $aSubArgs, $oUser ); if ($oUser instanceof User) { $iUserId = $oUser->Id; $bPrevState = \Aurora\System\Api::skipCheckUserRole(true); $oAccount = self::Decorator()->CreateAccount( $iUserId, '', $sEmail, $sMailLogin, $aArgs['Password'], array('ServerId' => $oServer->Id) ); \Aurora\System\Api::skipCheckUserRole($bPrevState); if ($oAccount) { $oAccount->UseToAuthorize = true; $oAccount->UseThreading = $oServer->EnableThreading; $bResult = $this->getAccountsManager()->updateAccount($oAccount); } else { $bResult = false; } } } if ($bResult) { $mResult = \Aurora\System\UserSession::getTokenData($oAccount, $aArgs['SignMe']); } } catch (\Aurora\System\Exceptions\ApiException $oException) { throw $oException; } catch (\Exception $oException) { } } return $bResult; } /** * * @param array $aArgs * @param array $aResult */ public function onGetAccounts($aArgs, &$aResult) { if (isset($aArgs['UserId'])) { $mResult = $this->GetAccounts($aArgs['UserId']); if (\is_array($mResult)) { foreach ($mResult as $oItem) { $aResult[] = [ 'Type' => $oItem->getName(), 'Module' => $this->GetName(), 'Id' => $oItem->Id, 'UUID' => $oItem->UUID, 'Login' => $oItem->IncomingLogin ]; } } } } /** * Puts on or off some flag of message. * @param int $AccountID account identifier. * @param string $sFolderFullNameRaw Folder full name. * @param string $sUids List of messages' uids. * @param boolean $bSetAction Indicates if flag should be set or removed. * @param string $sFlagName Name of message flag. * @return boolean * @throws \Aurora\System\Exceptions\ApiException */ private function setMessageFlag($AccountID, $sFolderFullNameRaw, $sUids, $bSetAction, $sFlagName) { $aUids = \Aurora\System\Utils::ExplodeIntUids((string) $sUids); if (0 === \strlen(\trim($sFolderFullNameRaw)) || !\is_array($aUids) || 0 === \count($aUids)) { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::InvalidInputParameter); } $oAccount = $this->getAccountsManager()->getAccountById($AccountID); return $this->getMailManager()->setMessageFlag( $oAccount, $sFolderFullNameRaw, $aUids, $sFlagName, $bSetAction ? \Aurora\Modules\Mail\Enums\MessageStoreAction::Add : \Aurora\Modules\Mail\Enums\MessageStoreAction::Remove ); } /** * When using a memory stream and the read * filter "convert.base64-encode" the last * character is missing from the output if * the base64 conversion needs padding bytes. * @param string $sRaw * @return string */ private function fixBase64EncodeOmitsPaddingBytes($sRaw) { $rStream = \fopen('php://memory', 'r+'); \fwrite($rStream, '0'); \rewind($rStream); $rFilter = \stream_filter_append($rStream, 'convert.base64-encode'); if (0 === \strlen(\stream_get_contents($rStream))) { $iFileSize = \strlen($sRaw); $sRaw = \str_pad($sRaw, $iFileSize + ($iFileSize % 3)); } return $sRaw; } /** * Builds message for further sending or saving. * @param \Aurora\Modules\Mail\Models\MailAccount $oAccount * @param string $sTo Message recipients. * @param string $sCc Recipients which will get a copy of the message. * @param string $sBcc Recipients which will get a hidden copy of the message. * @param string $sSubject Subject of the message. * @param boolean $bTextIsHtml Indicates if text of the message is HTML or plain. * @param string $sText Text of the message. * @param array $aAttachments List of attachments. * @param array $aDraftInfo Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. * @param string $sInReplyTo Value of **In-Reply-To** header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads. * @param string $sReferences Content of References header block of the message. * @param int $iImportance Importance of the message - LOW = 5, NORMAL = 3, HIGH = 1. * @param int $iSensitivity Sensitivity header for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". * @param boolean $bSendReadingConfirmation Indicates if it is necessary to include header that says * @param object $oFetcher * @param object $oAlias * @param boolean $bWithDraftInfo * @param \Aurora\Modules\Mail\Models\Identity $oIdentity * @param array $aCustomHeaders * @return \MailSo\Mime\Message */ public function BuildMessage( $oAccount, $sTo = '', $sCc = '', $sBcc = '', $sSubject = '', $bTextIsHtml = false, $sText = '', $aAttachments = null, $aDraftInfo = null, $sInReplyTo = '', $sReferences = '', $iImportance = 0, $iSensitivity = 0, $bSendReadingConfirmation = false, $oFetcher = null, $oAlias = null, $bWithDraftInfo = true, $oIdentity = null, $aCustomHeaders = [] ) { self::checkAccountAccess($oAccount); $oMessage = \MailSo\Mime\Message::NewInstance(); $oMessage->RegenerateMessageId(); $sUUID = \Aurora\System\Api::getUserUUIDById($oAccount->IdUser); $sXMailer = $this->oModuleSettings->XMailerValue; if (0 < \strlen($sXMailer)) { $oMessage->SetXMailer($sXMailer); } $sXOriginatingIPHeaderName = $this->oModuleSettings->XOriginatingIPHeaderName; if (!empty($sXOriginatingIPHeaderName)) { $sIP = $this->oHttp->GetClientIp(); $oMessage->SetCustomHeader( $sXOriginatingIPHeaderName, $this->oHttp->IsLocalhost($sIP) ? '127.0.0.1' : $sIP ); } if ($oIdentity) { $oFrom = \MailSo\Mime\Email::NewInstance($oIdentity->Email, $oIdentity->FriendlyName); } elseif ($oAlias) { $oFrom = \MailSo\Mime\Email::NewInstance($oAlias->Email, $oAlias->FriendlyName); } else { $oFrom = $oFetcher ? \MailSo\Mime\Email::NewInstance($oFetcher->Email, $oFetcher->Name) : \MailSo\Mime\Email::NewInstance($oAccount->Email, $oAccount->FriendlyName); } $oMessage ->SetFrom($oFrom) ->SetSubject($sSubject) ; $oToEmails = \MailSo\Mime\EmailCollection::NewInstance($sTo); if ($oToEmails && $oToEmails->Count()) { $oMessage->SetTo($oToEmails); } $oCcEmails = \MailSo\Mime\EmailCollection::NewInstance($sCc); if ($oCcEmails && $oCcEmails->Count()) { $oMessage->SetCc($oCcEmails); } $oBccEmails = \MailSo\Mime\EmailCollection::NewInstance($sBcc); if ($oBccEmails && $oBccEmails->Count()) { $oMessage->SetBcc($oBccEmails); } if ($bWithDraftInfo && \is_array($aDraftInfo) && !empty($aDraftInfo[0]) && !empty($aDraftInfo[1]) && !empty($aDraftInfo[2])) { $oMessage->SetDraftInfo($aDraftInfo[0], $aDraftInfo[1], $aDraftInfo[2]); } if (0 < \strlen($sInReplyTo)) { $oMessage->SetInReplyTo($sInReplyTo); } if (0 < \strlen($sReferences)) { $oMessage->SetReferences($sReferences); } if (\in_array($iImportance, array( \MailSo\Mime\Enumerations\MessagePriority::HIGH, \MailSo\Mime\Enumerations\MessagePriority::NORMAL, \MailSo\Mime\Enumerations\MessagePriority::LOW ))) { $oMessage->SetPriority($iImportance); } if (\in_array($iSensitivity, array( \MailSo\Mime\Enumerations\Sensitivity::NOTHING, \MailSo\Mime\Enumerations\Sensitivity::CONFIDENTIAL, \MailSo\Mime\Enumerations\Sensitivity::PRIVATE_, \MailSo\Mime\Enumerations\Sensitivity::PERSONAL, ))) { $oMessage->SetSensitivity((int) $iSensitivity); } if (is_array($aCustomHeaders)) { foreach ($aCustomHeaders as $sHeaderName => $sHeaderValue) { $oMessage->SetCustomHeader($sHeaderName, $sHeaderValue); } } if ($bSendReadingConfirmation) { $oMessage->SetReadConfirmation($oFetcher ? $oFetcher->Email : $oAccount->Email); } $aFoundCids = array(); if ($bTextIsHtml) { $sTextConverted = \MailSo\Base\HtmlUtils::ConvertHtmlToPlain($sText); $oMessage->AddText($sTextConverted, false); } $mFoundDataURL = array(); $aFoundedContentLocationUrls = array(); $sTextConverted = $bTextIsHtml ? \MailSo\Base\HtmlUtils::BuildHtml($sText, $aFoundCids, $mFoundDataURL, $aFoundedContentLocationUrls) : $sText; $oMessage->AddText($sTextConverted, $bTextIsHtml); if (\is_array($aAttachments)) { foreach ($aAttachments as $sTempName => $aData) { if (\is_array($aData) && isset($aData[0], $aData[1], $aData[2], $aData[3])) { $sFileName = (string) $aData[0]; $sCID = (string) $aData[1]; $bIsInline = '1' === (string) $aData[2]; $bIsLinked = '1' === (string) $aData[3]; $sContentLocation = isset($aData[4]) ? (string) $aData[4] : ''; $rResource = $this->getFilecacheManager()->getFile($sUUID, $sTempName); if (\is_resource($rResource)) { $iFileSize = $this->getFilecacheManager()->fileSize($sUUID, $sTempName); $sCID = \trim(\trim($sCID), '<>'); $bIsFounded = 0 < \strlen($sCID) ? \in_array($sCID, $aFoundCids) : false; if (!$bIsLinked || $bIsFounded) { $oMessage->Attachments()->Add( \MailSo\Mime\Attachment::NewInstance( $rResource, $sFileName, $iFileSize, $bIsInline, $bIsLinked, $bIsLinked ? '<' . $sCID . '>' : '', array(), $sContentLocation ) ); } } else { \Aurora\System\Api::Log('Error: there is no temp file for attachment ' . $sFileName); } } } } if ($mFoundDataURL && \is_array($mFoundDataURL) && 0 < \count($mFoundDataURL)) { foreach ($mFoundDataURL as $sCidHash => $sDataUrlString) { $aMatch = array(); $sCID = '<' . $sCidHash . '>'; if (\preg_match('/^data:(image\/[a-zA-Z0-9]+\+?[a-zA-Z0-9]+);base64,(.+)$/i', $sDataUrlString, $aMatch) && !empty($aMatch[1]) && !empty($aMatch[2])) { $sRaw = \MailSo\Base\Utils::Base64Decode($aMatch[2]); $iFileSize = \strlen($sRaw); if (0 < $iFileSize) { $sFileName = \preg_replace('/[^a-z0-9]+/i', '.', \MailSo\Base\Utils::NormalizeContentType($aMatch[1])); // fix bug #68532 php < 5.5.21 or php < 5.6.5 $sRaw = $this->fixBase64EncodeOmitsPaddingBytes($sRaw); $rResource = \MailSo\Base\ResourceRegistry::CreateMemoryResourceFromString($sRaw); $sRaw = ''; unset($sRaw); unset($aMatch); $oMessage->Attachments()->Add( \MailSo\Mime\Attachment::NewInstance($rResource, $sFileName, $iFileSize, true, true, $sCID) ); } } } } return $oMessage; } public function onAfterDeleteTenant(&$aArgs, &$mResult) { $TenantId = $aArgs['TenantId']; $aServers = self::Decorator()->GetServers($TenantId); if (is_array($aServers) && $aServers['Count'] > 0) { foreach ($aServers['Items'] as $oServer) { if ($oServer['TenantId'] === $TenantId) { self::Decorator()->DeleteServer($oServer['Id'], $TenantId); } } } } public function onAfterGetAutodiscover(&$aArgs, &$mResult) { $sIncomingServer = \trim($this->oModuleSettings->ExternalHostNameOfLocalImap); $sOutgoingServer = \trim($this->oModuleSettings->ExternalHostNameOfLocalSmtp); $sEmail = $aArgs['Email']; if (0 < \strlen($sIncomingServer) && 0 < \strlen($sOutgoingServer)) { $iIncomingPort = 143; $iOutgoingPort = 25; $aMatch = array(); if (\preg_match('/:([\d]+)$/', $sIncomingServer, $aMatch) && !empty($aMatch[1]) && \is_numeric($aMatch[1])) { $sIncomingServer = \preg_replace('/:[\d]+$/', $sIncomingServer, ''); $iIncomingPort = (int) $aMatch[1]; } $aMatch = array(); if (\preg_match('/:([\d]+)$/', $sOutgoingServer, $aMatch) && !empty($aMatch[1]) && \is_numeric($aMatch[1])) { $sOutgoingServer = \preg_replace('/:[\d]+$/', $sOutgoingServer, ''); $iOutgoingPort = (int) $aMatch[1]; } $sResult = \implode("\n", array( '
', '
email
', '
settings
', '
', '
IMAP
', '
' . $sIncomingServer . '
', '
' . $sEmail . '
', '
' . $iIncomingPort . '
', '
' . (993 === $iIncomingPort ? 'on' : 'off') . '
', '
off
', '
on
', '
', '
', '
SMTP
', '
' . $sOutgoingServer . '
', '
' . $sEmail . '
', '
' . $iOutgoingPort . '
', '
' . (465 === $iOutgoingPort ? 'on' : 'off') . '
', '
off
', '
on
', '
', '
' )); $mResult = $mResult . $sResult; } } public function EntryMessageNewtab() { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $oApiIntegrator = \Aurora\System\Managers\Integrator::getInstance(); if ($oApiIntegrator) { \Aurora\Modules\CoreWebclient\Module::Decorator()->SetHtmlOutputHeaders(); $aConfig = array( 'new_tab' => true, 'modules_list' => $oApiIntegrator->GetModulesForEntry('MailWebclient') ); $oCoreWebclientModule = \Aurora\System\Api::GetModule('CoreWebclient'); if ($oCoreWebclientModule instanceof \Aurora\System\Module\AbstractModule) { $sResult = \file_get_contents($oCoreWebclientModule->GetPath() . '/templates/Index.html'); if (\is_string($sResult)) { return strtr($sResult, array( '{{AppVersion}}' => Application::GetVersion(), '{{IntegratorDir}}' => $oApiIntegrator->isRtl() ? 'rtl' : 'ltr', '{{IntegratorLinks}}' => $oApiIntegrator->buildHeadersLink(), '{{IntegratorBody}}' => $oApiIntegrator->buildBody($aConfig) )); } } } } public function EntryDownloadAttachment() { $sHash = (string) \Aurora\System\Router::getItemByIndex(1, ''); $aValues = \Aurora\System\Api::DecodeKeyValues($sHash); $sAuthToken = isset($aValues['AuthToken']) ? $aValues['AuthToken'] : null; if (isset($sAuthToken)) { \Aurora\System\Api::setUserId( \Aurora\System\Api::getAuthenticatedUserId($sAuthToken) ); \Aurora\System\Api::setAuthToken($sAuthToken); } \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); if ($this->oModuleSettings->CleanupOutputBeforeDownload) { @ob_clean(); // discard any data in the output buffer (if possible) } $this->getRaw( $sHash, (string) \Aurora\System\Router::getItemByIndex(2, '') ); } public function onBeforeRunEntry(&$aArguments, &$aResult) { $sEntry = 'mail-attachment'; if ($aArguments['EntryName'] === $sEntry) { $sParam3 = \Aurora\System\Router::getItemByIndex(3, null); if (isset($sParam3) && $sParam3 === 'get-expired-link') { $sHash = (string) \Aurora\System\Router::getItemByIndex(1, ''); $sAction = (string) \Aurora\System\Router::getItemByIndex(2, ''); $iTime = $this->oModuleSettings->ExpiredLinkLifetimeMinutes ; $aValues = \Aurora\System\Api::DecodeKeyValues($sHash); if (!isset($aValues['AuthToken'])) { $aValues['AuthToken'] = \Aurora\System\Api::UserSession()->Set( array( 'token' => 'auth', 'id' => \Aurora\System\Api::getAuthenticatedUserId(), ), time(), time() + 60 * $iTime ); $sHash = \Aurora\System\Api::EncodeKeyValues($aValues); } \header('Location: ' . \MailSo\Base\Http::SingletonInstance()->GetFullUrl() . '?' . $sEntry . '/' . $sHash . '/' . $sAction); } } } public function EntryDownloadAttachmentCookieless() { $sAuthToken = $_GET['AuthToken']; $re = '/^[a-zA-Z0-9_-]+$/'; $bSafeToken = preg_match($re, $sAuthToken); if ($sAuthToken !== '' && !!$bSafeToken) { \Aurora\System\Api::authorise($sAuthToken); $this->EntryDownloadAttachment(); } } /** * @param string $sHash * @param string $sAction * @return boolean */ private function getRaw($sHash, $sAction = '') { $self = $this; $bDownload = true; $bThumbnail = false; switch ($sAction) { case 'view': $bDownload = false; $bThumbnail = false; break; case 'thumb': $bDownload = false; $bThumbnail = true; break; default: $bDownload = true; $bThumbnail = false; break; } $aValues = \Aurora\System\Api::DecodeKeyValues($sHash); $sFolder = ''; $iUid = 0; $sMimeIndex = ''; $oAccount = null; $iUserId = null; if (isset($aValues['AccountID'])) { $oAccount = $this->getAccountsManager()->getAccountById((int) $aValues['AccountID']); self::checkAccountAccess($oAccount); if (!$oAccount || \Aurora\System\Api::getAuthenticatedUserId() !== $oAccount->IdUser) { return false; } $iUserId = $oAccount->IdUser; } $sFolder = isset($aValues['Folder']) ? $aValues['Folder'] : ''; $iUid = (int) (isset($aValues['Uid']) ? $aValues['Uid'] : 0); $sMimeIndex = (string) (isset($aValues['MimeIndex']) ? $aValues['MimeIndex'] : ''); $sContentTypeIn = (string) (isset($aValues['MimeType']) ? $aValues['MimeType'] : ''); $sFileNameIn = (string) (isset($aValues['FileName']) ? $aValues['FileName'] : ''); // SVG files should not be viewed because they may contain JS if (!$bDownload && strtolower(pathinfo($sFileNameIn, PATHINFO_EXTENSION)) === 'svg') { $this->oHttp->StatusHeader(403); exit(); } $bCache = true; if ($bCache && 0 < \strlen($sFolder) && 0 < $iUid) { \Aurora\System\Managers\Response::verifyCacheByKey($sHash); } if ($bThumbnail) { $sThumbnail = \Aurora\System\Managers\Thumb::GetResourceCache($iUserId, $sFileNameIn); if ($sThumbnail) { $sContentType = \MailSo\Base\Utils::MimeContentType($sFileNameIn); \Aurora\System\Managers\Response::OutputHeaders($bDownload, $sContentType, $sFileNameIn); echo $sThumbnail; exit(); } } return $this->getMailManager()->directMessageToStream( $oAccount, function ($rResource, $sContentType, $sFileName, $sMimeIndex = '') use ($iUserId, $sHash, $bCache, $sContentTypeIn, $sFileNameIn, $bThumbnail, $bDownload) { if (\is_resource($rResource)) { $sContentTypeOut = $sContentTypeIn; if (empty($sContentTypeOut)) { $sContentTypeOut = $sContentType; if (empty($sContentTypeOut)) { $sContentTypeOut = (empty($sFileName)) ? 'text/plain' : \MailSo\Base\Utils::MimeContentType($sFileName); } } $sFileNameOut = $sFileNameIn; if (empty($sFileNameOut) || '.' === $sFileNameOut[0]) { $sFileNameOut = $sFileName; } $sFileNameOut = \Aurora\System\Utils::clearFileName($sFileNameOut, $sContentType, $sMimeIndex); if ($bCache) { \Aurora\System\Managers\Response::cacheByKey($sHash); } \Aurora\System\Utils::OutputFileResource($iUserId, $sContentType, $sFileName, $rResource, $bThumbnail, $bDownload); } }, $sFolder, $iUid, $sMimeIndex ); } public function onGetDigestHash($aArgs, &$mResult) { $oAccount = $this->getAccountsManager()->getAccountUsedToAuthorize($aArgs['Login']); if (is_a($oAccount, $aArgs['Type'])) { $mResult = \md5($aArgs['Login'] . ':' . $aArgs['Realm'] . ':' . $oAccount->GetPassword()); return true; } } public function onGetAccountUsedToAuthorize($aArgs, &$mResult) { $oAccount = $this->getAccountsManager()->getAccountUsedToAuthorize($aArgs['Login']); if ($oAccount) { $mResult = $oAccount; return true; } } public function onCastExtendedProp($aArgs, &$mValue) { if ($aArgs['Model'] instanceof User) { if ($aArgs['PropertyName'] === $this->GetName() . '::UserSpaceLimitMb') { $mValue = (int) $mValue; } if ($aArgs['PropertyName'] === $this->GetName() . '::AllowAutosaveInDrafts') { $mValue = (bool) $mValue; } } if ($aArgs['Model'] instanceof Tenant) { if ($aArgs['PropertyName'] === $this->GetName() . '::TenantSpaceLimitMb' || $aArgs['PropertyName'] === $this->GetName() . '::UserSpaceLimitMb' || $aArgs['PropertyName'] === $this->GetName() . '::AllocatedSpaceMb' ) { $mValue = (int) $mValue; } if ($aArgs['PropertyName'] === $this->GetName() . '::AllowChangeUserSpaceLimit') { $mValue = (bool) $mValue; } } } public function onAfterChangePassword($aArgs, &$mResult) { if ($mResult instanceof Models\MailAccount && $mResult->UseToAuthorize) { $oCoreModule = \Aurora\Modules\Core\Module::getInstance(); $oUser = \Aurora\System\Api::getAuthenticatedUser(); if ($oUser instanceof User && (($oUser->isNormalOrTenant() && $oUser->Id === $mResult->IdUser) || $oUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin) ) { $oUser = $oCoreModule->GetUserWithoutRoleCheck($mResult->IdUser); if ($oUser instanceof User) { $oCoreModule->UpdateTokensValidFromTimestamp($oUser); Api::UserSession()->DeleteAllUserSessions($oUser->Id); } } } } public function GetServerDomains($ServerId, $TenantId) { \Aurora\System\Api::checkUserRoleIsAtLeast(\Aurora\System\Enums\UserRole::NormalUser); $aResult = []; $oServer = $this->getServersManager()->getServer($ServerId); if ($oServer instanceof Models\Server) { $aResult = explode("\n", $oServer->Domains); $iWildcard = array_search('*', $aResult); if ($iWildcard !== false) { unset($aResult[$iWildcard]); } } return $aResult; } public function IsEmailAllowedForCreation($Email) { //Method available only for admin or tenant-admin $oAuthenticatedUser = \Aurora\System\Api::getAuthenticatedUser(); if ( $oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::SuperAdmin || $oAuthenticatedUser->Role === \Aurora\System\Enums\UserRole::TenantAdmin ) { $oUser = \Aurora\Modules\Core\Module::Decorator()->GetUserByPublicId($Email); if ($oUser instanceof User) { return false; } $aAccounts = $this->getAccountsManager()->getAccounts([ 'Email' => $Email, 'IsDisabled' => false ]); if (is_array($aAccounts) && count($aAccounts) > 0) { return false; } return true; } else { throw new \Aurora\System\Exceptions\ApiException(\Aurora\System\Notifications::AccessDenied); } } /***** private functions *****/ }