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 email message using the provided email address as the sender of the bounce.

D

DEFAULT - Static variable in interface org.apache.mailet.Mail
 
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

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

G

GHOST - Static variable in interface org.apache.mailet.Mail
 
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 interface org.apache.mailet.MatcherConfig
The simple condition defined for this matcher, e.g., for SenderIs=admin@localhost, this would return admin@localhost.
getDomain() - Method in class org.apache.mailet.MailAddress
Return 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 getDomain() - name change to align with RFC2822 3.4.1. Addr-spec specification
getHostName() - Method in class org.apache.mailet.HostAddress
 
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 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
 
getLocalPart() - Method in class org.apache.mailet.MailAddress
Return the local-part per RFC2822 3.4.1.
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.
getMailetConfig() - Method in interface org.apache.mailet.Mailet
Returns a MailetConfig object, which contains initialization and startup parameters for this mailet.
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.
getMajorVersion() - Method in interface org.apache.mailet.MailetContext
Returns the major version of the Mailet API that this mailet container supports.
getMatcherConfig() - Method in interface org.apache.mailet.Matcher
Returns a MatcherConfig object, which contains initialization and startup parameters for this matcher.
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
 
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
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.
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.
getState() - Method in interface org.apache.mailet.Mail
The current state of the message, such as GHOST, ERROR, or DEFAULT
getUser() - Method in class org.apache.mailet.MailAddress
Deprecated. use getLocalPart() - name change to align with RFC2822 3.4.1. Addr-spec specification

H

HostAddress - class org.apache.mailet.HostAddress.
A specialized subclass of javax.mail.URLName, which provides location information for servers.
HostAddress(String, String) - Constructor for class org.apache.mailet.HostAddress
 
hasAttributes() - Method in interface org.apache.mailet.Mail
 
hashCode() - Method in class org.apache.mailet.MailAddress
Return a hashCode for this object which should be identical for addresses which are equivalent.

I

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.
isLocalEmail(MailAddress) - Method in interface org.apache.mailet.MailetContext
Checks if a user account is exists in the mail context.
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
Deprecated. use isLocalEmail(MailAddress) instead

L

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 org.apache.mailet.Mail.
Wrap a MimeMessage with routing information (from SMTP) such as SMTP specified recipients, sender, and ip address and hostname of sending server.
MailAddress - class org.apache.mailet.MailAddress.
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 org.apache.mailet.Mailet.
Draft of a Mailet inteface.
MailetConfig - interface org.apache.mailet.MailetConfig.
A mailet configuration object used by a mailet container to pass information to a mailet during initialization.
MailetContext - interface org.apache.mailet.MailetContext.
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 org.apache.mailet.MailetException.
Defines a general exception a mailet can throw when it encounters difficulty.
MailetException() - Constructor for class org.apache.mailet.MailetException
Constructs a new mailet exception.
MailetException(String) - Constructor for class org.apache.mailet.MailetException
Constructs a new mailet exception with the specified message.
MailetException(String, Exception) - Constructor for class 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.
Matcher - interface org.apache.mailet.Matcher.
This interface define the behaviour of the message "routing" inside the mailet container.
MatcherConfig - interface org.apache.mailet.MatcherConfig.
A matcher configuration object used by a mailet container used to pass information to a matcher during initialization.
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.

O

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

R

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.

S

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
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
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
 
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.
storeMail(MailAddress, MailAddress, MimeMessage) - Method in interface org.apache.mailet.MailetContext
Deprecated. - use sparingly. Service will be replaced with resource acquired via JNDI.

T

TRANSPORT - Static variable in interface org.apache.mailet.Mail
 
toInternetAddress() - Method in class org.apache.mailet.MailAddress
Return MailAddress as InternetAddress
toString() - Method in class org.apache.mailet.MailAddress
 

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

Copyright (c) 2008 Apache Software Foundation Apache 2.0 Licensed.