B D E G H I L M O R S T

B

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 message using a standard format with the given message.

D

DEFAULT - Static variable in interface org.apache.mailet.Mail
 
destroy() - Method in interface org.apache.mailet.Mailet
Destroys this Mailet.
destroy() - Method in interface org.apache.mailet.Matcher
Destroys this Matcher.

E

equals(Object) - Method in class org.apache.mailet.MailAddress
Indicates whether some other object is "equal to" this one.
ERROR - Static variable in interface org.apache.mailet.Mail
 

G

getAttribute(String) - Method in interface org.apache.mailet.Mail
Returns the value of the named Mail instance attribute, or null if the attribute does not exist.
getAttribute(String) - Method in interface org.apache.mailet.MailetContext
Returns the value of the named mailet context attribute, or null if the attribute does not exist.
getAttributeNames() - Method in interface org.apache.mailet.Mail
Returns an Iterator over the names of all attributes which are set in this Mail instance.
getAttributeNames() - Method in interface org.apache.mailet.MailetContext
Returns an Iterator over the names of all attributes which are set in this mailet context.
getCondition() - Method in interface org.apache.mailet.MatcherConfig
The condition defined for this matcher.
getDomain() - Method in class org.apache.mailet.MailAddress
Returns the domain part per RFC2822 3.4.1.
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
Deprecated. use MailAddress.getDomain(), whose name was changed to align with RFC2822 3.4.1. addr-spec specification
getHostName() - Method in class org.apache.mailet.HostAddress
Returns the host name corresponding to the url
getInitParameter(String) - Method in interface org.apache.mailet.MailetConfig
Returns the value of the named initialization parameter, or null if the parameter does not exist.
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
Returns the time at which this Mail was last updated.
getLocalPart() - Method in class org.apache.mailet.MailAddress
Returns the local-part per RFC2822 3.4.1.
getMailetConfig() - Method in interface org.apache.mailet.Mailet
Returns a MailetConfig object, which provides initialization parameters and a MailetContext through which it can interact with the mailet container.
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 interface org.apache.mailet.Mailet
Returns information about the mailet, such as author, version and copyright.
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 the hostnames that are specified as mail handlers for the given domain name.
getMajorVersion() - Method in interface org.apache.mailet.MailetContext
Returns the major version number of the Mailet API that this mailet container supports.
getMatcherConfig() - Method in interface org.apache.mailet.Matcher
Returns a MatcherConfig object, which provides initialization parameters and a MailetContext through which it can interact with the mailet container.
getMatcherInfo() - Method in interface org.apache.mailet.Matcher
Returns information about the matcher, such as author, version and copyright.
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
Returns the message size (including headers).
getMinorVersion() - Method in interface org.apache.mailet.MailetContext
Returns the minor version number of the Mailet API that this mailet container supports.
getName() - Method in interface org.apache.mailet.Mail
Returns the name of this message.
getPostmaster() - Method in interface org.apache.mailet.MailetContext
Returns the Postmaster address for this mailet context.
getRecipients() - Method in interface org.apache.mailet.Mail
Returns the message recipients as a Collection of MailAddress objects, as specified by the SMTP "RCPT TO" command, or internally defined.
getRemoteAddr() - Method in interface org.apache.mailet.Mail
Returns the IP address of the remote server that sent this message.
getRemoteHost() - Method in interface org.apache.mailet.Mail
Returns the host name of the remote server that sent this message.
getSender() - Method in interface org.apache.mailet.Mail
Returns the sender of the message, as specified by the SMTP "MAIL FROM" command, 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 the SMTP host addresses specified as mail handlers for the given domain name.
getState() - Method in interface org.apache.mailet.Mail
Returns the current state of the message, such as GHOST, ERROR or DEFAULT.
getUser() - Method in class org.apache.mailet.MailAddress
Deprecated. use MailAddress.getLocalPart(), whose name was changed to align with the RFC2822 3.4.1. addr-spec specification
GHOST - Static variable in interface org.apache.mailet.Mail
 

H

hasAttributes() - Method in interface org.apache.mailet.Mail
Returns whether this Mail instance has any attributes set.
hashCode() - Method in class org.apache.mailet.MailAddress
Returns a hash code value for this object.
HostAddress - Class in org.apache.mailet
A specialized subclass of javax.mail.URLName, which provides the name of a URL as well as its corresponding host name.
HostAddress(String, String) - Constructor for class org.apache.mailet.HostAddress
Constructs a new host address with the given details.

I

init(MailetConfig) - Method in interface org.apache.mailet.Mailet
Initializes this Mailet.
init(MatcherConfig) - Method in interface org.apache.mailet.Matcher
Initializes this Matcher.
isLocalEmail(MailAddress) - Method in interface org.apache.mailet.MailetContext
Checks if an address is local, i.e.
isLocalServer(String) - Method in interface org.apache.mailet.MailetContext
Checks if a host name is local, i.e.
isLocalUser(String) - Method in interface org.apache.mailet.MailetContext
Deprecated. use MailetContext.isLocalEmail(MailAddress) instead

L

log(String) - Method in interface org.apache.mailet.MailetContext
Writes the specified message to a mailet log.
log(String, Throwable) - Method in interface org.apache.mailet.MailetContext
Writes the specified message to a mailet log, along with the stack trace of the given Throwable.

M

Mail - Interface in org.apache.mailet
Wraps a MimeMessage with additional routing and processing information.
MailAddress - Class in org.apache.mailet
A representation of an email address.
MailAddress(String) - Constructor for class org.apache.mailet.MailAddress
Constructs a MailAddress by parsing the provided address.
MailAddress(String, String) - Constructor for class org.apache.mailet.MailAddress
Constructs a MailAddress with the provided local part and domain.
MailAddress(InternetAddress) - Constructor for class org.apache.mailet.MailAddress
Constructs a MailAddress from an InternetAddress, using only the email address portion (an "addr-spec", not "name-addr", as defined in the RFC2822 3.4.
Mailet - Interface in org.apache.mailet
A Mailet processes mail messages.
MailetConfig - Interface in org.apache.mailet
A mailet configuration object used by the mailet container to pass information to a mailet during initialization.
MailetContext - Interface in org.apache.mailet
Defines a set of methods that can be used to interact with the mailet container.
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 with the specified message and an exception which is the "root cause" of the exception.
match(Mail) - Method in interface org.apache.mailet.Matcher
Takes a Mail message, looks at any pertinent information, and returns a subset of recipients that meet the match conditions.
Matcher - Interface in org.apache.mailet
This interface defines the behaviour of the message "routing" inside the mailet container.
MatcherConfig - Interface in org.apache.mailet
A matcher configuration object used by the mailet container to pass information to a matcher during initialization.

O

org.apache.mailet - package org.apache.mailet
This package constitutes the Mailet API.

R

removeAllAttributes() - Method in interface org.apache.mailet.Mail
Removes all 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 this Mail instance.

S

sendMail(MimeMessage) - Method in interface org.apache.mailet.MailetContext
Sends an outgoing message to the top of this mailet container's root queue.
sendMail(MailAddress, Collection, MimeMessage) - Method in interface org.apache.mailet.MailetContext
Sends 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
Sends an outgoing message to the top of this mailet container's queue for the specified processor.
sendMail(Mail) - Method in interface org.apache.mailet.MailetContext
Sends an outgoing message to the top of this mailet container's root queue.
serialVersionUID - Static variable in class org.apache.mailet.MailAddress
We hardcode the serialVersionUID This version (2779163542539434916L) retains compatibility back to Mailet version 1.2 (James 1.2) so that MailAddress will be deserializable and mail doesn't get lost after an upgrade.
service(Mail) - Method in interface org.apache.mailet.Mailet
Services a mail message.
setAttribute(String, Serializable) - Method in interface org.apache.mailet.Mail
Associates an attribute with the given name and value with this Mail instance.
setAttribute(String, Object) - Method in interface org.apache.mailet.MailetContext
Associates an attribute with the given name and value with 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
Sets the time at which this Mail was last updated.
setMessage(MimeMessage) - Method in interface org.apache.mailet.Mail
Sets the MimeMessage wrapped by this Mail instance.
setName(String) - Method in interface org.apache.mailet.Mail
Set the name of this message.
setRecipients(Collection) - Method in interface org.apache.mailet.Mail
Sets the message recipients as a Collection of MailAddress objects.
setState(String) - Method in interface org.apache.mailet.Mail
Sets the state of this message.
storeMail(MailAddress, MailAddress, MimeMessage) - Method in interface org.apache.mailet.MailetContext
Deprecated. - use sparingly. Service will be replaced with resource acquired via JNDI.

T

toInternetAddress() - Method in class org.apache.mailet.MailAddress
Returns an InternetAddress representing the same address as this MailAddress.
toString() - Method in class org.apache.mailet.MailAddress
 
TRANSPORT - Static variable in interface org.apache.mailet.Mail
 

B D E G H I L M O R S T

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