JobEntryGetPOP

java.lang.Object
- org.pentaho.di.job.entry.JobEntryBase
- - org.pentaho.di.job.entries.getpop.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.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 Summary

Fields
Modifier and Type Field and Description

int actiontype

int aftergetimap

int conditionReceivedDate

static String DATE_PATTERN

int retrievemails

int valueimaplist

Fields
Modifier and Type	Field and Description
`int`	`actiontype`
`int`	`aftergetimap`
`int`	`conditionReceivedDate`
`static String`	`DATE_PATTERN`
`int`	`retrievemails`
`int`	`valueimaplist`

Constructor Summary

Constructors
Constructor and Description

JobEntryGetPOP()

JobEntryGetPOP(String n)

Constructors
Constructor and Description
`JobEntryGetPOP()`
`JobEntryGetPOP(String n)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)` Allows JobEntry objects to check themselves for consistency
`Object`	`clone()` This method is called when a job entry is duplicated in Spoon.
`boolean`	`evaluates()` This method must return true if the job entry supports the true/false outgoing hops.
`org.pentaho.di.core.Result`	`execute(org.pentaho.di.core.Result previousResult, int nr)` Execute the job entry.
`String`	`geProxyUsername()`
`int`	`getActionType()`
`int`	`getAfterGetIMAP()`
`String`	`getAttachmentFolder()`
`String`	`getAttachmentWildcard()`
`String`	`getBodySearch()`
`int`	`getConditionOnReceivedDate()`
`boolean`	`getDelete()`
`String`	`getFilenamePattern()`
`String`	`getFirstIMAPMails()`
`String`	`getFirstMails()`
`String`	`getIMAPFolder()`
`String`	`getMoveToIMAPFolder()`
`String`	`getOutputDirectory()`
`String`	`getPassword()`
`String`	`getPort()`
`String`	`getProtocol()`
`String`	`getProxyUsername()`
`String`	`getRealFilenamePattern()`
`String`	`getRealFirstMails()`
`String`	`getRealOutputDirectory()`
`String`	`getRealPassword()`
`String`	`getRealPort()`
`String`	`getRealProxyUsername()`
`String`	`getRealServername()`
`String`	`getRealUsername()`
`String`	`getReceipientSearch()`
`String`	`getReceivedDate1()`
`String`	`getReceivedDate2()`
`List<ResourceReference>`	`getResourceDependencies(JobMeta jobMeta)` Gets a list of all the resource dependencies that the step is depending on.
`int`	`getRetrievemails()`
`String`	`getSenderSearchTerm()`
`String`	`getServerName()`
`String`	`getSubjectSearch()`
`String`	`getUserName()`
`int`	`getValueImapList()`
`String`	`getXML()` This method is called by PDI whenever a job entry needs to serialize its settings to XML.
`boolean`	`isCreateLocalFolder()`
`boolean`	`isCreateMoveToFolder()`
`boolean`	`isDifferentFolderForAttachment()`
`boolean`	`isIncludeSubFolders()`
`boolean`	`isNotTermBodySearch()`
`boolean`	`isNotTermReceipientSearch()`
`boolean`	`isNotTermReceivedDateSearch()`
`boolean`	`isNotTermSenderSearch()`
`boolean`	`isNotTermSubjectSearch()`
`boolean`	`isSaveAttachment()`
`boolean`	`isSaveMessage()`
`boolean`	`isUseProxy()`
`boolean`	`isUseSSL()`
`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)` This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
`void`	`loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore)` This method is called by PDI whenever a job entry needs to read its settings from XML.
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_job)` This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
`void`	`setActionType(int actiontype)`
`void`	`setAfterGetIMAP(int afterget)`
`void`	`setAttachmentFolder(String foldername)`
`void`	`setAttachmentWildcard(String wildcard)`
`void`	`setBodySearch(String bodySearch)`
`void`	`setConditionOnReceivedDate(int conditionReceivedDate)`
`void`	`setCreateLocalFolder(boolean createfolder)`
`void`	`setCreateMoveToFolder(boolean createfolder)`
`void`	`setDelete(boolean delete)`
`void`	`setDifferentFolderForAttachment(boolean usedifferentfolder)`
`void`	`setFilenamePattern(String filenamepattern)`
`void`	`setFirstIMAPMails(String firstmails)`
`void`	`setFirstMails(String firstmails)`
`void`	`setIMAPFolder(String folder)`
`void`	`setIncludeSubFolders(boolean includesubfolders)`
`void`	`setMoveToIMAPFolder(String foldername)`
`void`	`setNotTermBodySearch(boolean notTermBodySearch)`
`void`	`setNotTermReceipientSearch(boolean notTermReceipientSearch)`
`void`	`setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)`
`void`	`setNotTermSenderSearch(boolean notTermSenderSearch)`
`void`	`setNotTermSubjectSearch(boolean notTermSubjectSearch)`
`void`	`setOutputDirectory(String outputdirectory)`
`void`	`setPassword(String password)`
`void`	`setPort(String sslport)`
`void`	`setProtocol(String protocol)`
`void`	`setProxyUsername(String username)`
`void`	`setReceipientSearch(String receipientSearch)`
`void`	`setReceivedDate1(String inputDate)`
`void`	`setReceivedDate2(String inputDate)`
`void`	`setRetrievemails(int nr)` 0 = retrieve all 2 = retrieve unread
`void`	`setSaveAttachment(boolean saveattachment)`
`void`	`setSaveMessage(boolean savemessage)`
`void`	`setSenderSearchTerm(String senderSearch)`
`void`	`setServerName(String servername)`
`void`	`setSubjectSearch(String subjectSearch)`
`void`	`setUseProxy(boolean useprox)`
`void`	`setUserName(String username)`
`void`	`setUseSSL(boolean usessl)`
`void`	`setValueImapList(int value)`

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - actiontype
```
public int actiontype
```
  - conditionReceivedDate
```
public int conditionReceivedDate
```
  - valueimaplist
```
public int valueimaplist
```
  - aftergetimap
```
public int aftergetimap
```
  - retrievemails
```
public int retrievemails
```
  - DATE_PATTERN
```
public static final String DATE_PATTERN
```
    See Also:
    Constant Field Values
- 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 -
See Also:: #setValueImapList(int)}

getRetrievemails
```
public int getRetrievemails()
```

getFilenamePattern
```
public String getFilenamePattern()
```

getOutputDirectory
```
public String getOutputDirectory()
```

getRealOutputDirectory

public String getRealOutputDirectory()

getRealFilenamePattern

public String getRealFilenamePattern()

getRealUsername
```
public String getRealUsername()
```

getRealServername
```
public String getRealServername()
```

getRealProxyUsername
```
public String getRealProxyUsername()
```

geProxyUsername
```
public String geProxyUsername()
```

getPassword
```
public String getPassword()
```
Returns:
Returns the password.

getRealPassword
```
public String getRealPassword()
```

getAttachmentFolder
```
public String getAttachmentFolder()
```

setAttachmentFolder

public void setAttachmentFolder(String foldername)

setDelete
```
public void setDelete(boolean delete)
```
Parameters:
delete - The delete to set.

getDelete
```
public boolean getDelete()
```
Returns:
Returns the delete.

getProtocol
```
public String getProtocol()
```

setProtocol

public void setProtocol(String protocol)

getIMAPFolder
```
public String getIMAPFolder()
```

setIMAPFolder

public void setIMAPFolder(String folder)

setAttachmentWildcard

public void setAttachmentWildcard(String wildcard)

getAttachmentWildcard
```
public String getAttachmentWildcard()
```

setUseSSL
```
public void setUseSSL(boolean usessl)
```
Parameters:
usessl - The usessl to set.

isUseSSL
```
public boolean isUseSSL()
```
Returns:
Returns the usessl.

isUseProxy
```
public boolean isUseProxy()
```
Returns:
Returns the useproxy.

setUseProxy

public void setUseProxy(boolean useprox)

isSaveAttachment
```
public boolean isSaveAttachment()
```

setProxyUsername

public void setProxyUsername(String username)

getProxyUsername
```
public String getProxyUsername()
```

setSaveAttachment

public void setSaveAttachment(boolean saveattachment)

isSaveMessage
```
public boolean isSaveMessage()
```

setSaveMessage

public void setSaveMessage(boolean savemessage)

setDifferentFolderForAttachment

public void setDifferentFolderForAttachment(boolean usedifferentfolder)

isDifferentFolderForAttachment

public boolean isDifferentFolderForAttachment()

setPassword
```
public void setPassword(String password)
```
Parameters:
password - The password to set.

execute
```
public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result previousResult,
                                 int nr)
                                   throws org.pentaho.di.core.exception.KettleException
```
Description copied from interface: JobEntryInterface

Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:

execute in interface JobEntryInterface

Parameters:
previousResult - the previous result
nr - the number of rows

Returns:
the Result object from execution of this job entry

Throws:

org.pentaho.di.core.exception.KettleException - if any Kettle exceptions occur

evaluates
```
public boolean evaluates()
```
Description copied from class: JobEntryBase

This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:

evaluates in interface JobEntryInterface

Overrides:

evaluates in class JobEntryBase

Returns:
false

check
```
public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
         JobMeta jobMeta,
         org.pentaho.di.core.variables.VariableSpace space,
         Repository repository,
         org.pentaho.metastore.api.IMetaStore metaStore)
```
Description copied from class: JobEntryBase

Allows JobEntry objects to check themselves for consistency

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:
remarks - List of CheckResult objects indicating consistency status
jobMeta - the metadata object for the job entry
space - the variable space to resolve string expressions with variables with
repository - the repository to load Kettle objects from
metaStore - the MetaStore to load common elements from

getResourceDependencies
```
public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
```
Description copied from class: JobEntryBase

Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:
an empty list of ResourceReferences
See Also:
ResourceReference

Class JobEntryGetPOP

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

Field Detail

actiontype

conditionReceivedDate

valueimaplist

aftergetimap

retrievemails

DATE_PATTERN

Constructor Detail

JobEntryGetPOP

JobEntryGetPOP

Method Detail

clone

getXML

loadXML

getValueImapList

setValueImapList

loadRep

saveRep

getPort

getRealPort

setPort

setFirstMails

getFirstMails

isIncludeSubFolders

setIncludeSubFolders

setFirstIMAPMails

getFirstIMAPMails

setSenderSearchTerm

getSenderSearchTerm

setNotTermSenderSearch

isNotTermSenderSearch

setNotTermSubjectSearch

setNotTermBodySearch

isNotTermSubjectSearch

isNotTermBodySearch

setNotTermReceivedDateSearch

isNotTermReceivedDateSearch

setNotTermReceipientSearch

isNotTermReceipientSearch

setCreateMoveToFolder

isCreateMoveToFolder

setReceipientSearch

getReceipientSearch

setSubjectSearch

getSubjectSearch

setBodySearch

getBodySearch

getReceivedDate1

setReceivedDate1

getReceivedDate2

setReceivedDate2

setMoveToIMAPFolder

getMoveToIMAPFolder

setCreateLocalFolder

isCreateLocalFolder

setConditionOnReceivedDate

getConditionOnReceivedDate

setActionType

getActionType

setAfterGetIMAP

getAfterGetIMAP

getRealFirstMails

setServerName

getServerName

setUserName

getUserName

setOutputDirectory

setFilenamePattern

setRetrievemails

getRetrievemails

getFilenamePattern

getOutputDirectory

getRealOutputDirectory