Class FcDoiInitProps

    • Constructor Detail

      • FcDoiInitProps

        public FcDoiInitProps()
    • Method Detail

      • getBodyFormatType

        public EEmailBodyFormatType getBodyFormatType()
        Returns:
        Content type of the email body, i.e. whether to send the email as HTML, as plain text, or both.
      • getDoiFailTemplate

        public UuidEntityRef getDoiFailTemplate()
        Returns:
        Optional template of type html to show to the user when the double opt-in process failed. When not set, the default template is used.
      • getFrom

        public String getFrom()
        Returns:
        The email address from which the mail was sent, used for the FROM header.
      • getSenderName

        public String getSenderName()
        Returns:
        Optional name of the sender. When given, this name is included in the FROM header.
      • getSubject

        public String getSubject()
        Returns:
        The subject line of the email, i.e. the heading or title.
      • getTo

        public List<String> getTo()
        Returns:
        List of email addresses to which to send the email.
      • isActivateVerifyPage

        public boolean isActivateVerifyPage()
        Returns:
        Controls the behavior when the user clicks on the verification link. When false, the double opt-in is verified immediately. When false, a page with a verification button is shown.
      • isLockFormRecord

        public boolean isLockFormRecord()
        Returns:
        Whether the form record should be locked when while waiting for the double opt-in process to be completed.
        Since:
        8.0.0
      • setActivateVerifyPage

        public void setActivateVerifyPage​(boolean activateVerifyPage)
        Parameters:
        activateVerifyPage - Controls the behavior when the user clicks on the verification link. When false , the double opt-in is verified immediately. When false, a page with a verification button is shown.
      • setBodyFormatType

        public void setBodyFormatType​(EEmailBodyFormatType bodyFormatType)
        Parameters:
        bodyFormatType - Content type of the email body, i.e. whether to send the email as HTML, as plain text, or both.
      • setDoiFailTemplate

        public void setDoiFailTemplate​(UuidEntityRef doiFailTemplate)
        Parameters:
        doiFailTemplate - Optional template of type html to show to the user when the double opt-in process failed. When not set, the default template is used.
      • setFrom

        public void setFrom​(String from)
        Parameters:
        from - The email address from which the mail was sent, used for the FROM header.
      • setLockFormRecord

        public void setLockFormRecord​(boolean lockFormRecord)
        Parameters:
        lockFormRecord - Whether the form record should be locked when while waiting for the double opt-in process to be completed.
        Since:
        8.0.0
      • setSenderName

        public void setSenderName​(String senderName)
        Parameters:
        senderName - Optional name of the sender. When given, this name is included in the FROM header.
      • setSubject

        public void setSubject​(String subject)
        Parameters:
        subject - The subject line of the email, i.e. the heading or title.
      • setTo

        public void setTo​(List<String> to)
        Parameters:
        to - List of email addresses to which to send the email.