org.pentaho.di.trans.steps.mailinput
Class MailInputMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.mailinput.MailInputMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class MailInputMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
 int conditionReceivedDate
           
static String DATE_PATTERN
           
 int retrievemails
           
 int valueimaplist
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
MailInputMeta()
           
 
Method Summary
 void allocate(int nrfields)
           
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
          Checks the settings of this step and puts the findings in a remarks List.
 Object clone()
          Make an exact copy of this step, make sure to explicitly copy Collections etc.
 int getConditionOnReceivedDate()
           
 boolean getDelete()
           
 void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Get the fields that are emitted by this step
 String getFirstIMAPMails()
           
 String getFirstMails()
           
 String getFolderField()
           
 String getIMAPFolder()
           
 MailInputField[] getInputFields()
           
 String getPassword()
           
 String getPort()
           
 String getProtocol()
           
 String getProxyUsername()
           
 String getReceivedDate1()
           
 String getReceivedDate2()
           
 String getRecipientSearch()
           
 int getRetrievemails()
           
 String getRowLimit()
           
 String getSenderSearchTerm()
           
 String getServerName()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
          Get the executing step, needed by Trans to launch a step.
 StepDataInterface getStepData()
          Get a new instance of the appropriate data class.
 String getSubjectSearch()
           
 String getUserName()
           
 int getValueImapList()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isDynamicFolder()
           
 boolean isIncludeSubFolders()
           
 boolean isNotTermReceivedDateSearch()
           
 boolean isNotTermRecipientSearch()
           
 boolean isNotTermSenderSearch()
           
 boolean isNotTermSubjectSearch()
           
 boolean isUseProxy()
           
 boolean isUseSSL()
           
 void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Load the values for this step from an XML Node
 void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Read the steps information from a Kettle repository
 void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step)
          Save the steps data into a Kettle repository
 void setConditionOnReceivedDate(int conditionReceivedDate)
           
 void setDefault()
          Set default values
 void setDelete(boolean delete)
           
 void setDynamicFolder(boolean usedynamicfolder)
           
 void setFirstIMAPMails(String firstmails)
           
 void setFirstMails(String firstmails)
           
 void setFolderField(String folderfield)
           
 void setIMAPFolder(String folder)
           
 void setIncludeSubFolders(boolean includesubfolders)
           
 void setInputFields(MailInputField[] inputFields)
           
 void setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)
           
 void setNotTermRecipientSearch(boolean notTermRecipientSearch)
           
 void setNotTermSenderSearch(boolean notTermSenderSearch)
           
 void setNotTermSubjectSearch(boolean notTermSubjectSearch)
           
 void setPassword(String password)
           
 void setPort(String sslport)
           
 void setProtocol(String protocol)
           
 void setProxyUsername(String username)
           
 void setReceivedDate1(String inputDate)
           
 void setReceivedDate2(String inputDate)
           
 void setRecipientSearch(String recipientSearch)
           
 void setRetrievemails(int nr)
           
 void setRowLimit(String rowlimit)
           
 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.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, supportsErrorHandling
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling
 

Field Detail

DATE_PATTERN

public static final String DATE_PATTERN
See Also:
Constant Field Values

conditionReceivedDate

public int conditionReceivedDate

valueimaplist

public int valueimaplist

retrievemails

public int retrievemails
Constructor Detail

MailInputMeta

public MailInputMeta()
Method Detail

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException
Description copied from interface: StepMetaInterface
Load the values for this step from an XML Node

Specified by:
loadXML in interface StepMetaInterface
Parameters:
stepnode - the Node to get the info from
databases - The available list of databases to reference to
counters - Counters to reference.
Throws:
KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate(int nrfields)

clone

public Object clone()
Description copied from interface: StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:
clone in interface StepMetaInterface
Overrides:
clone in class BaseStepMeta
Returns:
an exact copy of this step

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException
Description copied from interface: StepMetaInterface
Read the steps information from a Kettle repository

Specified by:
readRep in interface StepMetaInterface
Parameters:
rep - The repository to read from
id_step - The step ID
databases - The databases to reference
counters - The counters to reference
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException
Description copied from interface: StepMetaInterface
Save the steps data into a Kettle repository

Specified by:
saveRep in interface StepMetaInterface
Parameters:
rep - The Kettle repository to save to
id_transformation - The transformation ID
id_step - The step ID
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

getXML

public String getXML()
Description copied from class: BaseStepMeta
Produces the XML string that describes this step's information.

Specified by:
getXML in interface StepMetaInterface
Overrides:
getXML in class BaseStepMeta
Returns:
String containing the XML describing this step.

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)
Description copied from interface: StepMetaInterface
Checks the settings of this step and puts the findings in a remarks List.

Specified by:
check in interface StepMetaInterface
Parameters:
remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
stepMeta - The stepMeta to help checking
prev - The fields coming from the previous step
input - The input step names
output - The output step names
info - The fields that are used as information by the step

getPort

public String getPort()

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)

isUseProxy

public boolean isUseProxy()
Returns:
Returns the useproxy.

setUseProxy

public void setUseProxy(boolean useprox)

setProxyUsername

public void setProxyUsername(String username)

getProxyUsername

public String getProxyUsername()

isDynamicFolder

public boolean isDynamicFolder()
Returns:
Returns the usedynamicfolder.

setDynamicFolder

public void setDynamicFolder(boolean usedynamicfolder)

setRowLimit

public void setRowLimit(String rowlimit)

getRowLimit

public String getRowLimit()

setFolderField

public void setFolderField(String folderfield)

getFolderField

public String getFolderField()

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)

isNotTermSubjectSearch

public boolean isNotTermSubjectSearch()

setNotTermReceivedDateSearch

public void setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)

isNotTermReceivedDateSearch

public boolean isNotTermReceivedDateSearch()

setNotTermRecipientSearch

public void setNotTermRecipientSearch(boolean notTermRecipientSearch)

isNotTermRecipientSearch

public boolean isNotTermRecipientSearch()

setRecipientSearch

public void setRecipientSearch(String recipientSearch)

getRecipientSearch

public String getRecipientSearch()

setSubjectSearch

public void setSubjectSearch(String subjectSearch)

getSubjectSearch

public String getSubjectSearch()

getReceivedDate1

public String getReceivedDate1()

setReceivedDate1

public void setReceivedDate1(String inputDate)

getReceivedDate2

public String getReceivedDate2()

setReceivedDate2

public void setReceivedDate2(String inputDate)

setConditionOnReceivedDate

public void setConditionOnReceivedDate(int conditionReceivedDate)

getConditionOnReceivedDate

public int getConditionOnReceivedDate()

setServerName

public void setServerName(String servername)

getServerName

public String getServerName()

setUserName

public void setUserName(String username)

getUserName

public String getUserName()

setRetrievemails

public void setRetrievemails(int nr)

getRetrievemails

public int getRetrievemails()

getValueImapList

public int getValueImapList()

setValueImapList

public void setValueImapList(int value)

getInputFields

public MailInputField[] getInputFields()
Returns:
Returns the input fields.

setInputFields

public void setInputFields(MailInputField[] inputFields)
Parameters:
inputFields - The input fields to set.

getPassword

public String getPassword()
Returns:
Returns the password.

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)

setUseSSL

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

isUseSSL

public boolean isUseSSL()
Returns:
Returns the usessl.

setPassword

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

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             Trans trans)
Description copied from interface: StepMetaInterface
Get the executing step, needed by Trans to launch a step.

Specified by:
getStep in interface StepMetaInterface
Parameters:
stepMeta - The step info
stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
cnr - The copy nr to get
tr - The transformation info
trans - The launching transformation

getStepData

public StepDataInterface getStepData()
Description copied from interface: StepMetaInterface
Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:
getStepData in interface StepMetaInterface
Returns:
The appropriate StepDataInterface class.

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException
Description copied from interface: StepMetaInterface
Get the fields that are emitted by this step

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
r - The fields that are entering the step. These are changed to reflect the output metadata.
name - The name of the step to be used as origin
info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]
nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.
space - TODO
Throws:
KettleStepException - when an error occurred searching for the fields.