Package ch.tocco.nice2.userbase.api

Interface EmailTemplate

All Known Implementing Classes:
EmailTemplateImpl
public interface EmailTemplate

  • Method Details

    • getSupportedEntities

      String getSupportedEntities()

    • getDescription

      String getDescription()

    • getSenderEmail

      String getSenderEmail()

    • getSenderName

      String getSenderName()

    • getSubject

      String getSubject()

    • getReplyTo

      String getReplyTo()

    • getRecipient

      Optional<Entity> getRecipient() throws PersistException
      Returns:
      the recipient entity or Optional.empty() if not set.
      Throws:
      PersistException

    • getReceiver

      String getReceiver()

    • getCc

      String getCc()

    • getSender

      @Nullable @Nullable Entity getSender()

    • getCcRecipients

      EntityList getCcRecipients() throws PersistException
      Get cc recipients. Note: this is the list of User entities linked to the the email template. There may be more cc recipients available through getCc().
      Returns:
      entity list of cc recipient users
      Throws:
      PersistException

    • getBcc

      String getBcc()

    • getBccRecipients

      EntityList getBccRecipients() throws PersistException
      Get bcc recipients. Note: this is the list of User entities linked to the the email template. There may be more bcc recipients available through getBcc().
      Returns:
      entity list of cc recipient users
      Throws:
      PersistException

    • getText

      String getText()
      Returns:
      HTML formatted content.

    • getPlainText

      String getPlainText()

    • getLocalizedValueMap

      Map<String,Object> getLocalizedValueMap() throws PersistException
      Get the localized value map from template entity.
      Returns:
      localized value map
      Throws:
      PersistException

    • getDelegate

      Entity getDelegate()

    • getExpiryDate

      @Nullable @Nullable org.joda.time.LocalDate getExpiryDate()