com.jalios.jcms.mail.listener
Class ArchiveMailListener

java.lang.Object
  com.jalios.jcms.mail.AbstractMailListener
      com.jalios.jcms.mail.listener.ArchiveMailListener

All Implemented Interfaces:

MailListener, JPropertiesListener, Comparable

public class ArchiveMailListener
extends AbstractMailListener
implements JPropertiesListener

Version:

$Revision: 24263 $

Author:

Jean-Philippe Encausse

Nested Class Summary

static class

ArchiveMailListener.ArchiveMailCriteria

Field Summary

static String

REVISION

Fields inherited from class com.jalios.jcms.mail.AbstractMailListener

order

Constructor Summary

ArchiveMailListener()

Method Summary

void	addMailPattern(String pattern, ArchiveMailListener.ArchiveMailCriteria criteria) Add the given pattern/check to ArchiveMailListener.
boolean	fetchMessage(MailMessage mail, boolean stored, Map<String,Object> context) Invoked after a mail was fetch.
Map<String,String>	listAllPatterns() Returns a Map of String pattern/check that can be used to display ArchivemailListener status
void	propertiesChange(JProperties properties) Invoked after properties have been modified in JCMS and save on disk.
void	removeMailPattern(String pattern) Remove pattern previously added
protected void	setCriteria(MailMessage mail, ArchiveMailListener.ArchiveMailCriteria criteria)

Methods inherited from class com.jalios.jcms.mail.AbstractMailListener

compareTo, equals, getOrder, setOrder

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

ArchiveMailListener

public ArchiveMailListener()

Method Detail

addMailPattern

public void addMailPattern(String pattern,
                           ArchiveMailListener.ArchiveMailCriteria criteria)

Add the given pattern/check to ArchiveMailListener. matching patterns will be stored in database.

Parameters:

pattern - String Regexp (eg .+@jcms.company.com)

criteria - structure ArchiveMailListener.ArchiveMailCriteria

removeMailPattern

public void removeMailPattern(String pattern)

Remove pattern previously added

Parameters:

pattern - String Regexp (eg .+@jcms.company.com)

listAllPatterns

public Map<String,String> listAllPatterns()

Returns a Map of String pattern/check that can be used to display ArchivemailListener status

Returns:

Map of pattern descriptino

propertiesChange

public void propertiesChange(JProperties properties)

Description copied from interface: JPropertiesListener

Invoked after properties have been modified in JCMS and save on disk.

You cannot alter the value received in parameters.

Specified by:

propertiesChange in interface JPropertiesListener

Parameters:

properties - the properties which have been modified (may not contain all JCMS properties)

fetchMessage

public boolean fetchMessage(MailMessage mail,
                            boolean stored,
                            Map<String,Object> context)

Description copied from interface: MailListener

Invoked after a mail was fetch.

Specified by:

fetchMessage in interface MailListener

Overrides:

fetchMessage in class AbstractMailListener

Parameters:

mail - the javax.mail.Message fetched

stored - boolean to store MailMessage in JCMS

context - a context used to store information

Returns:

boolean stored

See Also:

MailListener.fetchMessage(MailMessage, boolean, Map)

setCriteria

protected void setCriteria(MailMessage mail,
                           ArchiveMailListener.ArchiveMailCriteria criteria)