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
,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
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.reporting.common.resource.distribution.AbstractReportActionConfig
DEFAULT_FILE_NAME, DEFAULT_FOLDER_PATH, EMAIL_ID, FTP_ID, PRINT_ID, RUNSCRIPT_ID, SAVE_ID
-
Fields inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable
changeEvent, listenerList
-
-
Constructor Summary
Constructors Constructor Description EmailActionConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAttachmentName()
java.util.List<java.lang.String>
getBccAddresses()
java.lang.String
getBody()
java.util.List<java.lang.String>
getCcAddresses()
java.lang.String
getDistributionTypeId()
ReportFormat
getFormat()
java.lang.String
getFromAddress()
java.lang.String
getName()
java.util.List<java.lang.String>
getReplyToAddresses()
Returns a List of the replyTo Addresses.java.util.List<java.lang.String>
getReplyToUserRoles()
Returns a List of the user roles used in the replyTo field of an email notification.java.lang.String
getReplyToUserSource()
Returns the user source that will be used for the replyTo field on email notifications.int
getRetryCount()
java.lang.String
getSmtpServerName()
java.lang.String
getSubject()
java.util.List<java.lang.String>
getToAddresses()
java.util.List<java.lang.String>
getUserRoles()
java.lang.String
getUserSource()
boolean
isUseUserRoles()
void
setAttachmentName(java.lang.String attachmentName)
void
setBccAddresses(java.util.List<java.lang.String> bccAddresses)
void
setBody(java.lang.String body)
void
setCcAddresses(java.util.List<java.lang.String> ccAddresses)
void
setFormat(ReportFormat format)
void
setFromAddress(java.lang.String fromAddress)
void
setReplyToAddresses(java.util.List<java.lang.String> replyToAddress)
Sets the replyTo Address List to the supplied List.void
setReplyToUserRoles(java.util.List<java.lang.String> userRoles)
Sets the replyToAddress List to the supplied List.void
setReplyToUserSource(java.lang.String userSource)
Sets the user source that will be used for the replyTo field on email notifications.void
setRetryCount(int retryCount)
void
setSmtpServerName(java.lang.String smtpServerName)
void
setSubject(java.lang.String subject)
void
setToAddresses(java.util.List<java.lang.String> toAddresses)
void
setUserRoles(java.util.List<java.lang.String> userRoles)
void
setUserSource(java.lang.String userSource)
void
setUseUserRoles(boolean useUserRoles)
-
Methods inherited from class com.inductiveautomation.reporting.common.resource.distribution.AbstractReportActionConfig
getAvailableFormats
-
Methods inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable
addChangeListener, fireStateChanged, getChangeListeners, removeChangeListener
-
-
-
-
Method Detail
-
getDistributionTypeId
public java.lang.String getDistributionTypeId()
- Specified by:
getDistributionTypeId
in classAbstractReportActionConfig
- Returns:
- The string that uniquely identifies this config. Be sure the string is defined as public static final in AbstractReportActionConfig
-
getName
public java.lang.String getName()
- Specified by:
getName
in classAbstractReportActionConfig
- Returns:
- Name of the config
-
getFormat
public ReportFormat getFormat()
-
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
-
-