Package org.craftercms.commons.mail.impl

Class EmailFactoryImpl

java.lang.Object
org.craftercms.commons.mail.impl.EmailFactoryImpl
All Implemented Interfaces:
EmailFactory
public class EmailFactoryImpl extends Object implements EmailFactory
Default implementation of EmailFactory.
Author:
avasquez

  • Field Details

    • DEFAULT_ENCODING

      public static final String DEFAULT_ENCODING
      See Also:

    • LOG_KEY_MIME_MSG_CREATED

      public static final String LOG_KEY_MIME_MSG_CREATED
      See Also:

    • LOG_KEY_PROCESSING_EMAIL_TEMPLATE

      public static final String LOG_KEY_PROCESSING_EMAIL_TEMPLATE
      See Also:

    • ERROR_KEY_TEMPLATE_CONFIG_MISSING

      public static final String ERROR_KEY_TEMPLATE_CONFIG_MISSING
      See Also:

    • mailSender

      protected org.springframework.mail.javamail.JavaMailSender mailSender

    • freeMarkerConfig

      protected freemarker.template.Configuration freeMarkerConfig

    • templatePrefix

      protected String templatePrefix

    • templateSuffix

      protected String templateSuffix

    • templateEncoding

      protected String templateEncoding

  • Constructor Details

    • EmailFactoryImpl

      public EmailFactoryImpl(org.springframework.mail.javamail.JavaMailSender mailSender)

  • Method Details

    • setFreeMarkerConfig

      public void setFreeMarkerConfig(freemarker.template.Configuration freeMarkerConfig)

    • setTemplatePrefix

      public void setTemplatePrefix(String templatePrefix)

    • setTemplateSuffix

      public void setTemplateSuffix(String templateSuffix)

    • setTemplateEncoding

      public void setTemplateEncoding(String templateEncoding)

    • getEmail

      public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String body, boolean html, File... attachments) throws EmailException
      Description copied from interface: EmailFactory
      Creates a new Email.
      Specified by:
      getEmail in interface EmailFactory
      Parameters:
      from - the sender's address
      to - the recipients' addresses (optional)
      cc - the CC recipients' addresses (optional)
      bcc - the BCC recipients' addresses (optional)
      subject - the subject of the email
      body - the text body of the email
      html - if the body is in HTML format
      attachments - the attachments to add to the email
      Returns:
      the created email
      Throws:
      EmailException

    • getEmail

      public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String body, boolean html, File... attachments) throws EmailException
      Description copied from interface: EmailFactory
      Creates a new Email.
      Specified by:
      getEmail in interface EmailFactory
      Parameters:
      from - the sender's address
      to - the recipients' addresses (optional)
      cc - the CC recipients' addresses (optional)
      bcc - the BCC recipients' addresses (optional)
      replyTo - the address to reply to
      subject - the subject of the email
      body - the text body of the email
      html - if the body is in HTML format
      Returns:
      the created email
      Throws:
      EmailException

    • getEmail

      public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String templateName, Object templateModel, boolean html, File... attachments) throws EmailException
      Description copied from interface: EmailFactory
      Creates a new Email.
      Specified by:
      getEmail in interface EmailFactory
      Parameters:
      from - the sender's address
      to - the recipients' addresses (optional)
      cc - the CC recipients' addresses (optional)
      bcc - the BCC recipients' addresses (optional)
      subject - the subject of the email
      templateName - the template name of the email
      templateModel - the template model of the email
      html - if the body is in HTML format
      Returns:
      the created email
      Throws:
      EmailException

    • getEmail

      public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String templateName, Object templateModel, boolean html, File... attachments) throws EmailException
      Description copied from interface: EmailFactory
      Creates a new Email.
      Specified by:
      getEmail in interface EmailFactory
      Parameters:
      from - the sender's address
      to - the recipients' addresses (optional)
      cc - the CC recipients' addresses (optional)
      bcc - the BCC recipients' addresses (optional)
      replyTo - the address to reply to
      subject - the subject of the email
      templateName - the template name of the email
      templateModel - the template model of the email
      html - if the body is in HTML format
      Returns:
      the created email
      Throws:
      EmailException

    • createMessage

      protected jakarta.mail.internet.MimeMessage createMessage(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String body, boolean html, File... attachments) throws EmailException
      Throws:
      EmailException

    • processTemplate

      protected String processTemplate(String templateName, Object templateModel) throws EmailException
      Throws:
      EmailException