Interface MailPolicyFilter

All Superinterfaces:
Comparable, MailListener, PluginComponent, PolicyFilter
All Known Implementing Classes:
AbstractDataMailPolicyFilter, BasicMailPolicyFilter

public interface MailPolicyFilter extends PolicyFilter, MailListener
This interface provides hooks on around mail activity.
Since:
jcms-6.0.1
  • Method Details

    • beforeSendMail

      boolean beforeSendMail(MailMessage msg, HashMap<String,Object> ctxt)
      Invoked before a mail is sent.
      Parameters:
      msg - the MailMessage instance that will be sent
      ctxt - a context used to store information for this mail sending (context is used accross beforeSendMail and afterSensMail)
      Returns:
      false to stop the sending, true to continue
    • afterSendMail

      void afterSendMail(MailMessage msg, HashMap<String,Object> ctxt)
      Invoked after a mail was sent.

      This method may not be invoked if an exception occured during sending or if sending was cancelled by a MailPolicyFilter in beforeSendMail.

      Parameters:
      msg - the MailMessage instance that was sent
      ctxt - a context used to store information for this mail sending (context is used accross beforeSendMail and afterSensMail)