java.lang.Object
- de.xima.fc.workflow.taglib.model.BaseActionProps
- - de.xima.fc.workflow.model.nodes.FcEmailProps

All Implemented Interfaces:: IDescriptionProviding, INameProviding, IAttachToFormRecordProviding, Serializable

@NotEmptyGroup(fields={"to","toDirectClientAuthorizations","toUserGroups","cc","bcc"},
               message="{FcEmailProps.to.required}",
               payload=Omit.class,
               target=FcEmailProps.class)
@NotEmptyIf(field="body",dependants="bodyFormatType",target=FcEmailProps.class) @NotEmptyIf(field="plainBody",dependants="bodyFormatType",target=FcEmailProps.class)
public final class FcEmailProps
extends BaseActionProps
implements Serializable, IAttachToFormRecordProviding

Model class for the email workflow action (EWorkflowNodeType.FC_EMAIL).

Since:: 7.0.0
Author:: XIMA MEDIA GmbH
See Also:: Serialized Form

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()`
`EEmailArchiveFormat`	`getArchiveFormat()`
`List<String>`	`getBcc()`
`String`	`getBody()`
`EEmailBodyFormatType`	`getBodyFormatType()`
`List<String>`	`getCc()`
`EMailEncrpytionType`	`getEncryptionType()`
`String`	`getFrom()`
`MultiFile`	`getMultiFile()`
`String`	`getPlainBody()`
`List<String>`	`getReplyTo()`
`String`	`getSenderName()`
`String`	`getSubject()`
`List<String>`	`getTo()`
`List<UuidEntityRef>`	`getToDirectClientAuthorizations()`
`List<UuidEntityRef>`	`getToUserGroups()`
`List<UuidEntityRef>`	`getToUsers()`	Deprecated. Use `getToDirectClientAuthorizations()`.
`boolean`	`isAttachToFormRecord()`
`boolean`	`isSendSeparateMails()`
`void`	`setArchiveFileName(String archiveFileName)`
`void`	`setArchiveFormat(EEmailArchiveFormat archiveFormat)`
`void`	`setAttachToFormRecord(boolean attachToFormRecord)`
`void`	`setBcc(List<String> bcc)`
`void`	`setBody(String body)`
`void`	`setBodyFormatType(EEmailBodyFormatType bodyFormatType)`
`void`	`setCc(List<String> cc)`
`void`	`setEncryptionType(EMailEncrpytionType encryptionType)`
`void`	`setFrom(String from)`
`void`	`setMultiFile(MultiFile multiFile)`
`void`	`setPlainBody(String plainBody)`
`void`	`setReplyTo(List<String> replyTo)`
`void`	`setSenderName(String senderName)`
`void`	`setSendSeparateMails(boolean sendSeparateMails)`
`void`	`setSubject(String subject)`
`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
  - getBcc
```
public List<String> getBcc()
```
    Returns:
    
    The blind copy-recipients of the email
  - getBody
```
public String getBody()
```
    Returns:
    
    Body of the email, as HTML
  - getBodyFormatType
```
public EEmailBodyFormatType getBodyFormatType()
```
    Returns:
    
    selected mail format type
  - getArchiveFormat
```
public EEmailArchiveFormat getArchiveFormat()
```
    Returns:
    
    selected mail archive type.
  - getCc
```
public List<String> getCc()
```
    Returns:
    
    the copy-recipients of the email.
  - getEncryptionType
```
public EMailEncrpytionType getEncryptionType()
```
    Returns:
    
    the mail encryption type. (Can be NONE / SMIME / PGP)
  - getFrom
```
public String getFrom()
```
    Returns:
    
    Sender address of the email.
  - getMultiFile
```
public MultiFile getMultiFile()
```
    Returns:
    
    a resource of type MultiFile
  - getPlainBody
```
public String getPlainBody()
```
    Returns:
    
    Body of the email, as plain text
  - getReplyTo
```
public List<String> getReplyTo()
```
    Returns:
    
    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.
  - getSubject
```
public String getSubject()
```
    Returns:
    
    Subject of the email.
  - getTo
```
public List<String> getTo()
```
    Returns:
    
    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
  - getToUserGroups
```
public List<UuidEntityRef> getToUserGroups()
```
    Returns:
    
    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).
  - isSendSeparateMails
```
public boolean isSendSeparateMails()
```
    Returns:
    
    true if a separate mail should be generated for each recipient.
  - isAttachToFormRecord
```
public boolean isAttachToFormRecord()
```
    Specified by:
    
    isAttachToFormRecord in interface IAttachToFormRecordProviding
    
    Returns:
    
    Whether files created by the workflow node are attached to the form record.
  - getArchiveFileName
```
public String getArchiveFileName()
```
    Returns:
    
    The name of the file to be archived. May contain placeholders.
  - setBcc
```
public void setBcc(List<String> bcc)
```
    Parameters:
    
    bcc - The blind copy-recipients of the email
  - setBody
```
public void setBody(String body)
```
    Parameters:
    
    body - Body of the email, as HTML
  - setBodyFormatType
```
public void setBodyFormatType(EEmailBodyFormatType bodyFormatType)
```
    Parameters:
    
    bodyFormatType - selected mail format type
  - setArchiveFormat
```
public void setArchiveFormat(EEmailArchiveFormat archiveFormat)
```
    Parameters:
    
    archiveFormat - selected mail archive type.
  - setCc
```
public void setCc(List<String> cc)
```
    Parameters:
    
    cc - the copy-recipients of the email.
  - setEncryptionType
```
public void setEncryptionType(EMailEncrpytionType encryptionType)
```
    Parameters:
    
    encryptionType - the mail encryption type. (Can be NONE / SMIME / PGP)
  - setFrom
```
public void setFrom(String from)
```
    Parameters:
    
    from - Sender address of the email.
  - setMultiFile
```
public void setMultiFile(MultiFile multiFile)
```
    Parameters:
    
    multiFile - a resource of type MultiFile
  - 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
  - setSenderName
```
public void setSenderName(String senderName)
```
    Parameters:
    
    senderName - Name of the sender of the email
  - setSendSeparateMails
```
public void setSendSeparateMails(boolean sendSeparateMails)
```
    Parameters:
    
    sendSeparateMails - true if a separate mail should generate for every recipients
  - setAttachToFormRecord
```
public void setAttachToFormRecord(boolean attachToFormRecord)
```
    Parameters:
    
    attachToFormRecord - Whether files created by the workflow node are attached to the form record.
  - setArchiveFileName
```
public void setArchiveFileName(String archiveFileName)
```
    Parameters:
    
    archiveFileName - the file name of the archived email. May contain placeholders.
  - setSubject
```
public void setSubject(String subject)
```
    Parameters:
    
    subject - Subject of the email.
  - setTo
```
public void setTo(List<String> to)
```
    Parameters:
    
    to - Recipients of the email.
  - 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
  - setToUserGroups
```
public void setToUserGroups(List<UuidEntityRef> toUserGroups)
```
    Parameters:
    
    toUserGroups - Recipients of the email (a list of FC user group 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)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FcEmailProps

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

getBcc

getBody

getBodyFormatType

getArchiveFormat

getCc

getEncryptionType

getFrom

getMultiFile

getPlainBody

getReplyTo

getSenderName

getSubject

getTo

getToDirectClientAuthorizations

getToUserGroups

getToUsers

isSendSeparateMails

isAttachToFormRecord

getArchiveFileName

setBcc

setBody

setBodyFormatType

setArchiveFormat

setCc

setEncryptionType

setFrom

setMultiFile

setPlainBody

setReplyTo

setSenderName

setSendSeparateMails

setAttachToFormRecord

setArchiveFileName

setSubject

setTo

setToDirectClientAuthorizations

setToUserGroups

setToUsers

toString