Class EmailsController
PHP controller that handles the admin/emails page operations. You can also use it to perform email operations from JavaScript by providing encoded JSON arrays with email information from other pages.
| category |
System |
|---|---|
| package |
AdminHttpViewControllers |
__construct(\HttpContextReaderInterface $httpContextReader, \HttpResponseProcessorInterface $httpResponseProcessor, \ContentViewInterface $defaultContentView)
\HttpContextReaderInterface
\HttpResponseProcessorInterface
\ContentViewInterface
actionDataTable() : \JsonHttpControllerResponse
The data returned by this method will be used by the main table of the page which will display the emails records. DataTables will automatically make an AJAX request and display the returned data.
| link | |
|---|---|
\JsonHttpControllerResponseArray that contains the table data.
actionDefault() : \HttpControllerResponseInterface
Every controller child class requires at least the default action method, which is invoked when the ::_getQueryParameterData('do') value is not separated by a trailing slash.
Every action method have to return an instance which implements the http controller response interface.
\HttpControllerResponseInterface
actionDelete() : \JsonHttpControllerResponse
Will remove all the email records inside the $_POST['collection'] variable.
\JsonHttpControllerResponseReturns a success response or exception information.
actionDeleteAttachment() : \JsonHttpControllerResponse
This method requires an array present in the $postDataArray that contain the paths to the server "tmp" attachments to be removed. It will not remove attachments that reside in other directories because they might be used by other email records (e.g. forward existing email with attachments -> user might remove attachment that is used by the original email record causing problems to the system).
\JsonHttpControllerResponseReturns a success response or exception information.
actionDeleteOldAttachments() : \JsonHttpControllerResponse
This method will filter the emails and remove their attachments on the provided date and before. This is necessary because the admin user needs a way to clean the old unnecessary files from the server and free some extra space. As an extra action this method will empty the "uploads/tmp" directory.
\JsonHttpControllerResponseReturns a success response or exception information.
actionDeleteOldEmails() : \JsonHttpControllerResponse
This method will delete emails on the provided date and before.
\JsonHttpControllerResponseReturns a success response or exception information.
actionDownloadAttachment() : \HttpControllerResponse|\AdminPageHttpControllerResponse
This method will provide the required headers for downloading the requested attachment file.
If the requested file is was not found then an error message will be displayed.
\HttpControllerResponse|\AdminPageHttpControllerResponse
actionGet() : \JsonHttpControllerResponse
This method uses the provided $_POST['email_id'] value to fetch the data of the email and return it to the client. It is not used by the admin/emails page but might be useful in other pages.
\JsonHttpControllerResponseReturns a success response or exception information.
actionGetAttachmentsSize() : \JsonHttpControllerResponse
actionGetEmailSettings() : \JsonHttpControllerResponse
actionQueue() : \JsonHttpControllerResponse
The queue operation will save the email with a pending status. Queue operation will be executed for all the email records inside the $_POST['collection'] variable.
\JsonHttpControllerResponseReturns a success response or exception information.
actionSend() : \JsonHttpControllerResponse
This method expects the $_POST['collection'] array to be present, containing email records to be send. Check the "EmailParser" class to see the expected JSON format.
\JsonHttpControllerResponseReturns a success response or exception information.
actionUploadAttachment() : \JsonHttpControllerResponse
The $_FILES array contains information about the file that was uploaded. When an email file is uploaded it is stored in the "uploads/tmp" directory until the email is created and then is is moved to its own directory. The reason for this algorithm is that we do not want email attachments to be in one place altogether.
\JsonHttpControllerResponseReturns a success response or exception information.
actionUploadAttachmentWithFileManager() : \JsonHttpControllerResponse
proceed(\HttpContextInterface $httpContext)
The action method is determined by the http context reader instance and the current request context. Re-implement this method in child classes to enable XSS and CSRF protection on demand.
| see | \HttpContextReaderInterface::getActionName \HttpResponseProcessorInterface::proceed |
|---|---|
| Throws |
|
validateCurrentAdminStatus()
| Throws |
|
|---|