Package com.inductiveautomation.reporting.common.resource.distribution

Class EmailActionConfig

  • All Implemented Interfaces:
    Changeable, java.io.Serializable
    public class EmailActionConfig
extends AbstractReportActionConfig
    Filename: EmailActionConfig.java Created on Feb 09, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: Reporting
    See Also:
    Serialized Form

    • Constructor Detail

      • EmailActionConfig

        public EmailActionConfig()

    • Method Detail

      • getDistributionTypeId

        public java.lang.String getDistributionTypeId()
        Specified by:
        getDistributionTypeId in class AbstractReportActionConfig
        Returns:
        The string that uniquely identifies this config. Be sure the string is defined as public static final in AbstractReportActionConfig

      • setFormat

        public void setFormat​(ReportFormat format)

      • getSmtpServerName

        public java.lang.String getSmtpServerName()

      • setSmtpServerName

        public void setSmtpServerName​(java.lang.String smtpServerName)

      • getToAddresses

        public java.util.List<java.lang.String> getToAddresses()

      • setToAddresses

        public void setToAddresses​(java.util.List<java.lang.String> toAddresses)

      • getCcAddresses

        public java.util.List<java.lang.String> getCcAddresses()

      • setCcAddresses

        public void setCcAddresses​(java.util.List<java.lang.String> ccAddresses)

      • getBccAddresses

        public java.util.List<java.lang.String> getBccAddresses()

      • setBccAddresses

        public void setBccAddresses​(java.util.List<java.lang.String> bccAddresses)

      • getFromAddress

        public java.lang.String getFromAddress()

      • setFromAddress

        public void setFromAddress​(java.lang.String fromAddress)

      • getReplyToAddresses

        public java.util.List<java.lang.String> getReplyToAddresses()
        Returns a List of the replyTo Addresses.
        Returns:
        A List of the replyTo Addresses. If the list is never set, an empty list will be returned

      • setReplyToAddresses

        public void setReplyToAddresses​(java.util.List<java.lang.String> replyToAddress)
        Sets the replyTo Address List to the supplied List.
        Parameters:
        replyToAddress - a List of replyTo Email addresses. If null, no changes will be made

      • getSubject

        public java.lang.String getSubject()

      • setSubject

        public void setSubject​(java.lang.String subject)

      • getBody

        public java.lang.String getBody()

      • setBody

        public void setBody​(java.lang.String body)

      • getAttachmentName

        public java.lang.String getAttachmentName()

      • setAttachmentName

        public void setAttachmentName​(java.lang.String attachmentName)

      • getRetryCount

        public int getRetryCount()

      • setRetryCount

        public void setRetryCount​(int retryCount)

      • isUseUserRoles

        public boolean isUseUserRoles()

      • setUseUserRoles

        public void setUseUserRoles​(boolean useUserRoles)

      • getUserSource

        public java.lang.String getUserSource()

      • setUserSource

        public void setUserSource​(java.lang.String userSource)

      • getUserRoles

        public java.util.List<java.lang.String> getUserRoles()

      • setUserRoles

        public void setUserRoles​(java.util.List<java.lang.String> userRoles)

      • getReplyToUserSource

        public java.lang.String getReplyToUserSource()
        Returns the user source that will be used for the replyTo field on email notifications.
        Returns:
        the user source used for replyTo email notifications. If never set, an empty string will be returned

      • setReplyToUserSource

        public void setReplyToUserSource​(java.lang.String userSource)
        Sets the user source that will be used for the replyTo field on email notifications.
        Parameters:
        userSource - The user source to use for replyTo addresses. If null, user source will not be modified

      • getReplyToUserRoles

        public java.util.List<java.lang.String> getReplyToUserRoles()
        Returns a List of the user roles used in the replyTo field of an email notification.
        Returns:
        A List of the user roles used for replyTo Addresses. If the list is never set, an empty list will be returned

      • setReplyToUserRoles

        public void setReplyToUserRoles​(java.util.List<java.lang.String> userRoles)
        Sets the replyToAddress List to the supplied List.
        Parameters:
        userRoles - a List of replyTo Email addresses. If null, no changes will be made