org.apache.jsieve.mailet
Class SieveMailAdapter

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

All Implemented Interfaces:

MailAdapter, EnvelopeAccessors, ActionContext

public class SieveMailAdapter
extends java.lang.Object
implements MailAdapter, EnvelopeAccessors, ActionContext

Class SieveMailAdapter implements a MailAdapter for use in a Mailet environment.

Nested Class Summary

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

MailAdapter.Address

Constructor Summary

SieveMailAdapter(org.apache.mailet.Mail aMail, org.apache.mailet.MailetContext aMailetContext, ActionDispatcher dispatcher, Poster poster)
Constructor for SieveMailAdapter.

Method Summary

void	addAction(Action action) Adds an Action.
protected java.util.List	computeActions() Returns a new List of actions.
void	executeActions() Method executeActions.
java.util.List	getActions() Returns the List of actions.
java.util.ListIterator	getActionsIterator() Method getActionIteraror answers an Iterator over the List of Actions accumulated by the receiver.
java.lang.Object	getContent() Method getContent returns object containing the message content.
java.lang.String	getContentType() Method getContentType returns string/mime representation of the message type.
java.util.List	getEnvelope(java.lang.String name) Method getEnvelope answers a List of all of the envelope values in the receiver whose name is equal to the passed name.
java.lang.String	getEnvelopeFrom() Returns the from.
java.util.List	getEnvelopeNames() Method getEnvelopeNames answers a List of the names of the envelope values in the receiver.
protected java.util.Map	getEnvelopes() Method getEnvelopes.
java.lang.String	getEnvelopeTo() Returns the sole recipient or null if there isn't one.
java.util.List	getHeader(java.lang.String name) Method getHeader answers a List of all of the headers in the receiver whose name is equal to the passed name.
java.util.List	getHeaderNames() Method getHeaderNames answers a List of all of the headers in the receiver.
org.apache.commons.logging.Log	getLog() Gets the log.
org.apache.mailet.Mail	getMail() Returns the mail.
org.apache.mailet.MailetContext	getMailetContext() Returns the mailetContext.
java.util.List	getMatchingEnvelope(java.lang.String name) Method getMatchingEnvelope answers a List of all of the envelope values in the receiver with the passed name.
java.util.List	getMatchingHeader(java.lang.String name) Method getMatchingHeader answers a List of all of the headers in the receiver with the passed name.
protected javax.mail.internet.MimeMessage	getMessage() Returns the message.
java.lang.String	getServerInfo() Gets name (including version) of this server.
int	getSize() Method getSize answers the receiver's message size in octets.
MailAdapter.Address[]	parseAddresses(java.lang.String arg) Parses the named header value into individual addresses.
void	post(org.apache.mailet.MailAddress sender, java.util.Collection recipients, javax.mail.internet.MimeMessage mail) Posts the given mail.
void	post(java.lang.String uri, javax.mail.internet.MimeMessage mail) Experimental mail delivery.
protected void	setActions(java.util.List actions) Sets the actions.
void	setLog(org.apache.commons.logging.Log log)
protected void	setMail(org.apache.mailet.Mail mail) Sets the mail.
protected void	setMailetContext(org.apache.mailet.MailetContext mailetContext) Sets the mailetContext.
java.lang.String	toString()
protected void	updateActions() Updates the actions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SieveMailAdapter

public SieveMailAdapter(org.apache.mailet.Mail aMail,
                        org.apache.mailet.MailetContext aMailetContext,
                        ActionDispatcher dispatcher,
                        Poster poster)

Constructor for SieveMailAdapter.

Parameters:

aMail -

aMailetContext -

Method Detail

setLog

public void setLog(org.apache.commons.logging.Log log)

getMessage

protected javax.mail.internet.MimeMessage getMessage()
                                              throws javax.mail.MessagingException

Returns the message.

Returns:

MimeMessage

Throws:

javax.mail.MessagingException

getActions

public java.util.List getActions()

Returns the List of actions.

Specified by:

getActions in interface MailAdapter

Returns:

List

computeActions

protected java.util.List computeActions()

Returns a new List of actions.

Returns:

List

addAction

public void addAction(Action action)

Adds an Action.

Specified by:

addAction in interface MailAdapter

Parameters:

action - The action to set

executeActions

public void executeActions()
                    throws SieveException

Description copied from interface: MailAdapter

Method executeActions. Applies the Actions accumulated by the receiver.

Specified by:

executeActions in interface MailAdapter

Throws:

SieveException

See Also:

MailAdapter.executeActions()

setActions

protected void setActions(java.util.List actions)

Sets the actions.

Parameters:

actions - The actions to set

updateActions

protected void updateActions()

Updates the actions.

getActionsIterator

public java.util.ListIterator getActionsIterator()

Description copied from interface: MailAdapter

Method getActionIteraror answers an Iterator over the List of Actions accumulated by the receiver. Implementations may elect to supply an unmodifiable iterator.

Specified by:

getActionsIterator in interface MailAdapter

Returns:

ListIterator, not null, possibly unmodifiable

See Also:

MailAdapter.getActionsIterator()

getHeader

public java.util.List getHeader(java.lang.String name)
                         throws SieveMailException

Description copied from interface: MailAdapter

Method getHeader answers a List of all of the headers in the receiver whose name is equal to the passed name. If no headers are found an empty List is returned.

Specified by:

getHeader in interface MailAdapter

Returns:

List not null, possibly empty, possible unmodifiable

Throws:

SieveMailException

See Also:

MailAdapter.getHeader(String)

getHeaderNames

public java.util.List getHeaderNames()
                              throws SieveMailException

Description copied from interface: MailAdapter

Method getHeaderNames answers a List of all of the headers in the receiver. No duplicates are allowed.

Specified by:

getHeaderNames in interface MailAdapter

Returns:

List, not null possible empty, possible unmodifiable

Throws:

SieveMailException

See Also:

MailAdapter.getHeaderNames()

getMatchingHeader

public java.util.List getMatchingHeader(java.lang.String name)
                                 throws SieveMailException

Description copied from interface: MailAdapter

Method getMatchingHeader answers a List of all of the headers in the receiver with the passed name. If no headers are found an empty List is returned.

This method differs from getHeader(String) in that it ignores case and the whitespace prefixes and suffixes of a header name when performing the match, as required by RFC 3028. Thus "From", "from ", " From" and " from " are considered equal.

Specified by:

getMatchingHeader in interface MailAdapter

Returns:

List, not null possibly empty, possible unmodifiable

Throws:

SieveMailException

See Also:

MailAdapter.getMatchingHeader(String)

getSize

public int getSize()
            throws SieveMailException

Description copied from interface: MailAdapter

Method getSize answers the receiver's message size in octets.

Specified by:

getSize in interface MailAdapter

Returns:

int

Throws:

SieveMailException

See Also:

MailAdapter.getSize()

getEnvelopes

protected java.util.Map getEnvelopes()

Method getEnvelopes.

Returns:

Map

getEnvelope

public java.util.List getEnvelope(java.lang.String name)
                           throws SieveMailException

Description copied from interface: EnvelopeAccessors

Method getEnvelope answers a List of all of the envelope values in the receiver whose name is equal to the passed name. If no values are found an empty List is returned.

Specified by:

getEnvelope in interface EnvelopeAccessors

Returns:

List

Throws:

SieveMailException

See Also:

EnvelopeAccessors.getEnvelope(String)

getEnvelopeNames

public java.util.List getEnvelopeNames()
                                throws SieveMailException

Description copied from interface: EnvelopeAccessors

Method getEnvelopeNames answers a List of the names of the envelope values in the receiver. No duplicates are allowed.

Specified by:

getEnvelopeNames in interface EnvelopeAccessors

Returns:

List

Throws:

SieveMailException

See Also:

EnvelopeAccessors.getEnvelopeNames()

getMatchingEnvelope

public java.util.List getMatchingEnvelope(java.lang.String name)
                                   throws SieveMailException

Description copied from interface: EnvelopeAccessors

Method getMatchingEnvelope answers a List of all of the envelope values in the receiver with the passed name. If no matching names are found an empty List is returned.

This method differs from getEnvelope(String) in that it ignores case and the whitespace prefixes and suffixes of an envelope value name when performing the match, as required by RFC 3028. Thus "From", "from ", " From" and " from " are considered equal.

Specified by:

getMatchingEnvelope in interface EnvelopeAccessors

Returns:

List

Throws:

SieveMailException

See Also:

EnvelopeAccessors.getMatchingEnvelope(String)

getEnvelopeFrom

public java.lang.String getEnvelopeFrom()

Returns the from.

Returns:

String

getEnvelopeTo

public java.lang.String getEnvelopeTo()

Returns the sole recipient or null if there isn't one.

Returns:

String

getMail

public org.apache.mailet.Mail getMail()

Returns the mail.

Returns:

Mail

setMail

protected void setMail(org.apache.mailet.Mail mail)

Sets the mail.

Parameters:

mail - The mail to set

getMailetContext

public org.apache.mailet.MailetContext getMailetContext()

Returns the mailetContext.

Returns:

MailetContext

setMailetContext

protected void setMailetContext(org.apache.mailet.MailetContext mailetContext)

Sets the mailetContext.

Parameters:

mailetContext - The mailetContext to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getContent

public java.lang.Object getContent()
                            throws SieveMailException

Description copied from interface: MailAdapter

Method getContent returns object containing the message content. TODO: This is poorly defined. TODO: This is used to search a mail body and needs to return a string. TODO: But creating a string is not efficient. TODO: It would be better to allow the adapter to search.

Specified by:

getContent in interface MailAdapter

Returns:

Object

Throws:

SieveMailException

getContentType

public java.lang.String getContentType()
                                throws SieveMailException

Description copied from interface: MailAdapter

Method getContentType returns string/mime representation of the message type.

Specified by:

getContentType in interface MailAdapter

Returns:

String

Throws:

SieveMailException

parseAddresses

public MailAdapter.Address[] parseAddresses(java.lang.String arg)
                                     throws SieveMailException,
                                            InternetAddressException

Description copied from interface: MailAdapter

Parses the named header value into individual addresses.

Headers should be matched in a way that ignores case and the whitespace prefixes and suffixes of a header name when performing the match, as required by RFC 3028. Thus "From", "from ", " From" and " from " are considered equal.

Specified by:

parseAddresses in interface MailAdapter

Parameters:

arg - name of the header whose value is to be split

Returns:

addresses listed in the given header not null, possibly empty

Throws:

SieveMailException - when the header value cannot be read

InternetAddressException - when the header value is not an address or list of addresses. Implemetations may elect to support only standard headers known to containing one or more addresses rather than parsing the value content

getLog

public org.apache.commons.logging.Log getLog()

Description copied from interface: ActionContext

Gets the log.

Specified by:

getLog in interface ActionContext

Returns:

not null

getServerInfo

public java.lang.String getServerInfo()

Description copied from interface: ActionContext

Gets name (including version) of this server.

Specified by:

getServerInfo in interface ActionContext

Returns:

not nul

post

public void post(java.lang.String uri,
                 javax.mail.internet.MimeMessage mail)
          throws javax.mail.MessagingException

Description copied from interface: ActionContext

Experimental mail delivery. POST verb indicate that mail should be attached to the collection indicated by the given URI.

Specified by:

post in interface ActionContext

Parameters:

uri - indicates the destination to which the mail to added. ATM the value should be mailbox://@localhost/

mail - not null

Throws:

javax.mail.MessagingException

post

public void post(org.apache.mailet.MailAddress sender,
                 java.util.Collection recipients,
                 javax.mail.internet.MimeMessage mail)
          throws javax.mail.MessagingException

Description copied from interface: ActionContext

Posts the given mail.

Specified by:

post in interface ActionContext

Parameters:

sender - possibly null

recipients - not null

mail - not null

Throws:

javax.mail.MessagingException - when mail cannot be posted