Class FcEmailProps

    • 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.
      • 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).
      • isSendSeparateMails

        public boolean isSendSeparateMails()
        Returns:
        true if a separate mail should be generated for each recipient.
      • 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)