B C D E F G H I K L M O P R S T

B

BCC - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the blind carbon copied mail recipients.
bounce(Mail, String) - Method in interface org.apache.mailet.MailetContext
Bounces the message using a standard format with the given message.
bounce(Mail, String, MailAddress) - Method in interface org.apache.mailet.MailetContext
Bounces the email message using the provided email address as the sender of the bounce.

C

CC - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the carbon copied mail recipients.
COMMENTS - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores human-readable comments.
CONTENT_TYPE - Static variable in class org.apache.mailet.RFC2822Headers
The name of the MIME header that stores the content type.

D

DATE - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the mail date.
DEFAULT - Static variable in interface org.apache.mailet.Mail
 
destroy() - Method in class org.apache.mailet.GenericMailet
Called by the mailer container to indicate to a mailet that the mailet is being taken out of service.
destroy() - Method in class org.apache.mailet.GenericMatcher
Called by the mailet container to indicate to a matcher that the matcher is being taken out of service.
destroy() - Method in interface org.apache.mailet.Mailet
Called by the mailet container to indicate to a mailet that the mailet is being taken out of service.
destroy() - Method in interface org.apache.mailet.Matcher
Called by the mailet container to indicate to a matcher that the matcher is being taken out of service.

E

equals(Object) - Method in class org.apache.mailet.dates.RFC977DateFormat
Overrides equals
equals(Object) - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Overrides equals
equals(Object) - Method in class org.apache.mailet.MailAddress
 
ERROR - Static variable in interface org.apache.mailet.Mail
 

F

format(Date) - Method in class org.apache.mailet.dates.RFC977DateFormat
This method returns the long form of the RFC977 Date
format(Date) - Method in interface org.apache.mailet.dates.SimplifiedDateFormat
Formats a Date into a date/time string.
format(Date) - Method in class org.apache.mailet.dates.SynchronizedDateFormat
SimpleDateFormat will handle most of this for us, but we want to ensure thread safety, so we wrap the call in a synchronized block.
FROM - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the mail author(s).

G

GenericMailet - Class in org.apache.mailet
GenericMailet makes writing mailets easier.
GenericMailet() - Constructor for class org.apache.mailet.GenericMailet
 
GenericMatcher - Class in org.apache.mailet
GenericMatcher implements the Matcher and MatcherConfig interfaces.
GenericMatcher() - Constructor for class org.apache.mailet.GenericMatcher
 
GenericRecipientMatcher - Class in org.apache.mailet
GenericMatcher makes writing recipient based matchers easier.
GenericRecipientMatcher() - Constructor for class org.apache.mailet.GenericRecipientMatcher
 
getAttribute(String) - Method in interface org.apache.mailet.Mail
Returns the Mail session attribute with the given name, or null if there is no attribute by that name.
getAttribute(String) - Method in interface org.apache.mailet.MailetContext
Returns the mailet container attribute with the given name, or null if there is no attribute by that name.
getAttributeNames() - Method in interface org.apache.mailet.Mail
Returns an Iterator containing the attribute names currently available within this Mail instance.
getAttributeNames() - Method in interface org.apache.mailet.MailetContext
Returns an Iterator containing the attribute names available within this mailet context.
getCondition() - Method in class org.apache.mailet.GenericMatcher
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getCondition() - Method in interface org.apache.mailet.MatcherConfig
The simple condition defined for this matcher, e.g., for SenderIs=admin@localhost, this would return admin@localhost.
getErrorMessage() - Method in interface org.apache.mailet.Mail
The error message, if any, associated with this message.
getHost() - Method in class org.apache.mailet.MailAddress
Return the host part.
getHostName() - Method in class org.apache.mailet.HostAddress
 
getInitParameter(String) - Method in class org.apache.mailet.GenericMailet
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameter(String, String) - Method in class org.apache.mailet.GenericMailet
Returns a String containing the value of the named initialization parameter, or defValue if the parameter does not exist.
getInitParameter(String) - Method in interface org.apache.mailet.MailetConfig
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
getInitParameterNames() - Method in class org.apache.mailet.GenericMailet
Returns the names of the mailet's initialization parameters as an Iterator of String objects, or an empty Iterator if the mailet has no initialization parameters.
getInitParameterNames() - Method in interface org.apache.mailet.MailetConfig
Returns the names of the mailet's initialization parameters as an Iterator of String objects, or an empty Iterator if the mailet has no initialization parameters.
getLastUpdated() - Method in interface org.apache.mailet.Mail
 
getMailetConfig() - Method in class org.apache.mailet.GenericMailet
Returns this Mailet's MailetConfig object.
getMailetConfig() - Method in interface org.apache.mailet.Mailet
Returns a MailetConfig object, which contains initialization and startup parameters for this mailet.
getMailetContext() - Method in class org.apache.mailet.GenericMailet
Returns a reference to the MailetContext in which this mailet is running.
getMailetContext() - Method in class org.apache.mailet.GenericMatcher
Returns a reference to the MailetContext in which this matcher is running.
getMailetContext() - Method in interface org.apache.mailet.MailetConfig
Returns a reference to the MailetContext in which the mailet is executing.
getMailetContext() - Method in interface org.apache.mailet.MatcherConfig
Returns a reference to the MailetContext in which the matcher is executing
getMailetInfo() - Method in class org.apache.mailet.GenericMailet
Returns information about the mailet, such as author, version, and copyright.
getMailetInfo() - Method in interface org.apache.mailet.Mailet
Returns information about the mailet, such as author, version, and copyright.
getMailetName() - Method in class org.apache.mailet.GenericMailet
Returns the name of this mailet instance.
getMailetName() - Method in interface org.apache.mailet.MailetConfig
Returns the name of this mailet instance.
getMailServers(String) - Method in interface org.apache.mailet.MailetContext
Returns a Collection of Strings of hostnames or ip addresses that are specified as mail server listeners for the given hostname.
getMajorVersion() - Method in interface org.apache.mailet.MailetContext
Returns the major version of the Mailet API that this mailet container supports.
getMatcherConfig() - Method in class org.apache.mailet.GenericMatcher
Returns this matcher's MatcherConfig object.
getMatcherConfig() - Method in interface org.apache.mailet.Matcher
Returns a MatcherConfig object, which contains initialization and startup parameters for this matcher.
getMatcherInfo() - Method in class org.apache.mailet.GenericMatcher
Returns information about the matcher, such as author, version, and copyright.
getMatcherInfo() - Method in interface org.apache.mailet.Matcher
Returns information about the matcher, such as author, version, and copyright.
getMatcherName() - Method in class org.apache.mailet.GenericMatcher
Returns the name of this matcher instance.
getMatcherName() - Method in interface org.apache.mailet.MatcherConfig
Returns the name of this matcher instance.
getMessage() - Method in interface org.apache.mailet.Mail
Returns the MimeMessage stored in this message
getMessageSize() - Method in interface org.apache.mailet.Mail
 
getMinorVersion() - Method in interface org.apache.mailet.MailetContext
Returns the minor version of the Mailet API that this mailet container supports.
getName() - Method in interface org.apache.mailet.Mail
Returns the message name of this message
getPostmaster() - Method in interface org.apache.mailet.MailetContext
Returns the postmaster's address for this mailet context.
getRecipients() - Method in interface org.apache.mailet.Mail
Returns a Collection of MailAddress objects that are recipients of this message
getRemoteAddr() - Method in interface org.apache.mailet.Mail
The remote ip address of the server that connected to send this message
getRemoteHost() - Method in interface org.apache.mailet.Mail
The remote hostname of the server that connected to send this message
getSender() - Method in interface org.apache.mailet.Mail
The sender of the message, as specified by the MAIL FROM header, or internally defined
getServerInfo() - Method in interface org.apache.mailet.MailetContext
Returns the name and version of the mailet container on which the mailet is running.
getSMTPHostAddresses(String) - Method in interface org.apache.mailet.MailetContext
Returns an Iterator over HostAddress, a specialized subclass of javax.mail.URLName, which provides location information for servers that are specified as mail handlers for the given hostname.
getState() - Method in interface org.apache.mailet.Mail
The current state of the message, such as GHOST, ERROR, or DEFAULT
getTimeZone() - Method in class org.apache.mailet.dates.RFC977DateFormat
Gets the time zone.
getTimeZone() - Method in interface org.apache.mailet.dates.SimplifiedDateFormat
Gets the time zone.
getTimeZone() - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Gets the time zone.
getUser() - Method in class org.apache.mailet.MailAddress
Return the user part.
GHOST - Static variable in interface org.apache.mailet.Mail
 

H

hasAttributes() - Method in interface org.apache.mailet.Mail
 
hashCode() - Method in class org.apache.mailet.dates.RFC977DateFormat
Overrides hashCode
hashCode() - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Overrides hashCode
hashCode() - Method in class org.apache.mailet.MailAddress
Return a hashCode for this object which should be identical for addresses which are equivalent.
HostAddress - Class in org.apache.mailet
 
HostAddress(String, String) - Constructor for class org.apache.mailet.HostAddress
 

I

IN_REPLY_TO - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the message id of the message that to which this email is a reply.
init(MailetConfig) - Method in class org.apache.mailet.GenericMailet
Called by the mailet container to indicate to a mailet that the mailet is being placed into service.
init() - Method in class org.apache.mailet.GenericMailet
A convenience method which can be overridden so that there's no need to call super.init(config).
init(MatcherConfig) - Method in class org.apache.mailet.GenericMatcher
Called by the matcher container to indicate to a matcher that the matcher is being placed into service.
init() - Method in class org.apache.mailet.GenericMatcher
A convenience method which can be overridden so that there's no need to call super.init(config).
init(MailetConfig) - Method in interface org.apache.mailet.Mailet
Called by the mailet container to indicate to a mailet that the mailet is being placed into service.
init(MatcherConfig) - Method in interface org.apache.mailet.Matcher
Called by the mailet container to indicate to a matcher that the matcher is being placed into service.
isLenient() - Method in class org.apache.mailet.dates.RFC977DateFormat
Tell whether date/time parsing is to be lenient.
isLenient() - Method in interface org.apache.mailet.dates.SimplifiedDateFormat
Tell whether date/time parsing is to be lenient.
isLenient() - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Tell whether date/time parsing is to be lenient.
isLocalServer(String) - Method in interface org.apache.mailet.MailetContext
Checks if a server is serviced by mail context
isLocalUser(String) - Method in interface org.apache.mailet.MailetContext
Checks if a user account is exists in the mail context.

K

KEYWORDS - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores human-readable keywords.

L

log(String) - Method in class org.apache.mailet.GenericMailet
Writes the specified message to a mailet log file, prepended by the mailet's name.
log(String, Throwable) - Method in class org.apache.mailet.GenericMailet
Writes an explanatory message and a stack trace for a given Throwable exception to the mailet log file, prepended by the mailet's name.
log(String) - Method in class org.apache.mailet.GenericMatcher
Writes the specified message to a matcher log file, prepended by the matcher's name.
log(String, Throwable) - Method in class org.apache.mailet.GenericMatcher
Writes an explanatory message and a stack trace for a given Throwable exception to the matcher log file, prepended by the matcher's name.
log(String) - Method in interface org.apache.mailet.MailetContext
Writes the specified message to a mailet log file, usually an event log.
log(String, Throwable) - Method in interface org.apache.mailet.MailetContext
Writes an explanatory message and a stack trace for a given Throwable exception to the mailet log file.

M

Mail - Interface in org.apache.mailet
Wrap a MimeMessage with routing information (from SMTP) such as SMTP specified recipients, sender, and ip address and hostname of sending server.
MailAddress - Class in org.apache.mailet
A representation of an email address.
MailAddress(String) - Constructor for class org.apache.mailet.MailAddress
Construct a MailAddress parsing the provided String object.
MailAddress(String, String) - Constructor for class org.apache.mailet.MailAddress
Construct a MailAddress with the provided personal name and email address.
MailAddress(InternetAddress) - Constructor for class org.apache.mailet.MailAddress
Constructs a MailAddress from a JavaMail InternetAddress, using only the email address portion, discarding the personal name.
Mailet - Interface in org.apache.mailet
Draft of a Mailet inteface.
MailetConfig - Interface in org.apache.mailet
A mailet configuration object used by a mailet container to pass information to a mailet during initialization.
MailetContext - Interface in org.apache.mailet
Defines a set of methods that a mailet or matcher uses to communicate with its mailet container, for example, to send a new message, to deliver a message locally, or write to a log file.
MailetException - Exception in org.apache.mailet
Defines a general exception a mailet can throw when it encounters difficulty.
MailetException() - Constructor for exception org.apache.mailet.MailetException
Constructs a new mailet exception.
MailetException(String) - Constructor for exception org.apache.mailet.MailetException
Constructs a new mailet exception with the specified message.
MailetException(String, Exception) - Constructor for exception org.apache.mailet.MailetException
Constructs a new mailet exception when the mailet needs to throw an exception and include a message about the "root cause" exception that interfered with its normal operation, including a description message.
match(Mail) - Method in class org.apache.mailet.GenericMatcher
Called by the matcher container to allow the matcher to process a message.
match(Mail) - Method in class org.apache.mailet.GenericRecipientMatcher
Matches each recipient one by one through matchRecipient(MailAddress recipient) method.
match(Mail) - Method in interface org.apache.mailet.Matcher
Takes a Mail message, looks at any pertinent information, and then returns a subset of recipients that meet the "match" conditions.
Matcher - Interface in org.apache.mailet
This interface define the behaviour of the message "routing" inside the mailet container.
MatcherConfig - Interface in org.apache.mailet
A matcher configuration object used by a mailet container used to pass information to a matcher during initialization.
matchRecipient(MailAddress) - Method in class org.apache.mailet.GenericRecipientMatcher
Simple check to match exclusively on the email address (not message information).
MESSAGE_ID - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the message id.
MESSAGE_ID_VARIATION - Static variable in class org.apache.mailet.RFC2822Headers
A common variation on the name of the RFC 2822 header that stores the message id.

O

org.apache.mailet - package org.apache.mailet
The classes that constitute the Mailet API.
org.apache.mailet.dates - package org.apache.mailet.dates
 

P

parse(String) - Method in class org.apache.mailet.dates.RFC977DateFormat
Parses text from the beginning of the given string to produce a date.
parse(String) - Method in interface org.apache.mailet.dates.SimplifiedDateFormat
Parses text from the beginning of the given string to produce a date.
parse(String) - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Parses text from the beginning of the given string to produce a date.

R

RECEIVED - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 headers that store additional tracing data.
REFERENCES - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that is used to identify the thread to which this message refers.
removeAllAttributes() - Method in interface org.apache.mailet.Mail
Removes all the attributes associated with this Mail instance.
removeAttribute(String) - Method in interface org.apache.mailet.Mail
Removes the attribute with the given name from this Mail instance.
removeAttribute(String) - Method in interface org.apache.mailet.MailetContext
Removes the attribute with the given name from the mailet context.
REPLY_TO - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the reply-to address.
RESENT_BCC - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the blind carbon copied recipients of the resent message.
RESENT_CC - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the carbon copied recipients of the resent message.
RESENT_DATE - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the date the message was resent.
RESENT_FROM - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the originator of the resent message.
RESENT_MESSAGE_ID - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the message id of the resent message.
RESENT_SENDER - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the transmission agent of the resent message.
RESENT_TO - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the recipients of the resent message.
RETURN_PATH - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 headers that store the tracing data for the return path.
RFC2822Headers - Class in org.apache.mailet
This utility class provides the set of header names explicitly defined in RFC 2822
RFC2980DateFormat - Class in org.apache.mailet.dates
A thread-safe date formatting class to produce dates formatted in accord with the specifications of section 3.2 of RFC 2980.
RFC2980DateFormat() - Constructor for class org.apache.mailet.dates.RFC2980DateFormat
Constructor for RFC2980DateFormat
RFC822DateFormat - Class in org.apache.mailet.dates
A thread safe wrapper for the javax.mail.internet.MailDateFormat class.
RFC822DateFormat() - Constructor for class org.apache.mailet.dates.RFC822DateFormat
Constructor for RFC822DateFormat
RFC977DateFormat - Class in org.apache.mailet.dates
A thread-safe date formatting class to produce dates formatted in accord with the specifications of RFC 977.
RFC977DateFormat() - Constructor for class org.apache.mailet.dates.RFC977DateFormat
Constructor for RFC977DateFormat

S

SENDER - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the actual mail transmission agent, if this differs from the author of the message.
sendMail(MimeMessage) - Method in interface org.apache.mailet.MailetContext
Send an outgoing message to the top of this mailet container's root queue.
sendMail(MailAddress, Collection, MimeMessage) - Method in interface org.apache.mailet.MailetContext
Send an outgoing message to the top of this mailet container's root queue.
sendMail(MailAddress, Collection, MimeMessage, String) - Method in interface org.apache.mailet.MailetContext
Send an outgoing message to the top of this mailet container queue for the appropriate processor that is specified.
sendMail(Mail) - Method in interface org.apache.mailet.MailetContext
Send an outgoing message to the top of this mailet container's root queue.
serialVersionUID - Static variable in class org.apache.mailet.MailAddress
 
service(Mail) - Method in class org.apache.mailet.GenericMailet
Called by the mailet container to allow the mailet to process a message.
service(Mail) - Method in interface org.apache.mailet.Mailet
Called by the mailet container to allow the mailet to process to a message.
setAttribute(String, Serializable) - Method in interface org.apache.mailet.Mail
Binds an object to a given attribute name in this Mail instance.
setAttribute(String, Object) - Method in interface org.apache.mailet.MailetContext
Binds an object to a given attribute name in this mailet context.
setErrorMessage(String) - Method in interface org.apache.mailet.Mail
Sets the error message associated with this message.
setLastUpdated(Date) - Method in interface org.apache.mailet.Mail
 
setLenient(boolean) - Method in class org.apache.mailet.dates.RFC977DateFormat
Specify whether or not date/time parsing is to be lenient.
setLenient(boolean) - Method in interface org.apache.mailet.dates.SimplifiedDateFormat
Specify whether or not date/time parsing is to be lenient.
setLenient(boolean) - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Specify whether or not date/time parsing is to be lenient.
setMessage(MimeMessage) - Method in interface org.apache.mailet.Mail
Sets the MimeMessage associated with this message via the object.
setName(String) - Method in interface org.apache.mailet.Mail
Set the message name of this message
setRecipients(Collection) - Method in interface org.apache.mailet.Mail
Method setRecipients.
setState(String) - Method in interface org.apache.mailet.Mail
Sets the state of this message.
setTimeZone(TimeZone) - Method in class org.apache.mailet.dates.RFC977DateFormat
Sets the time zone of this SynchronizedDateFormat object.
setTimeZone(TimeZone) - Method in interface org.apache.mailet.dates.SimplifiedDateFormat
Sets the time zone of this SimplifiedDateFormat object.
setTimeZone(TimeZone) - Method in class org.apache.mailet.dates.SynchronizedDateFormat
Sets the time zone of this SynchronizedDateFormat object.
SimplifiedDateFormat - Interface in org.apache.mailet.dates
This interface is designed to provide a simplified subset of the methods provided by the java.text.DateFormat class.
storeMail(MailAddress, MailAddress, MimeMessage) - Method in interface org.apache.mailet.MailetContext
Deprecated. - use sparingly. Service will be replaced with resource acquired via JNDI.
SUBJECT - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the subject.
SynchronizedDateFormat - Class in org.apache.mailet.dates
This class is designed to be a synchronized wrapper for a java.text.DateFormat subclass.
SynchronizedDateFormat(String, Locale) - Constructor for class org.apache.mailet.dates.SynchronizedDateFormat
Public constructor that mimics that of SimpleDateFormat.
SynchronizedDateFormat(DateFormat) - Constructor for class org.apache.mailet.dates.SynchronizedDateFormat
Wrapper method to allow child classes to synchronize a preexisting DateFormat.

T

TO - Static variable in class org.apache.mailet.RFC2822Headers
The name of the RFC 2822 header that stores the primary mail recipients.
toInternetAddress() - Method in class org.apache.mailet.MailAddress
Return MailAddress as InternetAddress
toString(Date) - Static method in class org.apache.mailet.dates.RFC822DateFormat
Deprecated. This method is not necessary and is preserved for API backwards compatibility. Users of this class should instantiate an instance and use it as they would any other DateFormat object.
toString() - Method in class org.apache.mailet.MailAddress
 
TRANSPORT - Static variable in interface org.apache.mailet.Mail
 

B C D E F G H I K L M O P R S T

Copyright © 1999-2007 Apache Jakarta Project. All Rights Reserved.