FilterRunner.java

package org.subethamail.core.filter;

import javax.mail.MessagingException;

import org.subethamail.common.SubEthaMessage;
import org.subethamail.core.plugin.i.ArchiveRenderFilterContext;
import org.subethamail.core.plugin.i.Filter;
import org.subethamail.core.plugin.i.FilterContext;
import org.subethamail.core.plugin.i.HoldException;
import org.subethamail.core.plugin.i.IgnoreException;
import org.subethamail.core.plugin.i.SendFilterContext;
import org.subethamail.entity.Mail;
import org.subethamail.entity.MailingList;

/**
 * Interface for running filters on a mime message.
 *
 * @author Jeff Schnitzer
 */
public interface FilterRunner
{
	/**
	 * Runs the message through all the filters associated with the list.
	 * Note that the Mail does not exist yet.
	 * 
	 * @see Filter#onInject(SubEthaMessage, FilterContext)
	 */
	public void onInject(SubEthaMessage msg, MailingList list) throws IgnoreException, HoldException, MessagingException;
	
	/**
	 * Runs the message through all the filters associated with the list.
	 * 
	 * @see Filter#onSend(SubEthaMessage, SendFilterContext)
	 */
	public void onSend(SubEthaMessage msg, Mail mail) throws IgnoreException, MessagingException;

	/**
	 * Runs the message through all the filters associated with the list.
	 * 
	 * @see Filter#onArchiveRender(SubEthaMessage, ArchiveRenderFilterContext)
	 */
	public void onArchiveRender(SubEthaMessage msg, Mail mail) throws MessagingException;
}