|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jsieve.mailet.SieveMailAdapter
public class SieveMailAdapter
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<Action> |
computeActions()
Returns a new List of actions. |
void |
executeActions()
Method executeActions. |
java.util.List<Action> |
getActions()
Returns the List of actions. |
java.lang.String |
getContentType()
Method getContentType returns string/mime representation of the message type. |
java.util.List<java.lang.String> |
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<java.lang.String> |
getEnvelopeNames()
Method getEnvelopeNames answers a List of the names of the envelope values in the receiver. |
protected java.util.Map<java.lang.String,java.lang.String> |
getEnvelopes()
Method getEnvelopes. |
java.lang.String |
getEnvelopeTo()
Returns the sole recipient or null if there isn't one. |
java.util.List<java.lang.String> |
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<java.lang.String> |
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<java.lang.String> |
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<java.lang.String> |
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. |
boolean |
isInBodyText(java.lang.String phraseCaseInsensitive)
Is the given phrase found in the body text of this mail? This search should be case insensitive. |
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<Action> actions)
Sets the actions. |
void |
setContext(SieveContext context)
Sets the context for the current sieve script execution. |
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 |
---|
public SieveMailAdapter(org.apache.mailet.Mail aMail, org.apache.mailet.MailetContext aMailetContext, ActionDispatcher dispatcher, Poster poster)
aMail
- aMailetContext
- Method Detail |
---|
public void setLog(org.apache.commons.logging.Log log)
protected javax.mail.internet.MimeMessage getMessage() throws javax.mail.MessagingException
javax.mail.MessagingException
public java.util.List<Action> getActions()
getActions
in interface MailAdapter
protected java.util.List<Action> computeActions()
public void addAction(Action action)
addAction
in interface MailAdapter
action
- The action to setpublic void executeActions() throws SieveException
MailAdapter
executeActions
in interface MailAdapter
SieveException
MailAdapter.executeActions()
protected void setActions(java.util.List<Action> actions)
actions
- The actions to setprotected void updateActions()
public java.util.List<java.lang.String> getHeader(java.lang.String name) throws SieveMailException
MailAdapter
getHeader
in interface MailAdapter
List
not null, possibly empty, possible
unmodifiable
SieveMailException
MailAdapter.getHeader(String)
public java.util.List<java.lang.String> getHeaderNames() throws SieveMailException
MailAdapter
getHeaderNames
in interface MailAdapter
List
, not null possible empty, possible
unmodifiable
SieveMailException
MailAdapter.getHeaderNames()
public java.util.List<java.lang.String> getMatchingHeader(java.lang.String name) throws SieveMailException
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.
getMatchingHeader
in interface MailAdapter
List
, not null possibly empty, possible
unmodifiable
SieveMailException
MailAdapter.getMatchingHeader(String)
public int getSize() throws SieveMailException
MailAdapter
getSize
in interface MailAdapter
SieveMailException
MailAdapter.getSize()
protected java.util.Map<java.lang.String,java.lang.String> getEnvelopes()
public java.util.List<java.lang.String> getEnvelope(java.lang.String name) throws SieveMailException
EnvelopeAccessors
getEnvelope
in interface EnvelopeAccessors
SieveMailException
EnvelopeAccessors.getEnvelope(String)
public java.util.List<java.lang.String> getEnvelopeNames() throws SieveMailException
EnvelopeAccessors
getEnvelopeNames
in interface EnvelopeAccessors
SieveMailException
EnvelopeAccessors.getEnvelopeNames()
public java.util.List<java.lang.String> getMatchingEnvelope(java.lang.String name) throws SieveMailException
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.
getMatchingEnvelope
in interface EnvelopeAccessors
SieveMailException
EnvelopeAccessors.getMatchingEnvelope(String)
public java.lang.String getEnvelopeFrom()
public java.lang.String getEnvelopeTo()
public org.apache.mailet.Mail getMail()
protected void setMail(org.apache.mailet.Mail mail)
mail
- The mail to setpublic org.apache.mailet.MailetContext getMailetContext()
protected void setMailetContext(org.apache.mailet.MailetContext mailetContext)
mailetContext
- The mailetContext to setpublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public java.lang.String getContentType() throws SieveMailException
MailAdapter
getContentType
in interface MailAdapter
SieveMailException
public MailAdapter.Address[] parseAddresses(java.lang.String arg) throws SieveMailException, InternetAddressException
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.
parseAddresses
in interface MailAdapter
arg
- name of the header whose value is to be split
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 contentpublic org.apache.commons.logging.Log getLog()
ActionContext
getLog
in interface ActionContext
public java.lang.String getServerInfo()
ActionContext
getServerInfo
in interface ActionContext
public void post(java.lang.String uri, javax.mail.internet.MimeMessage mail) throws javax.mail.MessagingException
ActionContext
post
in interface ActionContext
uri
- indicates the destination to which the mail to added. ATM
the value should be mailbox://mail
- not null
javax.mail.MessagingException
public void post(org.apache.mailet.MailAddress sender, java.util.Collection recipients, javax.mail.internet.MimeMessage mail) throws javax.mail.MessagingException
ActionContext
post
in interface ActionContext
sender
- possibly nullrecipients
- not nullmail
- not null
javax.mail.MessagingException
- when mail cannot be postedpublic boolean isInBodyText(java.lang.String phraseCaseInsensitive) throws SieveMailException
MailAdapter
isInBodyText
in interface MailAdapter
phraseCaseInsensitive
- the phrase to search
SieveMailException
- when the search cannot be completedpublic void setContext(SieveContext context)
MailAdapter
Sets the context for the current sieve script execution.
Sieve engines MUST
set this property before any calls
related to the execution of a script are made.
Implementations intended to be shared between separate threads of
execution MUST
ensure that they manage concurrency contexts,
for example by storage in a thread local variable. Engines MUST
- for a script execution - ensure that all calls are made within the
same thread of execution.
setContext
in interface MailAdapter
context
- the current context,
or null to clear the contest once the execution of a script has completed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |