Package org.pentaho.di.job.entries.mail

Class JobEntryMail

  • 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 JobEntryMail
extends JobEntryBase
implements Cloneable, JobEntryInterface
    Describes a Mail Job Entry.
    Author:
    Matt Created on 17-06-2003

    • Field Detail

      • embeddedimages

        public String[] embeddedimages

      • contentids

        public String[] contentids

    • Constructor Detail

      • JobEntryMail

        public JobEntryMail​(String n)

      • JobEntryMail

        public JobEntryMail()

    • Method Detail

      • allocate

        public void allocate​(int nrFileTypes)

      • allocateImages

        public void allocateImages​(int nrImages)

      • 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

      • 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

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

      • getIncludeDate

        public boolean getIncludeDate()

      • 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()

      • getFileType

        public int[] getFileType()
        Returns:
        the result file types to select for attachment
        See Also:
        ResultFile

      • setFileType

        public void setFileType​(int[] fileType)
        Parameters:
        fileType - the result file types to select for attachment
        See Also:
        ResultFile

      • isIncludingFiles

        public boolean isIncludingFiles()

      • setIncludingFiles

        public void setIncludingFiles​(boolean includeFiles)

      • getZipFilename

        public String getZipFilename()
        Returns:
        Returns the zipFilename.

      • 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 secureConnectionType)
        Parameters:
        secureConnectionType - the secure connection type to set

      • setEncoding

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

      • setReplyToAddresses

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

      • getReplyToAddresses

        public String getReplyToAddresses()
        Returns:
        replayToAddresses

      • setUsePriority

        public void setUsePriority​(boolean usePriority)
        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 importance)
        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 priority)
        Parameters:
        priority - the priority to set

      • execute

        public org.pentaho.di.core.Result execute​(org.pentaho.di.core.Result result,
                                          int nr)
        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:
        result - the previous result
        nr - the number of rows
        Returns:
        the Result object from execution of this job entry

      • 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

      • isUnconditional

        public boolean isUnconditional()
        Description copied from class: JobEntryBase
        This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true
        Specified by:
        isUnconditional in interface JobEntryInterface
        Overrides:
        isUnconditional in class JobEntryBase
        Returns:
        true

      • 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

      • 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

      • getPassword

        public String getPassword​(String authPassword)