Package de.xima.fc.workflow.processor.factory

Interface IEmailNodeBuilder

public interface IEmailNodeBuilder
Builder for configuring a EWorkflowNodeType.FC_EMAIL action.
Since:
8.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • addBcc

      IEmailNodeBuilder addBcc(Iterable<String> bcc)
      Parameters:
      bcc - List of BCC recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addBcc

      IEmailNodeBuilder addBcc(String... bcc)
      Parameters:
      bcc - List of BCC recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addCc

      IEmailNodeBuilder addCc(Iterable<String> cc)
      Parameters:
      cc - List of CC recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addCc

      IEmailNodeBuilder addCc(String... cc)
      Parameters:
      cc - List of CC recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addDirectClientAuthorizations

      IEmailNodeBuilder addDirectClientAuthorizations(Iterable<UuidEntityRef> directClientAuthorizations)
      Parameters:
      directClientAuthorizations - List of direct client authorizations recipient for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addDirectClientAuthorizations

      IEmailNodeBuilder addDirectClientAuthorizations(UuidEntityRef... directClientAuthorizations)
      Parameters:
      directClientAuthorizations - List of direct client authorizations recipient for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addReplyTo

      IEmailNodeBuilder addReplyTo(Iterable<String> replyTo)
      Parameters:
      replyTo - List of Reply-To headers for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addReplyTo

      IEmailNodeBuilder addReplyTo(String... replyTo)
      Parameters:
      replyTo - List of Reply-To headers for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addTo

      IEmailNodeBuilder addTo(Iterable<String> to)
      Parameters:
      to - List of recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addTo

      IEmailNodeBuilder addTo(String... to)
      Parameters:
      to - List of recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addUserGroups

      IEmailNodeBuilder addUserGroups(Iterable<UuidEntityRef> userGroups)
      Parameters:
      userGroups - List of user groups recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addUserGroups

      IEmailNodeBuilder addUserGroups(UuidEntityRef... userGroups)
      Parameters:
      userGroups - List of user groups recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addUsers

      @Deprecated IEmailNodeBuilder addUsers(Iterable<UuidEntityRef> users)
      Deprecated.
      User references should be done via UserProfile.
      Parameters:
      users - List of user recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • addUsers

      @Deprecated IEmailNodeBuilder addUsers(UuidEntityRef... users)
      Deprecated.
      User references should be done via UserProfile.
      Parameters:
      users - List of user recipients for the email to add to the existing ones.
      Returns:
      This builder for chaining methods calls.

    • attachments

      IEmailNodeBuilder attachments(MultiFile attachments)
      Parameters:
      attachments - Attachments to send with the email.
      Returns:
      This builder for chaining methods calls.

    • bcc

      IEmailNodeBuilder bcc(Iterable<String> bcc)
      Parameters:
      bcc - List of BCC recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • bcc

      IEmailNodeBuilder bcc(String... bcc)
      Parameters:
      bcc - List of BCC recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • body

      IEmailNodeBuilder body(String htmlBody, String plainTextBody)
      Sends an email with both a plain text and HTML body. Calling this method automatically sets the body type.
      Parameters:
      htmlBody - HTML version of the email's body content.
      plainTextBody - Plain text version of the email's body content.
      Returns:
      This builder for chaining methods calls.

    • bodyHtml

      IEmailNodeBuilder bodyHtml(String htmlBody)
      Sends an email with only a plain HTML body. Calling this method automatically sets the body type.
      Parameters:
      htmlBody - HTML version of the email's body content.
      Returns:
      This builder for chaining methods calls.

    • bodyPlainText

      IEmailNodeBuilder bodyPlainText(String plainTextBody)
      Sends an email with only a plain text body. Calling this method automatically sets the body type.
      Parameters:
      plainTextBody - Plain text version of the email's body content.
      Returns:
      This builder for chaining methods calls.

    • bodyType

      IEmailNodeBuilder bodyType(EEmailBodyFormatType bodyType)
      Parameters:
      bodyType - Type of the email body to send.
      Returns:
      This builder for chaining methods calls.

    • build

      WorkflowNode build() throws FastJsonException
      Creates a new workflow node for a EWorkflowNodeType.FC_EMAIL that sends an email.
      Returns:
      The workflow node for an email action.
      Throws:
      FastJsonException - When the properties model could not be serialized.

    • buildProps

      FcEmailProps buildProps()
      Creates a new model for a workflow action that sends an email.
      Returns:
      The properties model for an email action.

    • cc

      IEmailNodeBuilder cc(Iterable<String> cc)
      Parameters:
      cc - List of CC recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • cc

      IEmailNodeBuilder cc(String... cc)
      Parameters:
      cc - List of CC recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • directClientAuthorizations

      IEmailNodeBuilder directClientAuthorizations(Iterable<UuidEntityRef> directClientAuthorizations)
      Parameters:
      directClientAuthorizations - List of direct client authorizations recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • directClientAuthorizations

      IEmailNodeBuilder directClientAuthorizations(UuidEntityRef... directClientAuthorizations)
      Parameters:
      directClientAuthorizations - List of direct client authorizations recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • encryptionType

      IEmailNodeBuilder encryptionType(EMailEncrpytionType encryptionType)
      Parameters:
      encryptionType - How to encrypt the email, if at all.
      Returns:
      This builder for chaining methods calls.

    • replyTo

      IEmailNodeBuilder replyTo(Iterable<String> replyTo)
      Parameters:
      replyTo - List of Reply-To headers for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • replyTo

      IEmailNodeBuilder replyTo(String... replyTo)
      Parameters:
      replyTo - Reply-To header for the email to use instead of the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • senderName

      IEmailNodeBuilder senderName(String senderName)
      Parameters:
      senderName - Display name of the email's sender.
      Returns:
      This builder for chaining methods calls.

    • sendSeparateMails

      IEmailNodeBuilder sendSeparateMails()
      Send separate emails, one for each recipient. Useful when the individual recipients should not see each other's email address.
      Returns:
      This builder for chaining methods calls.

    • sendSeparateMails

      IEmailNodeBuilder sendSeparateMails(boolean sendSeparateMails)
      Parameters:
      sendSeparateMails - Whether to send separate emails, one for each recipient. Useful when the individual recipients should not see each other's email address.
      Returns:
      This builder for chaining methods calls.

    • subject

      IEmailNodeBuilder subject(String subject)
      Parameters:
      subject - Subject heading for the email.
      Returns:
      This builder for chaining methods calls.

    • to

      IEmailNodeBuilder to(Iterable<String> to)
      Parameters:
      to - List of recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • to

      IEmailNodeBuilder to(String... to)
      Parameters:
      to - List of recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • userGroups

      IEmailNodeBuilder userGroups(Iterable<UuidEntityRef> userGroups)
      Parameters:
      userGroups - List of user group recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • userGroups

      IEmailNodeBuilder userGroups(UuidEntityRef... userGroups)
      Parameters:
      userGroups - List of user group recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • users

      @Deprecated IEmailNodeBuilder users(Iterable<UuidEntityRef> users)
      Deprecated.
      User references should be done via UserProfile.
      Parameters:
      users - List of user recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.

    • users

      @Deprecated IEmailNodeBuilder users(UuidEntityRef... users)
      Deprecated.
      User references should be done via UserProfile.
      Parameters:
      users - List of user recipients for the email to replace the existing ones with.
      Returns:
      This builder for chaining methods calls.