org.apache.jsieve.utils
Class SieveMailAdapter

java.lang.Object
  org.apache.jsieve.utils.SieveMailAdapter

All Implemented Interfaces:

org.apache.jsieve.mail.MailAdapter

Direct Known Subclasses:

SieveEnvelopeMailAdapter

public class SieveMailAdapter
extends java.lang.Object
implements org.apache.jsieve.mail.MailAdapter

Class SieveMailAdapter implements a mock MailAdapter for testing purposes.

Being a mock object, Actions are not performed against a mail server, but in most other respects it behaves as would expect a MailAdapter wrapping a JavaMail message should. To this extent, it is a useful demonstration of how to create an implementation of a MailAdapter.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jsieve.mail.MailAdapter

org.apache.jsieve.mail.MailAdapter.Address

Constructor Summary

SieveMailAdapter(javax.mail.internet.MimeMessage message)
Constructor for SieveMailAdapter.

Method Summary

void	addAction(org.apache.jsieve.mail.Action action) Adds an Action.
protected java.util.List<org.apache.jsieve.mail.Action>	computeActions() Returns a new List of actions.
void	executeActions()
java.util.List<org.apache.jsieve.mail.Action>	getActions() Returns the List of actions.
java.lang.String	getContentType()
java.util.List<java.lang.String>	getHeader(java.lang.String name)
java.util.List<java.lang.String>	getHeaderNames()
java.util.List<java.lang.String>	getMatchingHeader(java.lang.String name)
javax.mail.internet.MimeMessage	getMessage() Returns the message.
int	getSize()
boolean	isInBodyText(java.lang.String phraseCaseInsensitive)
org.apache.jsieve.mail.MailAdapter.Address[]	parseAddresses(java.lang.String headerName)
org.apache.jsieve.mail.MailAdapter.Address[]	parseAddresses(java.lang.String headerName, javax.mail.Message message) Parses the value from the given message into addresses.
protected void	setActions(java.util.List<org.apache.jsieve.mail.Action> actions) Sets the actions.
void	setContext(SieveContext context)
protected void	setMessage(javax.mail.internet.MimeMessage message) Sets the message.
protected void	updateActions() Updates the actions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SieveMailAdapter

public SieveMailAdapter(javax.mail.internet.MimeMessage message)

Constructor for SieveMailAdapter.

Parameters:

message -

Method Detail

getMessage

public javax.mail.internet.MimeMessage getMessage()

Returns the message.

Returns:

MimeMessage

setMessage

protected void setMessage(javax.mail.internet.MimeMessage message)

Sets the message.

Parameters:

message - The message to set

getActions

public java.util.List<org.apache.jsieve.mail.Action> getActions()

Returns the List of actions.

Specified by:

getActions in interface org.apache.jsieve.mail.MailAdapter

Returns:

List

computeActions

protected java.util.List<org.apache.jsieve.mail.Action> computeActions()

Returns a new List of actions.

Returns:

List

addAction

public void addAction(org.apache.jsieve.mail.Action action)

Adds an Action.

Specified by:

addAction in interface org.apache.jsieve.mail.MailAdapter

Parameters:

action - The action to set

executeActions

public void executeActions()
                    throws org.apache.jsieve.exception.SieveException

Specified by:

executeActions in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.exception.SieveException

See Also:

MailAdapter.executeActions()

setActions

protected void setActions(java.util.List<org.apache.jsieve.mail.Action> actions)

Sets the actions.

Parameters:

actions - The actions to set

updateActions

protected void updateActions()

Updates the actions.

getHeader

public java.util.List<java.lang.String> getHeader(java.lang.String name)
                                           throws org.apache.jsieve.mail.SieveMailException

Specified by:

getHeader in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

See Also:

MailAdapter.getHeader(String)

getHeaderNames

public java.util.List<java.lang.String> getHeaderNames()
                                                throws org.apache.jsieve.mail.SieveMailException

Specified by:

getHeaderNames in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

See Also:

MailAdapter.getHeaderNames()

getMatchingHeader

public java.util.List<java.lang.String> getMatchingHeader(java.lang.String name)
                                                   throws org.apache.jsieve.mail.SieveMailException

Specified by:

getMatchingHeader in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

See Also:

MailAdapter.getMatchingHeader(String)

getSize

public int getSize()
            throws org.apache.jsieve.mail.SieveMailException

Specified by:

getSize in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

See Also:

MailAdapter.getSize()

getContentType

public java.lang.String getContentType()
                                throws org.apache.jsieve.mail.SieveMailException

Specified by:

getContentType in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

See Also:

MailAdapter.getContentType()

parseAddresses

public org.apache.jsieve.mail.MailAdapter.Address[] parseAddresses(java.lang.String headerName)
                                                            throws org.apache.jsieve.mail.SieveMailException

Specified by:

parseAddresses in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

parseAddresses

public org.apache.jsieve.mail.MailAdapter.Address[] parseAddresses(java.lang.String headerName,
                                                                   javax.mail.Message message)
                                                            throws org.apache.jsieve.mail.SieveMailException

Parses the value from the given message into addresses.

Parameters:

headerName - header name, to be matched case insensitively

message - Message, not null

Returns:

Address array, not null possibly empty

Throws:

org.apache.jsieve.mail.SieveMailException

isInBodyText

public boolean isInBodyText(java.lang.String phraseCaseInsensitive)
                     throws org.apache.jsieve.mail.SieveMailException

Specified by:

isInBodyText in interface org.apache.jsieve.mail.MailAdapter

Throws:

org.apache.jsieve.mail.SieveMailException

setContext

public void setContext(SieveContext context)

Specified by:

setContext in interface org.apache.jsieve.mail.MailAdapter