com.jalios.jcms.policy

Interface MailPolicyFilter

All Superinterfaces:

java.lang.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

Version:

$Revision: 72474 $

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Method Summary

Modifier and Type	Method and Description
void	afterSendMail(MailMessage msg, java.util.HashMap<java.lang.String,java.lang.Object> ctxt) Invoked after a mail was sent.
boolean	beforeSendMail(MailMessage msg, java.util.HashMap<java.lang.String,java.lang.Object> ctxt) Invoked before a mail is sent.

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Methods inherited from interface com.jalios.jcms.mail.MailListener

fetchMessage

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

REVISION

static final java.lang.String REVISION

See Also:

Constant Field Values

Method Detail

beforeSendMail

boolean beforeSendMail(MailMessage msg,
                       java.util.HashMap<java.lang.String,java.lang.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,
                   java.util.HashMap<java.lang.String,java.lang.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)