Class SubmissionEmailVerificationService

    • Constructor Detail

      • SubmissionEmailVerificationService

        public SubmissionEmailVerificationService()
    • Method Detail

      • logProcessingStatus

        public void logProcessingStatus​(Submission submission)
        Log a processing status after the email verification status for a submission has changed.
        Specified by:
        logProcessingStatus in interface ISubmissionEmailVerificationService
        Parameters:
        submission - the submission (required; the email verification status must already be changed)
        Since:
        4.3.3
      • setDefaultTimeoutDays

        public void setDefaultTimeoutDays​(Integer defaultTimeoutDays)
        Set the default timeout in days after which email verification is considered failed.
        Parameters:
        defaultTimeoutDays - the default timeout in days
      • setDefaultMaxAttempts

        public void setDefaultMaxAttempts​(Integer defaultMaxAttempts)
        Set the default maximum number of attempts (= number of emails to send to the user)
        Parameters:
        defaultMaxAttempts - the default maximum number of attempts
      • setDefaultReminderIntervalHours

        public void setDefaultReminderIntervalHours​(Integer defaultReminderIntervalHours)
        Set the default reminder interval in hours (= hours between sending verification emails if user hasn't responded)
        Parameters:
        defaultReminderIntervalHours - the default reminder interval
      • setDefaultEmailSubject

        public void setDefaultEmailSubject​(String defaultEmailSubject)
        Set the default email subject
        Parameters:
        defaultEmailSubject - the default email subject
      • setDefaultEmailMessage

        public void setDefaultEmailMessage​(String defaultEmailMessage)
        Set the default email message
        Parameters:
        defaultEmailMessage - the default email message
      • getProcessingStatusRequired

        public String getProcessingStatusRequired()
        Return the processing status descriptor for required email verification
        Returns:
        the processing status descriptor for required email verification
      • setProcessingStatusRequired

        public void setProcessingStatusRequired​(String processingStatusRequired)
        Set the processing status descriptor for required email verification
        Parameters:
        processingStatusRequired - the processing status descriptor for required email verification
      • getProcessingStatusPending

        public String getProcessingStatusPending()
        Return the processing status descriptor for pending email verification
        Returns:
        the processing status descriptor for pending email verification
      • setProcessingStatusPending

        public void setProcessingStatusPending​(String processingStatusPending)
        Set the processing status descriptor for pending email verification
        Parameters:
        processingStatusPending - the processing status descriptor for pending email verification
      • getProcessingStatusCompleted

        public String getProcessingStatusCompleted()
        Return the processing status descriptor for completed email verification
        Returns:
        the processing status descriptor for completed email verification
      • setProcessingStatusCompleted

        public void setProcessingStatusCompleted​(String processingStatusCompleted)
        Set the processing status descriptor for completed email verification
        Parameters:
        processingStatusCompleted - the processing status descriptor for completed email verification
      • getProcessingStatusWarning

        public String getProcessingStatusWarning()
        Return the processing status descriptor for email verification for which no more emails will be sent (maximum number of attempts reached)
        Returns:
        the processing status descriptor for email verification for which no more emails will be sent
      • setProcessingStatusWarning

        public void setProcessingStatusWarning​(String processingStatusWarning)
        Set the processing status descriptor for email verification for which no more emails will be sent (maximum number of attempts reached)
        Parameters:
        processingStatusWarning - the processing status descriptor for email verification for which no more emails will be sent
      • getProcessingStatusAbandoned

        public String getProcessingStatusAbandoned()
        Return the processing status descriptor for abandoned email verification
        Returns:
        the processing status descriptor for abandoned email verification
      • setProcessingStatusAbandoned

        public void setProcessingStatusAbandoned​(String processingStatusAbandoned)
        Set the processing status descriptor for abandoned email verification
        Parameters:
        processingStatusAbandoned - the processing status descriptor for abandoned email verification