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

A

AbstractDataContentHandler - Class in org.apache.mailet.base.mail

Abstract class providing common Data Handler behavior.

AbstractDataContentHandler() - Constructor for class org.apache.mailet.base.mail.AbstractDataContentHandler

Default Constructor

arrayToString(Object[]) - Method in class org.apache.mailet.base.GenericMailet

Utility method for obtaining a string representation of an array of Objects.

B

BCC - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the blind carbon copied mail recipients.

C

capitalizeWords(String) - Static method in class org.apache.mailet.base.StringUtils

Capitalizes each word in the given text by converting the first letter to upper case.

CC - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the carbon copied mail recipients.

checkInitParameters(String[]) - Method in class org.apache.mailet.base.GenericMailet

Utility method: Checks if there are unallowed init parameters specified in the configuration file against the String[] allowedInitParameters.

COMMENTS - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores human-readable comments.

computeContent(DataSource) - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

Compute the content from aDataSource.

computeContent(DataSource) - Method in class org.apache.mailet.base.mail.message_disposition_notification

computeContent(DataSource) - Method in class org.apache.mailet.base.mail.multipart_report

computeDataFlavor() - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

Compute an ActivationDataFlavor.

computeDataFlavor() - Method in class org.apache.mailet.base.mail.message_disposition_notification

computeDataFlavor() - Method in class org.apache.mailet.base.mail.multipart_report

CONTENT_TYPE - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the MIME header that stores the content type.

D

DATE - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the mail date.

deflow(String, boolean) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Decodes a text previously wrapped using "format=flowed".

deflow(Message) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Obtains the content of the encoded message, if previously encoded as format=flowed.

deflowMessage(Message) - Static method in class org.apache.mailet.base.FlowedMessageUtils

If the message is format=flowed set the encoded version as message content.

destroy() - Method in class org.apache.mailet.base.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.base.GenericMatcher

Called by the mailet container to indicate to a matcher that the matcher is being taken out of service.

destroy() - Method in class org.apache.mailet.base.MatcherInverter

E

equals(Object) - Method in class org.apache.mailet.base.RFC977DateFormat

Overrides equals

equals(Object) - Method in class org.apache.mailet.base.SynchronizedDateFormat

Overrides equals

F

flow(String, boolean) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Encodes a text (using standard with).

flow(String, boolean, int) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Decodes a text.

FlowedMessageUtils - Class in org.apache.mailet.base

Manages texts encoded as text/plain; format=flowed.

flowMessage(Message, boolean) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Encodes the message content (if text/plain).

flowMessage(Message, boolean, int) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Encodes the message content (if text/plain).

format(Date) - Method in class org.apache.mailet.base.RFC977DateFormat

This method returns the long form of the RFC977 Date

format(Date) - Method in interface org.apache.mailet.base.SimplifiedDateFormat

Formats a Date into a date/time string.

format(Date) - Method in class org.apache.mailet.base.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.base.RFC2822Headers

The name of the RFC 2822 header that stores the mail author(s).

G

GenericMailet - Class in org.apache.mailet.base

GenericMailet makes writing mailets easier.

GenericMailet() - Constructor for class org.apache.mailet.base.GenericMailet

GenericMatcher - Class in org.apache.mailet.base

GenericMatcher implements the Matcher and MatcherConfig interfaces.

GenericMatcher() - Constructor for class org.apache.mailet.base.GenericMatcher

GenericRecipientMatcher - Class in org.apache.mailet.base

GenericMatcher makes writing recipient based matchers easier.

GenericRecipientMatcher() - Constructor for class org.apache.mailet.base.GenericRecipientMatcher

getCharacterSet(String) - Method in class org.apache.mailet.base.mail.message_disposition_notification

getCondition() - Method in class org.apache.mailet.base.GenericMatcher

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

getContent(DataSource) - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

getDataFlavor() - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

Get the DataFlavor, lazily initialised if required.

getInitParameter(String, boolean) - Method in class org.apache.mailet.base.GenericMailet

Gets a boolean valued init parameter.

getInitParameter(String) - Method in class org.apache.mailet.base.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.base.GenericMailet

Returns a String containing the value of the named initialization parameter, or defValue if the parameter does not exist.

getInitParameter(MailetConfig, String, boolean) - Static method in class org.apache.mailet.base.MailetUtil

Gets a boolean valued init parameter.

getInitParameterNames() - Method in class org.apache.mailet.base.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.

getMailetConfig() - Method in class org.apache.mailet.base.GenericMailet

Returns this Mailet's MailetConfig object.

getMailetContext() - Method in class org.apache.mailet.base.GenericMailet

Returns a reference to the MailetContext in which this mailet is running.

getMailetContext() - Method in class org.apache.mailet.base.GenericMatcher

Returns a reference to the MailetContext in which this matcher is running.

getMailetInfo() - Method in class org.apache.mailet.base.GenericMailet

Returns information about the mailet, such as author, version, and copyright.

getMailetName() - Method in class org.apache.mailet.base.GenericMailet

Returns the name of this mailet instance.

getMatcherConfig() - Method in class org.apache.mailet.base.GenericMatcher

Returns this matcher's MatcherConfig object.

getMatcherConfig() - Method in class org.apache.mailet.base.MatcherInverter

getMatcherInfo() - Method in class org.apache.mailet.base.GenericMatcher

Returns information about the matcher, such as author, version, and copyright.

getMatcherInfo() - Method in class org.apache.mailet.base.MatcherInverter

getMatcherName() - Method in class org.apache.mailet.base.GenericMatcher

Returns the name of this matcher instance.

getTimeZone() - Method in class org.apache.mailet.base.RFC977DateFormat

Gets the time zone.

getTimeZone() - Method in interface org.apache.mailet.base.SimplifiedDateFormat

Gets the time zone.

getTimeZone() - Method in class org.apache.mailet.base.SynchronizedDateFormat

Gets the time zone.

getTransferData(DataFlavor, DataSource) - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

getTransferDataFlavors() - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

H

hashCode() - Method in class org.apache.mailet.base.RFC977DateFormat

Overrides hashCode

hashCode() - Method in class org.apache.mailet.base.SynchronizedDateFormat

Overrides hashCode

I

IN_REPLY_TO - Static variable in class org.apache.mailet.base.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.base.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.base.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.base.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.base.GenericMatcher

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.base.MatcherInverter

isAlphaChar(String, int) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Checks whether the char is part of a word.

isFlowedTextMessage(Message) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Checks whether the input message is format=flowed.

isLenient() - Method in class org.apache.mailet.base.RFC977DateFormat

Tell whether date/time parsing is to be lenient.

isLenient() - Method in interface org.apache.mailet.base.SimplifiedDateFormat

Tell whether date/time parsing is to be lenient.

isLenient() - Method in class org.apache.mailet.base.SynchronizedDateFormat

Tell whether date/time parsing is to be lenient.

K

KEYWORDS - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores human-readable keywords.

L

log(String) - Method in class org.apache.mailet.base.GenericMailet

Writes the specified message to a mailet log file.

log(String, Throwable) - Method in class org.apache.mailet.base.GenericMailet

Writes an explanatory message and a stack trace for a given Throwable exception to the mailet log file.

log(String) - Method in class org.apache.mailet.base.GenericMatcher

Writes the specified message to a matcher log file.

log(String, Throwable) - Method in class org.apache.mailet.base.GenericMatcher

Writes an explanatory message and a stack trace for a given Throwable exception to the matcher log file.

M

MailetUtil - Class in org.apache.mailet.base

Collects utility methods.

MailetUtil() - Constructor for class org.apache.mailet.base.MailetUtil

match(Mail) - Method in class org.apache.mailet.base.GenericMatcher

Called by the matcher container to allow the matcher to process a message.

match(Mail) - Method in class org.apache.mailet.base.GenericRecipientMatcher

Matches each recipient one by one through matchRecipient(MailAddress recipient) method.

match(Mail) - Method in class org.apache.mailet.base.MatcherInverter

Return a Collection of "not matched" recipients

MatcherInverter - Class in org.apache.mailet.base

This class can be used as a wrapper for getting the "not matched" recipients

MatcherInverter(Matcher) - Constructor for class org.apache.mailet.base.MatcherInverter

matchRecipient(MailAddress) - Method in class org.apache.mailet.base.GenericRecipientMatcher

Simple check to match exclusively on the email address (not message information).

md5(String) - Static method in class org.apache.mailet.base.StringUtils

Creates an MD5 digest from the message.

message_disposition_notification - Class in org.apache.mailet.base.mail

Data Content Handler for...

message_disposition_notification() - Constructor for class org.apache.mailet.base.mail.message_disposition_notification

Default Constructor.

MESSAGE_ID - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the message id.

MESSAGE_ID_VARIATION - Static variable in class org.apache.mailet.base.RFC2822Headers

A common variation on the name of the RFC 2822 header that stores the message id.

MimeMultipartReport - Class in org.apache.mailet.base.mail

Class MimeMultipartReport implements JavaMail support for a MIME type of MimeMultipart with a subtype of report.

MimeMultipartReport() - Constructor for class org.apache.mailet.base.mail.MimeMultipartReport

Default constructor

MimeMultipartReport(String) - Constructor for class org.apache.mailet.base.mail.MimeMultipartReport

Constructs a MimeMultipartReport of the given subtype.

MimeMultipartReport(DataSource) - Constructor for class org.apache.mailet.base.mail.MimeMultipartReport

Constructs a MimeMultipartReport from the passed DataSource.

multipart_report - Class in org.apache.mailet.base.mail

Data Content Handler for...

multipart_report() - Constructor for class org.apache.mailet.base.mail.multipart_report

Default constructor.

N

normalizeSubject(String, String) - Static method in class org.apache.mailet.base.MailetUtil

This takes the subject string and reduces (normailzes) it.

O

org.apache.mailet.base - package org.apache.mailet.base

Core mailet utilities and lightweight frameworks.

org.apache.mailet.base.mail - package org.apache.mailet.base.mail

This package and its sub-packages extend and provide utilities for use with javax.mail, its sub-packages and its implementations.

P

parse(String) - Method in class org.apache.mailet.base.RFC977DateFormat

Parses text from the beginning of the given string to produce a date.

parse(String) - Method in interface org.apache.mailet.base.SimplifiedDateFormat

Parses text from the beginning of the given string to produce a date.

parse(String) - Method in class org.apache.mailet.base.SynchronizedDateFormat

Parses text from the beginning of the given string to produce a date.

R

RECEIVED - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 headers that store additional tracing data.

REFERENCES - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that is used to identify the thread to which this message refers.

REPLY_TO - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the reply-to address.

RESENT_BCC - Static variable in class org.apache.mailet.base.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.base.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.base.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.base.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.base.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.base.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.base.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.base.RFC2822Headers

The name of the RFC 2822 headers that store the tracing data for the return path.

RFC2646_CRLF - Static variable in class org.apache.mailet.base.FlowedMessageUtils

RFC2646_FROM - Static variable in class org.apache.mailet.base.FlowedMessageUtils

RFC2646_QUOTE - Static variable in class org.apache.mailet.base.FlowedMessageUtils

RFC2646_SIGNATURE - Static variable in class org.apache.mailet.base.FlowedMessageUtils

RFC2646_SPACE - Static variable in class org.apache.mailet.base.FlowedMessageUtils

RFC2646_WIDTH - Static variable in class org.apache.mailet.base.FlowedMessageUtils

RFC2822Headers - Class in org.apache.mailet.base

This utility class provides the set of header names explicitly defined in RFC 2822

RFC2980DateFormat - Class in org.apache.mailet.base

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.base.RFC2980DateFormat

Constructor for RFC2980DateFormat

RFC822DateFormat - Class in org.apache.mailet.base

A thread safe wrapper for the javax.mail.internet.MailDateFormat class.

RFC822DateFormat() - Constructor for class org.apache.mailet.base.RFC822DateFormat

Constructor for RFC822DateFormat

RFC977DateFormat - Class in org.apache.mailet.base

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.base.RFC977DateFormat

Constructor for RFC977DateFormat

S

SENDER - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the actual mail transmission agent, if this differs from the author of the message.

service(Mail) - Method in class org.apache.mailet.base.GenericMailet

Called by the mailet container to allow the mailet to process a message.

setContentType(ContentType) - Method in class org.apache.mailet.base.mail.MimeMultipartReport

Sets the content type

setDataFlavor(ActivationDataFlavor) - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

setFlowedContent(Message, String, boolean) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Encodes the input text and sets it as the new message content.

setFlowedContent(Message, String, boolean, int, boolean, String) - Static method in class org.apache.mailet.base.FlowedMessageUtils

Encodes the input text and sets it as the new message content.

setLenient(boolean) - Method in class org.apache.mailet.base.RFC977DateFormat

Specify whether or not date/time parsing is to be lenient.

setLenient(boolean) - Method in interface org.apache.mailet.base.SimplifiedDateFormat

Specify whether or not date/time parsing is to be lenient.

setLenient(boolean) - Method in class org.apache.mailet.base.SynchronizedDateFormat

Specify whether or not date/time parsing is to be lenient.

setReportType(String) - Method in class org.apache.mailet.base.mail.MimeMultipartReport

Sets the type of report.

setTimeZone(TimeZone) - Method in class org.apache.mailet.base.RFC977DateFormat

Sets the time zone of this SynchronizedDateFormat object.

setTimeZone(TimeZone) - Method in interface org.apache.mailet.base.SimplifiedDateFormat

Sets the time zone of this SimplifiedDateFormat object.

setTimeZone(TimeZone) - Method in class org.apache.mailet.base.SynchronizedDateFormat

Sets the time zone of this SynchronizedDateFormat object.

SimplifiedDateFormat - Interface in org.apache.mailet.base

This interface is designed to provide a simplified subset of the methods provided by the java.text.DateFormat class.

split(String, String) - Static method in class org.apache.mailet.base.StringUtils

Splits a string given a pattern (regex), considering escapes.

StringUtils - Class in org.apache.mailet.base

Collects useful string utility methods.

SUBJECT - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the subject.

SynchronizedDateFormat - Class in org.apache.mailet.base

This class is designed to be a synchronized wrapper for a java.text.DateFormat subclass.

SynchronizedDateFormat(String, Locale) - Constructor for class org.apache.mailet.base.SynchronizedDateFormat

Public constructor that mimics that of SimpleDateFormat.

SynchronizedDateFormat(DateFormat) - Constructor for class org.apache.mailet.base.SynchronizedDateFormat

Wrapper method to allow child classes to synchronize a preexisting DateFormat.

T

TO - Static variable in class org.apache.mailet.base.RFC2822Headers

The name of the RFC 2822 header that stores the primary mail recipients.

toString(Date) - Static method in class org.apache.mailet.base.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.

U

updateDataFlavor() - Method in class org.apache.mailet.base.mail.AbstractDataContentHandler

Update the current DataFlavor.

W

writeTo(Object, String, OutputStream) - Method in class org.apache.mailet.base.mail.message_disposition_notification

writeTo(Object, String, OutputStream) - Method in class org.apache.mailet.base.mail.multipart_report

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