Package com.jalios.jcms.policy
Interface MailPolicyFilter
- All Superinterfaces:
Comparable,MailListener,PluginComponent,PolicyFilter
- All Known Implementing Classes:
AbstractDataMailPolicyFilter,BasicMailPolicyFilter
This interface provides hooks on around mail activity.
- Since:
- jcms-6.0.1
-
Method Summary
Modifier and TypeMethodDescriptionvoidafterSendMail(MailMessage msg, HashMap<String, Object> ctxt) Invoked after a mail was sent.booleanbeforeSendMail(MailMessage msg, HashMap<String, Object> ctxt) Invoked before a mail is sent.Methods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.jalios.jcms.mail.MailListener
fetchMessageMethods inherited from interface com.jalios.jcms.plugin.PluginComponent
init
-
Method Details
-
beforeSendMail
Invoked before a mail is sent.- Parameters:
msg- the MailMessage instance that will be sentctxt- 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
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 sentctxt- a context used to store information for this mail sending (context is used accross beforeSendMail and afterSensMail)
-