Class AttachmentsHandlerInterface
| category |
System |
|---|---|
| package |
|
| subpackage |
Interfaces |
backupEmailAttachments(\EmailInterface &$email)
This method will move all the email attachments to the "uploads/attachments" directory and store them there for future reference and history navigation purposes. The email needs to be saved first because the email ID will be used to distinguish the emails.
deleteAttachment(\EmailAttachmentInterface $attachment)
deleteEmailAttachments(\EmailInterface $email)
This method will remove all the email attachments from the server.
deleteEmailCollection(\EmailCollectionInterface $collection)
Every email has its own attachments directory. When emails are deleted we need to remove their respective attachments.
| deprecated |
Since v2.3.3.0 this method is marked as deprecated and will be removed from the class. |
|---|---|
deleteOldAttachments(\DateTime $removalDate) : array
This method will remove all the files and directories that are prior to the given date. It will return removal information so that user can see how much disc spaces was set free.
\DateTimeFrom this date and before the attachment files will be removed.
arrayReturns an array which contains the "count" and "size" values or the operation.
emptyTempDirectory()
There might be cases where old unused files are left within the "tmp" directory and they need to be deleted. This function will remove all these files.
getAttachmentsSize() : integer
integerReturns the size in bytes.
uploadAttachment(\EmailAttachmentInterface $attachment) : \EmailAttachment
This method takes the uploaded file information and places it in the "uploads/tmp" directory as a temporary place, until the "uploadEmailCollection" moves it to the final destination.
\EmailAttachmentReturns an EmailAttachment instance with the new attachment path.
uploadEmailCollection(\EmailCollectionInterface $collection)
Important! Use this method after you save the emails into the database. The reason is that this property separates each attachment file by its email ID, a value that is only accessible after the email is already saved.
| deprecated |
Since v2.3.3.0 this method is marked as deprecated and will be removed from the class. |
|---|---|
\EmailCollectionInterfacePassed by reference, contains emails of which the attachments must be processed.