Package com.logicaldoc.email

Class EmailCrawler

java.lang.Object
com.logicaldoc.core.task.Task
com.logicaldoc.email.EmailCrawler
All Implemented Interfaces:
Runnable
Direct Known Subclasses:
VIAEmailCrawler
@Component("emailCrawler") public class EmailCrawler extends com.logicaldoc.core.task.Task
This component downloads new e-mails from one or more e-mail accounts
Since:
4.0
Author:
Matteo Caruso - LogicalDOC

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COUNTER_SEQUENCE
     
    static final String
    NAME
     

    Fields inherited from class com.logicaldoc.core.task.Task

    STATUS_IDLE, STATUS_RUNNING, STATUS_STOPPING

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultOwner()
     
    static javax.mail.Store
    getStore(EmailAccount account)
     
    boolean
    isConcurrent()
     
    boolean
    isIndeterminate()
     
    void
    processEmails(String owner)
    Downloads all new mails from all accounts.
    void
    receive(EmailAccount account, String username)
     
    void
    setDefaultOwner(String defaultOwner)
     

    Methods inherited from class com.logicaldoc.core.task.Task

    addTaskListener, getCompletionPercentage, getConfig, getName, getProgress, getReportRecipients, getScheduling, getSize, getStatus, interrupt, isInterrupted, isInterruptRequested, isRunning, isSendActivityReport, notifyReport, removeTaskListener, run, save, saveWork, setReportRecipients, setSendActivityReport, setSize

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • getDefaultOwner

      public String getDefaultOwner()

    • setDefaultOwner

      public void setDefaultOwner(String defaultOwner)

    • processEmails

      public void processEmails(String owner)
      Downloads all new mails from all accounts. The stored document will be owned by the specified username
      Parameters:
      owner - the username of the owner of the downloaded messages

    • getStore

      public static javax.mail.Store getStore(EmailAccount account) throws javax.mail.MessagingException, IOException
      Throws:
      javax.mail.MessagingException
      IOException

    • receive

      public void receive(EmailAccount account, String username) throws javax.mail.MessagingException, IOException
      Throws:
      javax.mail.MessagingException
      IOException

    • isIndeterminate

      public boolean isIndeterminate()
      Specified by:
      isIndeterminate in class com.logicaldoc.core.task.Task

    • isConcurrent

      public boolean isConcurrent()
      Specified by:
      isConcurrent in class com.logicaldoc.core.task.Task