Class Aurora\Modules\ImportExportMailPlugin\Module

`extends`	`AbstractModule`

Aurora\System\Module\AbstractModule
- Aurora\Modules\ImportExportMailPlugin\Module

Located at modules/ImportExportMailPlugin/Module.php

Methods


					
	public

init()

Implements

Aurora\System\Module\AbstractModule::init()


					
	public

GetSettings(): array

Obtains list of module settings

Overrides

Aurora\System\Module\AbstractModule::GetSettings()


					
	public

ExportMailPrepare(): bool|array

Creating empty files before data export


					
	public

ExportMailGenerate(int $AccountId, string $Folder, string $Zip): boolean

Exporting mails into zip file

Parameters

`$AccountId`	Mail account ID
`$Folder`	Folder name
`$Zip`	ZIP file name

Throws

Aurora\Modules\ImportExportMailPlugin\Exception


					
	public

ExportMailStatus(string $Zip): bool|array

Checking status of export process

Parameters

$Zip

ZIP file name


					
	public

EntryTransferMail()

Entry point for mail export


					
	public

ExportMail(string $sFileName)

Downloading of exported emails


					
	public

ImportMail(int $AccountId, string $Folder, array $UploadData): boolean

Importing emails into specified folder

Parameters

`$AccountId`	Mail account ID
`$Folder`	Folder name
`$UploadData`	Information about uploaded file

Throws

`Aurora\System\Exceptions\BaseException`
`Aurora\System\Exceptions\ApiException`

Methods inherited from Aurora\System\Module\AbstractModule
__construct(), createInstance(), getInstance(), Decorator(), __invoke(), __callStatic(), RequireModule(), GetRequireModules(), isPermanent(), isValid(), initialize(), getNamespace(), loadModuleSettings(), saveModuleConfig(), getConfig(), setConfig(), denyMethodsCallByWebApi(), denyMethodCallByWebApi(), subscribeEvent(), broadcastEvent(), skipEvent(), removeEventFromSkiped(), includeTemplate(), extendObject(), getExtendedObject(), issetObject(), SetPath(), GetHash(), GetName(), GetPath(), GetVersion(), GetFullName(), AddEntry(), AddEntries(), HasEntry(), RemoveEntry(), RemoveEntries(), GetEntryCallback(), DefaultResponse(), TrueResponse(), FalseResponse(), ExceptionResponse(), CallMethod(), i18N(), GetErrors(), GetErrorMessageByCode(), GetAdditionalEntityFieldsToEdit()

Methods inherited from Aurora\System\Module\AbstractModule

__construct(), createInstance(), getInstance(), Decorator(), __invoke(), __callStatic(), RequireModule(), GetRequireModules(), isPermanent(), isValid(), initialize(), getNamespace(), loadModuleSettings(), saveModuleConfig(), getConfig(), setConfig(), denyMethodsCallByWebApi(), denyMethodCallByWebApi(), subscribeEvent(), broadcastEvent(), skipEvent(), removeEventFromSkiped(), includeTemplate(), extendObject(), getExtendedObject(), issetObject(), SetPath(), GetHash(), GetName(), GetPath(), GetVersion(), GetFullName(), AddEntry(), AddEntries(), HasEntry(), RemoveEntry(), RemoveEntries(), GetEntryCallback(), DefaultResponse(), TrueResponse(), FalseResponse(), ExceptionResponse(), CallMethod(), i18N(), GetErrors(), GetErrorMessageByCode(), GetAdditionalEntityFieldsToEdit()

Properties
`public`		`$oFilecacheManager = null`	#
`public`		`$sLogPrefix = 'plugin-import-export-mail-'`	#

Properties inherited from Aurora\System\Module\AbstractModule
`$oHttp, $Delimiter, $aErrors, $aAdditionalEntityFieldsToEdit`

Namespaces

Classes

Class Aurora\Modules\ImportExportMailPlugin\Module

Implements

Overrides

Parameters

Throws

Parameters

Parameters

Throws