Felamimail_Frontend_Json
json frontend for Felamimail
This class handles all Json requests for the Felamimail application
Implements:
Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface
Extend:
Tinebase_Frontend_Json_Abstract
Methods
| Name | Description |
|---|---|
| _removeAttachmentStreams | |
| addFlags | add given flags to given messages |
| addFolder | add new folder |
| approveAccountMigration | |
| changeCredentials | change account pwd / username |
| cleanupDrafts | cleanup auto saved draft messages |
| clearFlags | clear given flags from given messages |
| deleteAccounts | deletes existing accounts |
| deleteDraft | |
| deleteFolder | delete folder |
| doMailsBelongToAccount | |
| emptyFolder | remove all messages from folder and delete subfolders |
| fileAttachments | |
| fileMessages | file messages into Filemanager |
| fillAttachmentCache | |
| getAccount | get account data |
| getAttachmentCache | |
| getFileSuggestions | fetch suggestions for filing places for given message / recipients / . |
| getFolderStatus | get folder status |
| getMessage | get message data |
| getMessageFromNode | returns eml node converted to Felamimail message |
| getRules | get sieve rules for account |
| getSieveCustomScript | get sieve custom script for account |
| getVacation | get sieve vacation for account |
| getVacationMessage | get vacation message defined by template / do substitutions for dates and representative |
| getVacationMessageTemplates | get available vacation message templates |
| importMessage | import message into target folder |
| moveFolder | move folder |
| moveMessages | move messages to folder |
| processSpam | |
| refreshFolder | refresh folder |
| renameFolder | rename folder |
| saveAccount | creates/updates a record |
| saveDraft | |
| saveMessage | save + send message |
| saveMessageInFolder | save message in folder |
| saveRules | set sieve rules for account |
| saveSieveCustomScript | set sieve custom script for account |
| saveVacation | set sieve vacation for account |
| searchAccounts | |
| searchFolders | search folders and update/initialize cache of subfolders |
| searchMessages | search messages in message cache |
| sendReadingConfirmation | send reading confirmation |
| testIMapSettings | test imap settings |
| testSmtpSettings | test smtp settings |
| updateFlags | update flags - use session/writeClose to allow following requests |
| updateFolderCache | update folder cache |
| updateMessageCache | update message cache - use session/writeClose to update incomplete cache and allow following requests |
Inherited methods
| Name | Description |
|---|---|
| __call | magic method for json api |
| addFilterModelPlugin | Add a plugin for a former filter |
| getModelsConfiguration | returns model configurations for application starter |
| getRegistryData | Returns registry data of the application. |
| getRelatableModels | Returns all relatable models for this app |
| getTemplates | get available templates by containerId |
| resolveContainersAndTags | resolve containers and tags |
Felamimail_Frontend_Json::_removeAttachmentStreams
Description
_removeAttachmentStreams (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::addFlags
Description
public addFlags (array $filterData, string|array $flags)
add given flags to given messages
Parameters
(array) $filterData(string|array) $flags
Return Values
array
Felamimail_Frontend_Json::addFolder
Description
public addFolder (string $name, string $parent, string $accountId)
add new folder
Parameters
(string) $name(string) $parent(string) $accountId
Return Values
array
Felamimail_Frontend_Json::approveAccountMigration
Description
approveAccountMigration (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::changeCredentials
Description
public changeCredentials (string $id, string $username, string $password)
change account pwd / username
Parameters
(string) $id(string) $username(string) $password
Return Values
array
Felamimail_Frontend_Json::cleanupDrafts
Description
public cleanupDrafts ( $accountIds)
cleanup auto saved draft messages
Parameters
() $accountIds
Return Values
array
Felamimail_Frontend_Json::clearFlags
Description
public clearFlags (array $filterData, string|array $flags)
clear given flags from given messages
Parameters
(array) $filterData(string|array) $flags
Return Values
array
Felamimail_Frontend_Json::deleteAccounts
Description
public deleteAccounts (array $ids)
deletes existing accounts
Parameters
(array) $ids
Return Values
array
Felamimail_Frontend_Json::deleteDraft
Description
deleteDraft (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::deleteFolder
Description
public deleteFolder (string $folder, string $accountId)
delete folder
Parameters
(string) $folder: the folder global name to delete(string) $accountId
Return Values
array
Felamimail_Frontend_Json::doMailsBelongToAccount
Description
doMailsBelongToAccount (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::emptyFolder
Description
public emptyFolder (string $folderId)
remove all messages from folder and delete subfolders
Parameters
(string) $folderId: the folder id to delete
Return Values
array
with folder status
Felamimail_Frontend_Json::fileAttachments
Description
fileAttachments (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::fileMessages
Description
public fileMessages (array $filterData, array $locations)
file messages into Filemanager
Parameters
(array) $filterData(array) $locations
Return Values
array
Felamimail_Frontend_Json::fillAttachmentCache
Description
fillAttachmentCache (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::getAccount
Description
public getAccount (string $id)
get account data
Parameters
(string) $id
Return Values
array
Throws Exceptions
\Tinebase_Exception_NotFound
Felamimail_Frontend_Json::getAttachmentCache
Description
getAttachmentCache (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::getFileSuggestions
Description
public getFileSuggestions (array $messages)
fetch suggestions for filing places for given message / recipients / .
..
Parameters
(array) $messages
Return Values
array
Felamimail_Frontend_Json::getFolderStatus
Description
public getFolderStatus (array $filterData)
get folder status
Parameters
(array) $filterData
Return Values
array
of folder status
Throws Exceptions
\Tinebase_Exception_SystemGeneric
Felamimail_Frontend_Json::getMessage
Description
public getMessage (string $id, string $mimeType)
get message data
Parameters
(string) $id(string) $mimeType
Return Values
array
Felamimail_Frontend_Json::getMessageFromNode
Description
public getMessageFromNode ( $nodeId)
returns eml node converted to Felamimail message
Parameters
() $nodeId
Return Values
array
Felamimail_Frontend_Json::getRules
Description
public getRules (string $accountId)
get sieve rules for account
Parameters
(string) $accountId
Return Values
array
Felamimail_Frontend_Json::getSieveCustomScript
Description
public getSieveCustomScript (string $id)
get sieve custom script for account
Parameters
(string) $id
Return Values
array
Felamimail_Frontend_Json::getVacation
Description
public getVacation (string $id)
get sieve vacation for account
Parameters
(string) $id: account id
Return Values
array
Felamimail_Frontend_Json::getVacationMessage
Description
public getVacationMessage (array $vacationData)
get vacation message defined by template / do substitutions for dates and representative
Parameters
(array) $vacationData
Return Values
array
Felamimail_Frontend_Json::getVacationMessageTemplates
Description
public getVacationMessageTemplates (void)
get available vacation message templates
Parameters
This function has no parameters.
Return Values
array
Felamimail_Frontend_Json::importMessage
Description
public importMessage ( $targetFolderId, $tempFile)
import message into target folder
Parameters
() $targetFolderId() $tempFile
Return Values
void
Felamimail_Frontend_Json::moveFolder
Description
public moveFolder (string $newGlobalName, string $oldGlobalName, string $accountId)
move folder
Parameters
(string) $newGlobalName(string) $oldGlobalName(string) $accountId
Return Values
array
Felamimail_Frontend_Json::moveMessages
Description
public moveMessages (array $filterData, string $targetFolderId, bool $keepOriginalMessages)
move messages to folder
Parameters
(array) $filterData: filter data(string) $targetFolderId(bool) $keepOriginalMessages
Return Values
array
source folder status
Felamimail_Frontend_Json::processSpam
Description
processSpam (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::refreshFolder
Description
public refreshFolder (string $folderId)
refresh folder
Parameters
(string) $folderId: the folder id to delete
Return Values
array
Felamimail_Frontend_Json::renameFolder
Description
public renameFolder (string $newName, string $oldGlobalName, string $accountId)
rename folder
Parameters
(string) $newName(string) $oldGlobalName(string) $accountId
Return Values
array
Felamimail_Frontend_Json::saveAccount
Description
public saveAccount (array $recordData)
creates/updates a record
Parameters
(array) $recordData
Return Values
array
created/updated record
Felamimail_Frontend_Json::saveDraft
Description
saveDraft (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::saveMessage
Description
public saveMessage (array $recordData)
save + send message
- this function has to be named 'saveMessage' because of the generic edit dialog function names
Parameters
(array) $recordData
Return Values
array
Felamimail_Frontend_Json::saveMessageInFolder
Description
public saveMessageInFolder (string $folderName, array $recordData)
save message in folder
Parameters
(string) $folderName(array) $recordData
Return Values
array
Felamimail_Frontend_Json::saveRules
Description
public saveRules (array $accountId, array $rulesData)
set sieve rules for account
Parameters
(array) $accountId(array) $rulesData
Return Values
array
Felamimail_Frontend_Json::saveSieveCustomScript
Description
public saveSieveCustomScript ( $scriptData)
set sieve custom script for account
Parameters
() $scriptData
Return Values
string
Felamimail_Frontend_Json::saveVacation
Description
public saveVacation (array $recordData)
set sieve vacation for account
Parameters
(array) $recordData
Return Values
array
Felamimail_Frontend_Json::searchAccounts
Description
searchAccounts (void)
Parameters
This function has no parameters.
Return Values
void
Felamimail_Frontend_Json::searchFolders
Description
public searchFolders (array $filter)
search folders and update/initialize cache of subfolders
Parameters
(array) $filter
Return Values
array
Felamimail_Frontend_Json::searchMessages
Description
public searchMessages (array $filter, array $paging)
search messages in message cache
Parameters
(array) $filter(array) $paging
Return Values
array
Felamimail_Frontend_Json::sendReadingConfirmation
Description
public sendReadingConfirmation (string $messageId)
send reading confirmation
Parameters
(string) $messageId
Return Values
array
Felamimail_Frontend_Json::testIMapSettings
Description
public testIMapSettings ( $accountId, $fields, bool $forceConnect)
test imap settings
Parameters
() $accountId() $fields(bool) $forceConnect
Return Values
array
Throws Exceptions
\Tinebase_Exception_SystemGeneric
Felamimail_Frontend_Json::testSmtpSettings
Description
public testSmtpSettings ( $accountId, $fields, bool $forceConnect)
test smtp settings
Parameters
() $accountId() $fields(bool) $forceConnect
Return Values
array
Throws Exceptions
\Tinebase_Exception_SystemGeneric
\Zend_Exception
Felamimail_Frontend_Json::updateFlags
Description
public updateFlags (string $folderId, int $time)
update flags - use session/writeClose to allow following requests
Parameters
(string) $folderId: id of active folder(int) $time: update time in seconds
Return Values
array
Felamimail_Frontend_Json::updateFolderCache
Description
public updateFolderCache (string $accountId, string $folderName)
update folder cache
Parameters
(string) $accountId(string) $folderName: of parent folder
Return Values
array
of (sub)folders in cache
Felamimail_Frontend_Json::updateMessageCache
Description
public updateMessageCache (string $folderId, int $time)
update message cache - use session/writeClose to update incomplete cache and allow following requests
Parameters
(string) $folderId: id of active folder(int) $time: update time in seconds
Return Values
array