org.apache.jsieve.mail.optional
Interface EnvelopeAccessors

All Known Implementing Classes:
SieveMailAdapter

public interface EnvelopeAccessors

Interface EnvelopeAccessors specifies the method signatures required to support the Envelope Test.


Method Summary
 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.util.List getEnvelopeNames()
          Method getEnvelopeNames answers a List of the names of the envelope values in the receiver.
 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.
 

Method Detail

getEnvelope

java.util.List getEnvelope(java.lang.String name)
                           throws SieveMailException
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.

Parameters:
name -
Returns:
List
Throws:
SieveMailException

getEnvelopeNames

java.util.List getEnvelopeNames()
                                throws SieveMailException
Method getEnvelopeNames answers a List of the names of the envelope values in the receiver. No duplicates are allowed.

Returns:
List
Throws:
SieveMailException

getMatchingEnvelope

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

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.

Parameters:
name -
Returns:
List
Throws:
SieveMailException


Copyright © 2008-2009 The Apache Software Foundation. All Rights Reserved.