Package org.pentaho.di.trans.steps.mail

Class MailMeta

    • Constructor Detail

      • MailMeta

        public MailMeta()

    • Method Detail

      • loadXML

        public void loadXML​(Node stepnode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
        Description copied from interface: StepMetaInterface
        Load the values for this step from an XML Node
        Specified by:
        loadXML in interface StepMetaInterface
        Overrides:
        loadXML in class BaseStepMeta
        Parameters:
        stepnode - the Node to get the info from
        databases - The available list of databases to reference to
        metaStore - the metastore to optionally load external reference metadata from
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

      • allocate

        public void allocate​(int value)

      • setEmbeddedImage

        public void setEmbeddedImage​(int i,
                             String value)

      • setEmbeddedImages

        public void setEmbeddedImages​(String[] value)

      • setContentIds

        public void setContentIds​(int i,
                          String value)

      • setContentIds

        public void setContentIds​(String[] value)

      • getXML

        public String getXML()
              throws org.pentaho.di.core.exception.KettleException
        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.
        Throws:
        org.pentaho.di.core.exception.KettleException - in case there is an XML conversion or encoding error

      • setServer

        public void setServer​(String s)

      • getServer

        public String getServer()

      • setDestination

        public void setDestination​(String dest)

      • setDestinationCc

        public void setDestinationCc​(String destCc)

      • setDestinationBCc

        public void setDestinationBCc​(String destBCc)

      • getDestination

        public String getDestination()

      • getDestinationCc

        public String getDestinationCc()

      • getDestinationBCc

        public String getDestinationBCc()

      • setReplyAddress

        public void setReplyAddress​(String reply)

      • getReplyAddress

        public String getReplyAddress()

      • setReplyName

        public void setReplyName​(String replyname)

      • getReplyName

        public String getReplyName()

      • setSubject

        public void setSubject​(String subj)

      • getSubject

        public String getSubject()

      • setIncludeDate

        public void setIncludeDate​(boolean incl)

      • setIncludeSubFolders

        public void setIncludeSubFolders​(boolean incl)

      • isIncludeSubFolders

        public boolean isIncludeSubFolders()

      • getEmbeddedImages

        public String[] getEmbeddedImages()

      • getContentIds

        public String[] getContentIds()

      • isZipFilenameDynamic

        public boolean isZipFilenameDynamic()

      • setZipFilenameDynamic

        public void setZipFilenameDynamic​(boolean isdynamic)

      • setisDynamicFilename

        public void setisDynamicFilename​(boolean isdynamic)

      • setAttachContentFromField

        public void setAttachContentFromField​(boolean attachContentFromField)

      • setAttachContentField

        public void setAttachContentField​(String attachContentField)

      • setAttachContentFileNameField

        public void setAttachContentFileNameField​(String attachContentFileNameField)

      • setDynamicWildcard

        public void setDynamicWildcard​(String dynamicwildcard)

      • setDynamicZipFilenameField

        public void setDynamicZipFilenameField​(String dynamiczipfilename)

      • getDynamicZipFilenameField

        public String getDynamicZipFilenameField()

      • getDynamicWildcard

        public String getDynamicWildcard()

      • setSourceFileFoldername

        public void setSourceFileFoldername​(String sourcefile)

      • getSourceFileFoldername

        public String getSourceFileFoldername()

      • setSourceWildcard

        public void setSourceWildcard​(String wildcard)

      • getSourceWildcard

        public String getSourceWildcard()

      • setDynamicFieldname

        public void setDynamicFieldname​(String dynamicfield)

      • getDynamicFieldname

        public String getDynamicFieldname()

      • getIncludeDate

        public boolean getIncludeDate()

      • isDynamicFilename

        public boolean isDynamicFilename()

      • isAttachContentFromField

        public boolean isAttachContentFromField()

      • getAttachContentField

        public String getAttachContentField()

      • getAttachContentFileNameField

        public String getAttachContentFileNameField()

      • setContactPerson

        public void setContactPerson​(String person)

      • getContactPerson

        public String getContactPerson()

      • setContactPhone

        public void setContactPhone​(String phone)

      • getContactPhone

        public String getContactPhone()

      • setComment

        public void setComment​(String comm)

      • getComment

        public String getComment()

      • isIncludingFiles

        public boolean isIncludingFiles()

      • setIncludingFiles

        public void setIncludingFiles​(boolean includeFiles)

      • getZipFilename

        public String getZipFilename()
        Returns:
        Returns the zipFilename.

      • getZipLimitSize

        public String getZipLimitSize()
        Returns:
        Returns the ziplimitsize.

      • setZipLimitSize

        public void setZipLimitSize​(String ziplimitsize)
        Parameters:
        ziplimitsize - The ziplimitsize to set.

      • setZipFilename

        public void setZipFilename​(String zipFilename)
        Parameters:
        zipFilename - The zipFilename to set.

      • isZipFiles

        public boolean isZipFiles()
        Returns:
        Returns the zipFiles.

      • setZipFiles

        public void setZipFiles​(boolean zipFiles)
        Parameters:
        zipFiles - The zipFiles to set.

      • getAuthenticationPassword

        public String getAuthenticationPassword()
        Returns:
        Returns the authenticationPassword.

      • setAuthenticationPassword

        public void setAuthenticationPassword​(String authenticationPassword)
        Parameters:
        authenticationPassword - The authenticationPassword to set.

      • getAuthenticationUser

        public String getAuthenticationUser()
        Returns:
        Returns the authenticationUser.

      • setAuthenticationUser

        public void setAuthenticationUser​(String authenticationUser)
        Parameters:
        authenticationUser - The authenticationUser to set.

      • isUsingAuthentication

        public boolean isUsingAuthentication()
        Returns:
        Returns the usingAuthentication.

      • setUsingAuthentication

        public void setUsingAuthentication​(boolean usingAuthentication)
        Parameters:
        usingAuthentication - The usingAuthentication to set.

      • isOnlySendComment

        public boolean isOnlySendComment()
        Returns:
        the onlySendComment flag

      • setOnlySendComment

        public void setOnlySendComment​(boolean onlySendComment)
        Parameters:
        onlySendComment - the onlySendComment flag to set

      • isUseHTML

        public boolean isUseHTML()
        Returns:
        the useHTML flag

      • setUseHTML

        public void setUseHTML​(boolean UseHTML)
        Parameters:
        useHTML - the useHTML to set

      • getEncoding

        public String getEncoding()
        Returns:
        the encoding

      • getSecureConnectionType

        public String getSecureConnectionType()
        Returns:
        the secure connection type

      • setSecureConnectionType

        public void setSecureConnectionType​(String secureconnectiontypein)
        Parameters:
        secureconnectiontype - the secureconnectiontype to set

      • setReplyToAddresses

        public void setReplyToAddresses​(String replytoaddresses)
        Parameters:
        replyToAddresses - the replyToAddresses to set

      • getReplyToAddresses

        public String getReplyToAddresses()
        Returns:
        the secure replyToAddresses

      • setEncoding

        public void setEncoding​(String encoding)
        Parameters:
        encoding - the encoding to set

      • isUsingSecureAuthentication

        public boolean isUsingSecureAuthentication()
        Returns:
        the usingSecureAuthentication

      • setUsingSecureAuthentication

        public void setUsingSecureAuthentication​(boolean usingSecureAuthentication)
        Parameters:
        usingSecureAuthentication - the usingSecureAuthentication to set

      • getPort

        public String getPort()
        Returns:
        the port

      • setPort

        public void setPort​(String port)
        Parameters:
        port - the port to set

      • setUsePriority

        public void setUsePriority​(boolean usePriorityin)
        Parameters:
        usePriority - the usePriority to set

      • isUsePriority

        public boolean isUsePriority()
        Returns:
        the usePriority flag

      • getPriority

        public String getPriority()
        Returns:
        the priority

      • setImportance

        public void setImportance​(String importancein)
        Parameters:
        importance - the importance to set

      • getImportance

        public String getImportance()
        Returns:
        the importance

      • getSensitivity

        public String getSensitivity()

      • setSensitivity

        public void setSensitivity​(String sensitivity)

      • setPriority

        public void setPriority​(String priorityin)
        Parameters:
        priority - the priority to set

      • readRep

        public void readRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_step,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepMetaInterface
        Read the steps information from a Kettle repository
        Specified by:
        readRep in interface StepMetaInterface
        Overrides:
        readRep in class BaseStepMeta
        Parameters:
        rep - The repository to read from
        metaStore - The MetaStore to read external information from
        id_step - The step ID
        databases - The databases to reference
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_transformation,
                    org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepMetaInterface
        Save the steps data into a Kettle repository
        Specified by:
        saveRep in interface StepMetaInterface
        Overrides:
        saveRep in class BaseStepMeta
        Parameters:
        rep - The Kettle repository to save to
        metaStore - the metaStore to optionally write to
        id_transformation - The transformation ID
        id_step - The step ID
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • check

        public void check​(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  org.pentaho.di.core.row.RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  org.pentaho.di.core.row.RowMetaInterface info,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
        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
        Overrides:
        check in class BaseStepMeta
        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
        space - the variable space to resolve variable expressions with
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

      • 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.