Package org.pentaho.di.job.entries.getpop

Class JobEntryGetPOP

  • All Implemented Interfaces:
    Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
    public class JobEntryGetPOP
extends JobEntryBase
implements Cloneable, JobEntryInterface
    This defines an get pop job entry.
    Since:
    01-03-2007
    Author:
    Samatar

    • Field Detail

      • actiontype

        public int actiontype

      • conditionReceivedDate

        public int conditionReceivedDate

      • valueimaplist

        public int valueimaplist

      • aftergetimap

        public int aftergetimap

      • retrievemails

        public int retrievemails

    • Constructor Detail

      • JobEntryGetPOP

        public JobEntryGetPOP​(String n)

      • JobEntryGetPOP

        public JobEntryGetPOP()

    • Method Detail

      • clone

        public Object clone()
        Description copied from class: JobEntryBase
        This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.
        Specified by:
        clone in interface JobEntryInterface
        Overrides:
        clone in class JobEntryBase
        Returns:
        a clone of the object

      • getXML

        public String getXML()
        Description copied from class: JobEntryBase
        This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.
        Specified by:
        getXML in interface JobEntryInterface
        Overrides:
        getXML in class JobEntryBase
        Returns:
        the xml representation of the job entry

      • loadXML

        public void loadXML​(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.
        Specified by:
        loadXML in interface JobEntryInterface
        Overrides:
        loadXML in class JobEntryBase
        Parameters:
        entrynode - the top-level XML node
        databases - the list of databases
        slaveServers - the list of slave servers
        rep - the repository object
        metaStore - The metaStore to optionally load from.
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

      • getValueImapList

        public int getValueImapList()

      • setValueImapList

        public void setValueImapList​(int value)

      • loadRep

        public void loadRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
        Specified by:
        loadRep in interface JobEntryInterface
        Overrides:
        loadRep in class JobEntryBase
        Parameters:
        rep - the repository object
        metaStore - the MetaStore to use
        id_jobentry - the id of the job entry
        databases - the list of databases
        slaveServers - the list of slave servers
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the load

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
        Specified by:
        saveRep in interface JobEntryInterface
        Overrides:
        saveRep in class JobEntryBase
        Parameters:
        rep - the repository
        metaStore - the MetaStore to use
        id_job - the id_job
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the save

      • getPort

        public String getPort()

      • getRealPort

        public String getRealPort()

      • setPort

        public void setPort​(String sslport)

      • setFirstMails

        public void setFirstMails​(String firstmails)

      • getFirstMails

        public String getFirstMails()

      • isIncludeSubFolders

        public boolean isIncludeSubFolders()

      • setIncludeSubFolders

        public void setIncludeSubFolders​(boolean includesubfolders)

      • setFirstIMAPMails

        public void setFirstIMAPMails​(String firstmails)

      • getFirstIMAPMails

        public String getFirstIMAPMails()

      • setSenderSearchTerm

        public void setSenderSearchTerm​(String senderSearch)

      • getSenderSearchTerm

        public String getSenderSearchTerm()

      • setNotTermSenderSearch

        public void setNotTermSenderSearch​(boolean notTermSenderSearch)

      • isNotTermSenderSearch

        public boolean isNotTermSenderSearch()

      • setNotTermSubjectSearch

        public void setNotTermSubjectSearch​(boolean notTermSubjectSearch)

      • setNotTermBodySearch

        public void setNotTermBodySearch​(boolean notTermBodySearch)

      • isNotTermSubjectSearch

        public boolean isNotTermSubjectSearch()

      • isNotTermBodySearch

        public boolean isNotTermBodySearch()

      • setNotTermReceivedDateSearch

        public void setNotTermReceivedDateSearch​(boolean notTermReceivedDateSearch)

      • isNotTermReceivedDateSearch

        public boolean isNotTermReceivedDateSearch()

      • setNotTermReceipientSearch

        public void setNotTermReceipientSearch​(boolean notTermReceipientSearch)

      • isNotTermReceipientSearch

        public boolean isNotTermReceipientSearch()

      • setCreateMoveToFolder

        public void setCreateMoveToFolder​(boolean createfolder)

      • isCreateMoveToFolder

        public boolean isCreateMoveToFolder()

      • setReceipientSearch

        public void setReceipientSearch​(String receipientSearch)

      • getReceipientSearch

        public String getReceipientSearch()

      • setSubjectSearch

        public void setSubjectSearch​(String subjectSearch)

      • getSubjectSearch

        public String getSubjectSearch()

      • setBodySearch

        public void setBodySearch​(String bodySearch)

      • getBodySearch

        public String getBodySearch()

      • getReceivedDate1

        public String getReceivedDate1()

      • setReceivedDate1

        public void setReceivedDate1​(String inputDate)

      • getReceivedDate2

        public String getReceivedDate2()

      • setReceivedDate2

        public void setReceivedDate2​(String inputDate)

      • setMoveToIMAPFolder

        public void setMoveToIMAPFolder​(String foldername)

      • getMoveToIMAPFolder

        public String getMoveToIMAPFolder()

      • setCreateLocalFolder

        public void setCreateLocalFolder​(boolean createfolder)

      • isCreateLocalFolder

        public boolean isCreateLocalFolder()

      • setConditionOnReceivedDate

        public void setConditionOnReceivedDate​(int conditionReceivedDate)

      • getConditionOnReceivedDate

        public int getConditionOnReceivedDate()

      • setActionType

        public void setActionType​(int actiontype)

      • getActionType

        public int getActionType()

      • setAfterGetIMAP

        public void setAfterGetIMAP​(int afterget)

      • getAfterGetIMAP

        public int getAfterGetIMAP()

      • getRealFirstMails

        public String getRealFirstMails()

      • setServerName

        public void setServerName​(String servername)

      • getServerName

        public String getServerName()

      • setUserName

        public void setUserName​(String username)

      • getUserName

        public String getUserName()

      • setOutputDirectory

        public void setOutputDirectory​(String outputdirectory)

      • setFilenamePattern

        public void setFilenamePattern​(String filenamepattern)

      • setRetrievemails

        public void setRetrievemails​(int nr)
      • 0 = retrieve all
      • 2 = retrieve unread
Parameters:
nr -