SK.gnome.dwarf.mail.smtp.proc.filter
Class SenderIsNot

java.lang.Object
  SK.gnome.dwarf.GenericService
      SK.gnome.dwarf.mail.smtp.proc.MailFilter
          SK.gnome.dwarf.mail.smtp.proc.filter.SenderIsNot

All Implemented Interfaces:

SK.gnome.dwarf.Service

public class SenderIsNot

extends MailFilter

This filter matches messages with sender not on the given list.

Use either a single value or the comma-separated list of multiple values for the filter's MailFilter.condition.

Field Summary

Fields inherited from class SK.gnome.dwarf.mail.smtp.proc.MailFilter

condition, context

Fields inherited from class SK.gnome.dwarf.GenericService

initParameters, parent

Fields inherited from interface SK.gnome.dwarf.Service

INITIALIZED, LOG_DEBUG, LOG_ERROR, LOG_FATAL, LOG_INFO, LOG_TRACE, LOG_WARN, LOG_XFER, SHUTDOWN, STARTED, STOPPED

Constructor Summary

SenderIsNot(java.lang.String name)

Method Summary

protected java.util.Collection	filter(MailAgentMessage message, java.util.Collection recipients) Filters the given message.
protected void	init(MailAgentContext context) Initializes the mail filter.
void	setIgnoreCase(boolean enable)

Methods inherited from class SK.gnome.dwarf.mail.smtp.proc.MailFilter

destroy, setCondition

Methods inherited from class SK.gnome.dwarf.GenericService

getAuthenticator, getAuthFacility, getFullName, getInitParameter, getInitParameterNames, getLogFacility, getLogger, getName, getParameters, getPrincipal, getShutdownTimeout, getState, init, log, log, login, logout, setAuthFacility, setInitParameters, setLogFacility, shutdown, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SenderIsNot

public SenderIsNot(java.lang.String name)

Method Detail

setIgnoreCase

public void setIgnoreCase(boolean enable)

init

protected void init(MailAgentContext context)
             throws MailException

Description copied from class: MailFilter

Initializes the mail filter.

This method may be overriden by the subclasses as needed.

Overrides:

init in class MailFilter

Parameters:

context - the mail context associated with this filter

Throws:

MailException - if an error occured

filter

protected java.util.Collection filter(MailAgentMessage message,
                                      java.util.Collection recipients)
                               throws MailException

Description copied from class: MailFilter

Filters the given message.

Matches the message and its recipients with the given MailFilter.condition. If the matching process fails, an empty collection is returned. Otherwise, the method returns a collection of recipients which meets the given condition. If the condition is not based on the message recipients, the returned collection will contain all message recipients. If the matching is based on the recipients, the collection will contain only those ones, which actually meets the recipient-based condition.

Method must return a new Collection object each time it is called.

Specified by:

filter in class MailFilter

Parameters:

message - the queued message

recipients - the input collection of recipients

Returns:

the filtered collection of recipients

Throws:

MailException - if an error occured