PHP ```php class Plugin extends \RainLoop\Plugins\AbstractPlugin { public function __construct(); public function Name() : string; public function Description() : string; public function UseLangs(?bool $bLangs = null) : bool; public function Supported() : string; public function Init() : void; public function FilterAppDataPluginSection(bool $bAdmin, bool $bAuth, array &$aConfig) : void; protected function configMapping() : array; } ``` JavaScript ```javascript class PluginPopupView extends rl.pluginPopupView { // Happens when DOM is created onBuild(dom) {} // Happens before showModal() beforeShow(...params) {} // Happens after showModal() onShow(...params) {} // Happens after showModal() animation transitionend afterShow() {} // Happens when user hits Escape or Close key // return false to prevent closing, use close() manually onClose() {} // Happens before animation transitionend onHide() {} // Happens after animation transitionend afterHide() {} } PluginPopupView.showModal(); ``` # Hooks ```php $Plugin->addHook('hook.name', 'functionName'); ``` ## Login ### login.credentials.step-1 params: string &$sEmail ### login.credentials.step-2 params: string &$sEmail string &$sPassword ### login.credentials params: string &$sEmail string &$sLogin string &$sPassword ### login.success params: \RainLoop\Model\Account $oAccount ## IMAP ### imap.before-connect params: \RainLoop\Model\Account $oAccount \MailSo\Imap\ImapClient $oImapClient array &$aCredentials ### imap.after-connect params: \RainLoop\Model\Account $oAccount \MailSo\Imap\ImapClient $oImapClient array $aCredentials ### imap.before-login params: \RainLoop\Model\Account $oAccount \MailSo\Imap\ImapClient $oImapClient array &$aCredentials ### imap.after-login params: \RainLoop\Model\Account $oAccount \MailSo\Imap\ImapClient $oImapClient bool $bSuccess array $aCredentials ## Sieve ### sieve.before-connect params: \RainLoop\Model\Account $oAccount \MailSo\Sieve\ManageSieveClient $oSieveClient array &$aCredentials ### sieve.after-connect params: \RainLoop\Model\Account $oAccount \MailSo\Sieve\ManageSieveClient $oSieveClient array $aCredentials ### sieve.before-login params: \RainLoop\Model\Account $oAccount \MailSo\Sieve\ManageSieveClient $oSieveClient array &$aCredentials ### sieve.after-login params: \RainLoop\Model\Account $oAccount \MailSo\Sieve\ManageSieveClient $oSieveClient bool $bSuccess array $aCredentials ## SMTP ### smtp.before-connect params: \RainLoop\Model\Account $oAccount \MailSo\Smtp\SmtpClient $oSmtpClient array &$aCredentials ### smtp.after-connect params: \RainLoop\Model\Account $oAccount \MailSo\Smtp\SmtpClient $oSmtpClient array $aCredentials ### smtp.before-login params: \RainLoop\Model\Account $oAccount \MailSo\Smtp\SmtpClient $oSmtpClient array &$aCredentials ### smtp.after-login params: \RainLoop\Model\Account $oAccount \MailSo\Smtp\SmtpClient $oSmtpClient bool $bSuccess array $aCredentials ## Folders ### filter.folders-post params: \RainLoop\Model\Account $oAccount \MailSo\Mail\FolderCollection $oFolderCollection ### filter.folders-complete params: \RainLoop\Model\Account $oAccount \MailSo\Mail\FolderCollection $oFolderCollection ### filter.folders-system-types params: \RainLoop\Model\Account $oAccount array &$aList ### filter.system-folders-names params: \RainLoop\Model\Account $oAccount array &$aCache ## Others ### filter.account params: \RainLoop\Model\Account $oAccount ### filter.action-params params: string $sMethodName array &$aCurrentActionParams ### filter.app-data params: bool $bAdmin array &$aAppData ### filter.application-config params: \RainLoop\Config\Application $oConfig ### filter.build-message params: \MailSo\Mime\Message $oMessage Happens before send/save message ### filter.build-read-receipt-message params: \MailSo\Mime\Message $oMessage \RainLoop\Model\Account $oAccount ### filter.domain params: \RainLoop\Model\Domain &$oDomain ### filter.fabrica params: string $sName mixed &$mResult \RainLoop\Model\Account $oAccount ### filter.http-paths params: array &$aPaths ### filter.json-response params: string $sAction array &$aResponseItem ### filter.message-html params: \RainLoop\Model\Account $oAccount \MailSo\Mime\Message $oMessage string &$sTextConverted Happens before send/save message ### filter.message-plain params: \RainLoop\Model\Account $oAccount \MailSo\Mime\Message $oMessage string &$sTextConverted Happens before send/save message ### filter.message-rcpt params: \RainLoop\Model\Account $oAccount \MailSo\Mime\EmailCollection $oRcpt ### filter.read-receipt-message-plain params: \RainLoop\Model\Account $oAccount \MailSo\Mime\Message $oMessage string &$sText ### filter.result-message params: \MailSo\Mime\Message $oMessage Happens when reading message ### filter.save-message params: \MailSo\Mime\Message $oMessage Happens before save message ### filter.send-message params: \MailSo\Mime\Message $oMessage Happens before send message ### filter.send-message-stream params: \RainLoop\Model\Account $oAccount resource &$rMessageStream int &$iMessageStreamSize ### filter.send-read-receipt-message params: \MailSo\Mime\Message $oMessage \RainLoop\Model\Account $oAccount ### filter.smtp-from params: \RainLoop\Model\Account $oAccount \MailSo\Mime\Message $oMessage string &$sFrom ### filter.smtp-hidden-rcpt params: \RainLoop\Model\Account $oAccount \MailSo\Mime\Message $oMessage array &$aHiddenRcpt ### filter.smtp-message-stream params: \RainLoop\Model\Account $oAccount resource &$rMessageStream int &$iMessageStreamSize ### filter.upload-response params: array &$aResponseItem ### json.action-post-call params: string $sAction array &$aResponseItem ### json.action-pre-call params: string $sAction ### json.attachments params: \SnappyMail\AttachmentsAction $oData ### json.suggestions-input-parameters params: string &$sQuery int &$iLimit \RainLoop\Model\Account $oAccount ### json.suggestions-post params: array &$aResult string $sQuery \RainLoop\Model\Account $oAccount int $iLimit ### json.suggestions-pre params: array &$aResult string $sQuery \RainLoop\Model\Account $oAccount int $iLimit ### main.content-security-policy params: \SnappyMail\HTTP\CSP $oCSP Allows you to edit the policy, like: `$oCSP->script[] = "'strict-dynamic'";` ### main.default-response params: string $sActionName array &$aResponseItem ### main.default-response-data params: string $sActionName mixed &$mResult ### main.default-response-error-data params: string $sActionName int &$iErrorCode string &$sErrorMessage ### main.fabrica params: string $sName mixed &$mResult ### service.app-delay-start-begin no params ### service.app-delay-start-end no params # JavaScript Events ## mailbox ### mailbox.inbox-unread-count ### mailbox.message-list.selector.go-up ### mailbox.message-list.selector.go-down ### mailbox.message.show ## audio ### audio.start ### audio.stop ### audio.api.stop ## Misc ### idle ### rl-layout ### rl-view-model event.detail = the ViewModel class ### sm-admin-login event.detail = FormData cancelable using preventDefault() ### sm-admin-login-response event.detail = { error: int, data: {JSON response} } ### sm-user-login event.detail = FormData cancelable using preventDefault() ### sm-user-login-response event.detail = { error: int, data: {JSON response} } ### sm-show-screen event.detail = 'screenname' cancelable using preventDefault()