Package de.xima.fc.workflow.model.nodes
Class FcEmailProps
- java.lang.Object
-
- de.xima.fc.workflow.taglib.model.BaseActionProps
-
- de.xima.fc.workflow.model.nodes.FcEmailProps
-
- All Implemented Interfaces:
IDescriptionProviding
,INameProviding
,Serializable
@NotEmptyGroup(fields={"to","toDirectClientAuthorizations","toUserGroups","cc","bcc"}, message="{FcEmailProps.to.required}", payload=Omit.class, target=FcEmailProps.class) public final class FcEmailProps extends BaseActionProps implements Serializable
Model class for the email workflow action (EWorkflowNodeType.FC_EMAIL
).- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FcEmailProps.ValidationGroup
-
Nested classes/interfaces inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps
BaseActionProps.name
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding
ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION
-
Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
ATTR_NAME, COL_NAME
-
-
Constructor Summary
Constructors Constructor Description FcEmailProps()
-
Method Summary
-
Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps
getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName
-
-
-
-
Method Detail
-
getArchiveFileName
public String getArchiveFileName()
- Returns:
- The name of the file to be archived. May contain placeholders.
-
setArchiveFileName
public void setArchiveFileName(String archiveFileName)
- Parameters:
archiveFileName
- the file name of the archived email. May contain placeholders.
-
getArchiveFileProvision
public FileProvision getArchiveFileProvision()
Details for how to handle the archive file.- Returns:
- Details for how to handle the archive file.
-
setArchiveFileProvision
public void setArchiveFileProvision(FileProvision archiveFileProvision)
Details for how to handle the compressed file.- Parameters:
archiveFileProvision
- Details for how to handle the compressed file.
-
getArchiveFormat
public EEmailArchiveFormat getArchiveFormat()
- Returns:
- selected mail archive type.
-
setArchiveFormat
public void setArchiveFormat(EEmailArchiveFormat archiveFormat)
- Parameters:
archiveFormat
- selected mail archive type.
-
setBcc
public void setBcc(List<String> bcc)
- Parameters:
bcc
- The blind copy-recipients of the email
-
getBody
public String getBody()
- Returns:
- Body of the email, as HTML
-
setBody
public void setBody(String body)
- Parameters:
body
- Body of the email, as HTML
-
getBodyFormatType
public EEmailBodyFormatType getBodyFormatType()
- Returns:
- selected mail format type
-
setBodyFormatType
public void setBodyFormatType(EEmailBodyFormatType bodyFormatType)
- Parameters:
bodyFormatType
- selected mail format type
-
getEncryptionType
public EMailEncrpytionType getEncryptionType()
- Returns:
- the mail encryption type. (Can be NONE / SMIME / PGP)
-
setEncryptionType
public void setEncryptionType(EMailEncrpytionType encryptionType)
- Parameters:
encryptionType
- the mail encryption type. (Can be NONE / SMIME / PGP)
-
getFrom
public String getFrom()
- Returns:
- Sender address of the email.
-
setFrom
public void setFrom(String from)
- Parameters:
from
- Sender address of the email.
-
setMultiFile
public void setMultiFile(MultiFile multiFile)
- Parameters:
multiFile
- a resource of typeMultiFile
-
getPlainBody
public String getPlainBody()
- Returns:
- Body of the email, as plain text
-
setPlainBody
public void setPlainBody(String plainBody)
- Parameters:
plainBody
- Body of the email, as plain text
-
setReplyTo
public void setReplyTo(List<String> replyTo)
- Parameters:
replyTo
- Reply-To header of mail
-
getSenderName
public String getSenderName()
- Returns:
- Name of the sender of the email. This is shown instead of the sender address by many email clients.
-
setSenderName
public void setSenderName(String senderName)
- Parameters:
senderName
- Name of the sender of the email
-
getSubject
public String getSubject()
- Returns:
- Subject of the email.
-
setSubject
public void setSubject(String subject)
- Parameters:
subject
- Subject of the email.
-
getToDirectClientAuthorizations
public List<UuidEntityRef> getToDirectClientAuthorizations()
- Returns:
- Recipients of the email (a list of FC direct client authorizations UUIDs).
- Since:
- 8.0.0
-
setToDirectClientAuthorizations
public void setToDirectClientAuthorizations(List<UuidEntityRef> toDirectClientAuthorizations)
- Parameters:
toDirectClientAuthorizations
- Recipients of the email (a list of FC direct client authorizations UUIDs)- Since:
- 8.0.0
-
getToUserGroups
public List<UuidEntityRef> getToUserGroups()
- Returns:
- Recipients of the email (a list of FC user group UUIDs).
-
setToUserGroups
public void setToUserGroups(List<UuidEntityRef> toUserGroups)
- Parameters:
toUserGroups
- Recipients of the email (a list of FC user group UUIDs)
-
getToUsers
@Deprecated public List<UuidEntityRef> getToUsers()
Deprecated.- Returns:
- Recipients of the email (a list of FC user account UUIDs).
-
setToUsers
@Deprecated public void setToUsers(List<UuidEntityRef> toUsers)
Deprecated.- Parameters:
toUsers
- Recipients of the email (a list of FC user account UUIDs)
-
isSendSeparateMails
public boolean isSendSeparateMails()
- Returns:
true
if a separate mail should be generated for each recipient.
-
setSendSeparateMails
public void setSendSeparateMails(boolean sendSeparateMails)
- Parameters:
sendSeparateMails
-true
if a separate mail should generate for every recipients
-
-