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

Class EmailActionConfig

java.lang.Object
com.inductiveautomation.ignition.common.util.AbstractChangeable
com.inductiveautomation.reporting.common.resource.distribution.AbstractReportActionConfig
com.inductiveautomation.reporting.common.resource.distribution.EmailActionConfig
All Implemented Interfaces:
Changeable, 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:

  • Constructor Details

    • EmailActionConfig

      public EmailActionConfig()

  • Method Details

    • getDistributionTypeId

      public 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

    • getName

      public String getName()
      Specified by:
      getName in class AbstractReportActionConfig
      Returns:
      Name of the config

    • getFormat

      public ReportFormat getFormat()

    • setFormat

      public void setFormat(ReportFormat format)

    • getSmtpServerName

      public String getSmtpServerName()

    • setSmtpServerName

      public void setSmtpServerName(String smtpServerName)

    • getToAddresses

      public List<String> getToAddresses()

    • setToAddresses

      public void setToAddresses(List<String> toAddresses)

    • getCcAddresses

      public List<String> getCcAddresses()

    • setCcAddresses

      public void setCcAddresses(List<String> ccAddresses)

    • getBccAddresses

      public List<String> getBccAddresses()

    • setBccAddresses

      public void setBccAddresses(List<String> bccAddresses)

    • getFromAddress

      public String getFromAddress()

    • setFromAddress

      public void setFromAddress(String fromAddress)

    • getReplyToAddresses

      public List<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(List<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 String getSubject()

    • setSubject

      public void setSubject(String subject)

    • getBody

      public String getBody()

    • setBody

      public void setBody(String body)

    • getAttachmentName

      public String getAttachmentName()

    • setAttachmentName

      public void setAttachmentName(String attachmentName)

    • getRetryCount

      public int getRetryCount()

    • setRetryCount

      public void setRetryCount(int retryCount)

    • isUseUserRoles

      public boolean isUseUserRoles()

    • setUseUserRoles

      public void setUseUserRoles(boolean useUserRoles)

    • getUserSource

      public String getUserSource()

    • setUserSource

      public void setUserSource(String userSource)

    • getUserRoles

      public List<String> getUserRoles()

    • setUserRoles

      public void setUserRoles(List<String> userRoles)

    • getReplyToUserSource

      public 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(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 List<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(List<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