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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getArchiveFileName()`
`FileProvision`	`getArchiveFileProvision()`	Details for how to handle the archive file.
`EEmailArchiveFormat`	`getArchiveFormat()`
`List<String>`	`getBcc()`
`String`	`getBody()`
`EEmailBodyFormatType`	`getBodyFormatType()`
`List<String>`	`getCc()`
`String`	`getFrom()`
`MultiFile`	`getMultiFile()`
`String`	`getPlainBody()`
`List<String>`	`getReplyTo()`
`EMailSecurityTemplate`	`getSecurityTemplate()`	Gets the mail encryption Type.
`String`	`getSenderName()`
`String`	`getSubject()`
`List<String>`	`getTo()`
`List<UuidEntityRef>`	`getToDirectClientAuthorizations()`
`List<UuidEntityRef>`	`getToUserGroups()`
`List<UuidEntityRef>`	`getToUsers()`	Deprecated. Use `getToDirectClientAuthorizations()`.
`boolean`	`isSendSeparateMails()`	Gets whether to send a separate email for each recipient (to, cc, bcc.)
`boolean`	`isThrowOnEncryptError()`	Gets whether to raise a workflow error when encrypting the email fails, see `getSecurityTemplate()`.
`boolean`	`isThrowOnSignError()`	Gets whether to raise a workflow error when signing the email fails, see `getSecurityTemplate()`.
`void`	`setArchiveFileName(String archiveFileName)`
`void`	`setArchiveFileProvision(FileProvision archiveFileProvision)`	Details for how to handle the compressed file.
`void`	`setArchiveFormat(EEmailArchiveFormat archiveFormat)`
`void`	`setBcc(List<String> bcc)`
`void`	`setBody(String body)`
`void`	`setBodyFormatType(EEmailBodyFormatType bodyFormatType)`
`void`	`setCc(List<String> cc)`
`void`	`setFrom(String from)`
`void`	`setMultiFile(MultiFile multiFile)`
`void`	`setPlainBody(String plainBody)`
`void`	`setReplyTo(List<String> replyTo)`
`void`	`setSecurityTemplate(EMailSecurityTemplate securityTemplate)`	Sets the mail encryption Type.
`void`	`setSenderName(String senderName)`
`void`	`setSendSeparateMails(boolean sendSeparateMails)`	Sets whether to send a separate email for each recipient (to, cc, bcc.)
`void`	`setSubject(String subject)`
`void`	`setThrowOnEncryptError(boolean throwOnEncryptError)`	Sets whether to raise a workflow error when encrypting the email fails, see `getSecurityTemplate()`.
`void`	`setThrowOnSignError(boolean throwOnSignError)`	Sets whether to raise a workflow error when signing the email fails, see `getSecurityTemplate()`.
`void`	`setTo(List<String> to)`
`void`	`setToDirectClientAuthorizations(List<UuidEntityRef> toDirectClientAuthorizations)`
`void`	`setToUserGroups(List<UuidEntityRef> toUserGroups)`
`void`	`setToUsers(List<UuidEntityRef> toUsers)`	Deprecated. Use `setToDirectClientAuthorizations(List)`.
`String`	`toString()`

Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps
getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FcEmailProps
```
public FcEmailProps()
```
- 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.
  - getBcc
```
public List<String> getBcc()
```
    Returns:
    
    The blind copy-recipients of the email
  - 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
  - getCc
```
public List<String> getCc()
```
    Returns:
    
    the copy-recipients of the email.
  - setCc
```
public void setCc(List<String> cc)
```
    Parameters:
    
    cc - the copy-recipients of the email.
  - getFrom
```
public String getFrom()
```
    Returns:
    
    Sender address of the email.
  - setFrom
```
public void setFrom(String from)
```
    Parameters:
    
    from - Sender address of the email.
  - getMultiFile
```
public MultiFile getMultiFile()
```
    Returns:
    
    a resource of type MultiFile
  - setMultiFile
```
public void setMultiFile(MultiFile multiFile)
```
    Parameters:
    
    multiFile - a resource of type MultiFile
  - 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
  - getReplyTo
```
public List<String> getReplyTo()
```
    Returns:
    
    Reply-To header of mail
  - setReplyTo
```
public void setReplyTo(List<String> replyTo)
```
    Parameters:
    
    replyTo - Reply-To header of mail
  - getSecurityTemplate
```
public EMailSecurityTemplate getSecurityTemplate()
```
    Gets the mail encryption Type. Determines whether mails will be encrypted or signed. See EMailSecurityTemplate for a list of possible values. Defaults to none.
    
    Returns:
    
    Whether and how to encrypt or sign the email.
  - setSecurityTemplate
```
public void setSecurityTemplate(EMailSecurityTemplate securityTemplate)
```
    Sets the mail encryption Type. Determines whether mails will be encrypted or signed. See EMailSecurityTemplate for a list of possible values. Defaults to none.
    
    Parameters:
    
    securityTemplate - Whether and how to encrypt or sign the email.
  - 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.
  - getTo
```
public List<String> getTo()
```
    Returns:
    
    Recipients of the email.
  - setTo
```
public void setTo(List<String> to)
```
    Parameters:
    
    to - Recipients 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.
    Use getToDirectClientAuthorizations().
    
    Returns:
    
    Recipients of the email (a list of FC user account UUIDs).
  - setToUsers
```
@Deprecated
public void setToUsers(List<UuidEntityRef> toUsers)
```
    Deprecated.
    Use setToDirectClientAuthorizations(List).
    
    Parameters:
    
    toUsers - Recipients of the email (a list of FC user account UUIDs)
  - isSendSeparateMails
```
public boolean isSendSeparateMails()
```
    Gets whether to send a separate email for each recipient (to, cc, bcc.) If false, a single email with the corresponding to, cc, bcc fields will be sent.
    
    Returns:
    
    Whether to send separate emails for each recipient.
  - setSendSeparateMails
```
public void setSendSeparateMails(boolean sendSeparateMails)
```
    Sets whether to send a separate email for each recipient (to, cc, bcc.) If false, a single email with the corresponding to, cc, bcc fields will be sent.
    
    Parameters:
    
    sendSeparateMails - Whether to send separate emails for each recipient.
  - isThrowOnEncryptError
```
public boolean isThrowOnEncryptError()
```
    Gets whether to raise a workflow error when encrypting the email fails, see getSecurityTemplate(). If true, the workflow will be aborted, unless the user has configured a custom error handler. Otherwise, the error will be logged and otherwise ignored. Defaults to false.
    
    Returns:
    
    Whether to raise a workflow error when encrypting the email fails.
  - setThrowOnEncryptError
```
public void setThrowOnEncryptError(boolean throwOnEncryptError)
```
    Sets whether to raise a workflow error when encrypting the email fails, see getSecurityTemplate(). If true, the workflow will be aborted, unless the user has configured a custom error handler. Otherwise, the error will be logged and otherwise ignored. Defaults to false.
    
    Parameters:
    
    throwOnEncryptError - Whether to raise a workflow error when encrypting the email fails.
  - isThrowOnSignError
```
public boolean isThrowOnSignError()
```
    Gets whether to raise a workflow error when signing the email fails, see getSecurityTemplate(). If true, the workflow will be aborted, unless the user has configured a custom error handler. Otherwise, the error will be logged and otherwise ignored. Defaults to false.
    
    Returns:
    
    Whether to raise a workflow error when signing the email fails.
  - setThrowOnSignError
```
public void setThrowOnSignError(boolean throwOnSignError)
```
    Sets whether to raise a workflow error when signing the email fails, see getSecurityTemplate(). If true, the workflow will be aborted, unless the user has configured a custom error handler. Otherwise, the error will be logged and otherwise ignored. Defaults to false.
    
    Parameters:
    
    throwOnSignError - Whether to raise a workflow error when signing the email fails.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FcEmailProps

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

Field Summary

Fields inherited from interface de.xima.fc.entities.interfaces.IDescriptionProviding

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

Constructor Summary

Method Summary

Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

Methods inherited from class java.lang.Object

Constructor Detail

FcEmailProps

Method Detail

getArchiveFileName

setArchiveFileName

getArchiveFileProvision

setArchiveFileProvision

getArchiveFormat

setArchiveFormat

getBcc

setBcc

getBody

setBody

getBodyFormatType

setBodyFormatType

getCc

setCc

getFrom

setFrom

getMultiFile

setMultiFile

getPlainBody

setPlainBody

getReplyTo

setReplyTo

getSecurityTemplate

setSecurityTemplate

getSenderName

setSenderName

getSubject

setSubject

getTo

setTo

getToDirectClientAuthorizations

setToDirectClientAuthorizations

getToUserGroups

setToUserGroups

getToUsers

setToUsers

isSendSeparateMails

setSendSeparateMails

isThrowOnEncryptError

setThrowOnEncryptError

isThrowOnSignError

setThrowOnSignError

toString