Package com.logicaldoc.core.automation

Class MailTool

  • public class MailTool
extends Object
    Utility functions to handle emails and send messages from within the Automation
    Since:
    7.5.1
    Author:
    Marco Meschieri - LogicalDOC

    • Constructor Detail

      • MailTool

        public MailTool()

    • Method Detail

      • sendDocuments

        public void sendDocuments​(Collection<Document> documents,
                          String from,
                          String to,
                          String subject,
                          String message)
                   throws Exception
        Sends some documents to a recipient
        Parameters:
        documents - collection of documents to send
        from - the email address to be used as From
        to - the email address of the recipient
        subject - subject of the email
        message - message printed in the body of the email
        Throws:
        Exception - error sending the email

      • sendDocuments

        public void sendDocuments​(Collection<Document> documents,
                          String from,
                          Collection<String> to,
                          String subject,
                          String message)
                   throws Exception
        Sends some documents to a selection of recipients
        Parameters:
        documents - collection of documents to send
        from - the email address to be used as From
        to - collection of email addresses to send the email to
        subject - subject of the email
        message - message printed in the body of the email
        Throws:
        Exception - error sending the email

      • sendDocument

        public void sendDocument​(Document document,
                         String from,
                         String to,
                         String subject,
                         String message)
                  throws Exception
        Sends a document by email to a recipient
        Parameters:
        document - the document to send
        from - the email address to be used as From
        to - email addresses of the recipient
        subject - subject of the email
        message - message printed in the body of the email
        Throws:
        Exception - error sending the email

      • sendDocument

        public void sendDocument​(Document document,
                         String from,
                         Collection<String> to,
                         String subject,
                         String message)
                  throws Exception
        Sends a document by email to a selection of recipients
        Parameters:
        document - the document to send
        from - the email address to be used as From
        to - collection of email addresses to send the email to
        subject - subject of the email
        message - message printed in the body of the email
        Throws:
        Exception - error sending the email

      • sendMessage

        public void sendMessage​(long tenantId,
                        String from,
                        Collection<String> to,
                        String subject,
                        String message)
                 throws Exception
        Sends a simple email to a selection of recipients
        Parameters:
        tenantId - identifier of the tenant
        from - the email address to be used as From
        to - collection of email addresses to send the email to
        subject - subject of the email
        message - message printed in the body of the email
        Throws:
        Exception - error sending the email

      • sendMessage

        public void sendMessage​(long tenantId,
                        String from,
                        String to,
                        String subject,
                        String message)
                 throws Exception
        Sends a simple email to a recipient
        Parameters:
        tenantId - identifier of the tenant
        from - the email address to be used as From
        to - email address of the recipient
        subject - subject of the email
        message - message printed in the body of the email
        Throws:
        Exception - error sending the email

      • documentToEMail

        public EMail documentToEMail​(Document document,
                             boolean extractAttachments)
                      throws Exception
        Creates an EMail object given the document that stores an email message.
        Parameters:
        document - the document that contains the email(must be a .eml or a .msg)
        extractAttachments - if the attachments binaries have to be extracted
        Returns:
        The object representation of the email
        Throws:
        Exception - the email cannot be correctly analyzed

      • sendSystemMessage

        public void sendSystemMessage​(String recipient,
                              String message,
                              String subject,
                              int scope,
                              int priority)
                       throws Exception
        Sends a system message to a user
        Parameters:
        recipient - username of the recipient
        message - body of the message
        subject - subject of the message
        scope - number of days the message will stay active before expiring
        priority - a priority: 0 = low, 1 = medium, 2 = high
        Throws:
        Exception - If an error occurs

      • extractAttachments

        public List<Document> extractAttachments​(Document doc,
                                         String filterFileName,
                                         String username)
        Extracts attachments of email files (.eml, .msg) in the current folder
        Parameters:
        doc - the document
        filterFileName - a filter on the extensions of the attachment to be extracted (comma separated)
        username - the user that will be impersonated to write the attachments
        Returns:
        a list with the new documents created