org.apache.james.core

Class MailImpl

java.lang.Object

org.apache.james.core.MailImpl

All Implemented Interfaces:

Serializable, Cloneable, Disposable, org.apache.mailet.Mail

public class MailImpl
extends Object
implements Disposable, org.apache.mailet.Mail

Wraps a MimeMessage adding routing information (from SMTP) and some simple API enhancements.

From James version > 2.2.0a8 "mail attributes" have been added. Backward and forward compatibility is supported:

• messages stored in file repositories without attributes by James version <= 2.2.0a8 will be processed by later versions as having an empty attributes hashmap;
• messages stored in file repositories with attributes by James version > 2.2.0a8 will be processed by previous versions, ignoring the attributes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID We hardcode the serialVersionUID so that from James 1.2 on, MailImpl will be deserializable (so your mail doesn't get lost)

Fields inherited from interface org.apache.mailet.Mail

DEFAULT, ERROR, GHOST, TRANSPORT

Constructor Summary

Constructors

Constructor and Description
MailImpl() A constructor that creates a new, uninitialized MailImpl
MailImpl(org.apache.mailet.Mail mail) Create a copy of the input mail and assign it a new name
MailImpl(org.apache.mailet.Mail mail, String newName)
MailImpl(String name, org.apache.mailet.MailAddress sender, Collection recipients) A constructor that creates a MailImpl with the specified name, sender, and recipients.
MailImpl(String name, org.apache.mailet.MailAddress sender, Collection recipients, InputStream messageIn) A constructor that creates a MailImpl with the specified name, sender, recipients, and message data.
MailImpl(String name, org.apache.mailet.MailAddress sender, Collection recipients, javax.mail.internet.MimeMessage message) A constructor that creates a MailImpl with the specified name, sender, recipients, and MimeMessage.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Dispose the object
org.apache.mailet.Mail	duplicate() Duplicate the MailImpl.
org.apache.mailet.Mail	duplicate(String newName) Duplicate the MailImpl, replacing the mail name with the one passed in as an argument.
Serializable	getAttribute(String key)
Iterator	getAttributeNames()
HashMap	getAttributesRaw() This method is necessary, when Mail repositories needs to deal explicitly with storing Mail attributes as a Serializable
String	getErrorMessage() Get the error message associated with this MailImpl.
static String	getId() Generate a new identifier/name for a mail being processed by this server.
Date	getLastUpdated() Get the last updated time for this MailImpl.
javax.mail.internet.MimeMessage	getMessage() Get the MimeMessage associated with this MailImpl.
long	getMessageSize() Return the size of the message including its headers.
String	getName() Get the name of this MailImpl.
Collection	getRecipients() Get the recipients of this MailImpl.
String	getRemoteAddr() Get the remote address associated with this MailImpl.
String	getRemoteHost() Get the remote host associated with this MailImpl.
org.apache.mailet.MailAddress	getSender() Get the sender of this MailImpl.
String	getState() Get the state of this MailImpl.
boolean	hasAttributes()
static String	newName(org.apache.mailet.Mail mail) Create a unique new primary key name for the given MailObject.
void	removeAllAttributes()
Serializable	removeAttribute(String key)
Serializable	setAttribute(String key, Serializable object)
void	setAttributesRaw(HashMap attr) This method is necessary, when Mail repositories needs to deal explicitly with retriving Mail attributes as a Serializable
void	setErrorMessage(String msg) Set the error message associated with this MailImpl.
void	setLastUpdated(Date lastUpdated) Set the date this mail was last updated.
void	setMessage(javax.mail.internet.MimeMessage message) Set the MimeMessage associated with this MailImpl.
void	setName(String name) Set the name of this MailImpl.
void	setRecipients(Collection recipients) Set the recipients for this MailImpl.
void	setRemoteAddr(String remoteAddr) Set the remote address associated with this MailImpl.
void	setRemoteHost(String remoteHost) Set the remote address associated with this MailImpl.
void	setSender(org.apache.mailet.MailAddress sender) Set the sender of this MailImpl.
void	setState(String state) Set the state of this MailImpl.
void	writeMessageTo(OutputStream out) Writes the message out to an OutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

We hardcode the serialVersionUID so that from James 1.2 on, MailImpl will be deserializable (so your mail doesn't get lost)

See Also:

Constant Field Values

Constructor Detail

MailImpl

public MailImpl()

A constructor that creates a new, uninitialized MailImpl

MailImpl

public MailImpl(String name,
        org.apache.mailet.MailAddress sender,
        Collection recipients)

A constructor that creates a MailImpl with the specified name, sender, and recipients.

Parameters:

name - the name of the MailImpl

sender - the sender for this MailImpl

recipients - the collection of recipients of this MailImpl

MailImpl

public MailImpl(org.apache.mailet.Mail mail)
         throws javax.mail.MessagingException

Create a copy of the input mail and assign it a new name

Parameters:

mail - original mail

Throws:

javax.mail.MessagingException - when the message is not clonable

MailImpl

public MailImpl(org.apache.mailet.Mail mail,
        String newName)
         throws javax.mail.MessagingException

Parameters:

mail -

newName -

Throws:

javax.mail.MessagingException

MailImpl

public MailImpl(String name,
        org.apache.mailet.MailAddress sender,
        Collection recipients,
        InputStream messageIn)
         throws javax.mail.MessagingException

A constructor that creates a MailImpl with the specified name, sender, recipients, and message data.

Parameters:

name - the name of the MailImpl

sender - the sender for this MailImpl

recipients - the collection of recipients of this MailImpl

messageIn - a stream containing the message source

Throws:

javax.mail.MessagingException

MailImpl

public MailImpl(String name,
        org.apache.mailet.MailAddress sender,
        Collection recipients,
        javax.mail.internet.MimeMessage message)
         throws javax.mail.MessagingException

A constructor that creates a MailImpl with the specified name, sender, recipients, and MimeMessage.

Parameters:

name - the name of the MailImpl

sender - the sender for this MailImpl

recipients - the collection of recipients of this MailImpl

message - the MimeMessage associated with this MailImpl

Throws:

javax.mail.MessagingException

Method Detail

duplicate

public org.apache.mailet.Mail duplicate()

Duplicate the MailImpl.

Returns:

a MailImpl that is a duplicate of this one

duplicate

public org.apache.mailet.Mail duplicate(String newName)

Duplicate the MailImpl, replacing the mail name with the one passed in as an argument.

Parameters:

newName - the name for the duplicated mail

Returns:

a MailImpl that is a duplicate of this one with a different name

getErrorMessage

public String getErrorMessage()

Get the error message associated with this MailImpl.

Specified by:

getErrorMessage in interface org.apache.mailet.Mail

Returns:

the error message associated with this MailImpl

getMessage

public javax.mail.internet.MimeMessage getMessage()
                                           throws javax.mail.MessagingException

Get the MimeMessage associated with this MailImpl.

Specified by:

getMessage in interface org.apache.mailet.Mail

Returns:

the MimeMessage associated with this MailImpl

Throws:

javax.mail.MessagingException

setName

public void setName(String name)

Set the name of this MailImpl.

Specified by:

setName in interface org.apache.mailet.Mail

Parameters:

name - the name of this MailImpl

getName

public String getName()

Get the name of this MailImpl.

Specified by:

getName in interface org.apache.mailet.Mail

Returns:

the name of this MailImpl

getRecipients

public Collection getRecipients()

Get the recipients of this MailImpl.

Specified by:

getRecipients in interface org.apache.mailet.Mail

Returns:

the recipients of this MailImpl

getSender

public org.apache.mailet.MailAddress getSender()

Get the sender of this MailImpl.

Specified by:

getSender in interface org.apache.mailet.Mail

Returns:

the sender of this MailImpl

getState

public String getState()

Get the state of this MailImpl.

Specified by:

getState in interface org.apache.mailet.Mail

Returns:

the state of this MailImpl

getRemoteHost

public String getRemoteHost()

Get the remote host associated with this MailImpl.

Specified by:

getRemoteHost in interface org.apache.mailet.Mail

Returns:

the remote host associated with this MailImpl

getRemoteAddr

public String getRemoteAddr()

Get the remote address associated with this MailImpl.

Specified by:

getRemoteAddr in interface org.apache.mailet.Mail

Returns:

the remote address associated with this MailImpl

getLastUpdated

public Date getLastUpdated()

Get the last updated time for this MailImpl.

Specified by:

getLastUpdated in interface org.apache.mailet.Mail

Returns:

the last updated time for this MailImpl

getMessageSize

public long getMessageSize()
                    throws javax.mail.MessagingException

Return the size of the message including its headers. MimeMessage.getSize() method only returns the size of the message body.

Note: this size is not guaranteed to be accurate - see Sun's documentation of MimeMessage.getSize().

Specified by:

getMessageSize in interface org.apache.mailet.Mail

Returns:

approximate size of full message including headers.

Throws:

javax.mail.MessagingException - if a problem occurs while computing the message size

setErrorMessage

public void setErrorMessage(String msg)

Set the error message associated with this MailImpl.

Specified by:

setErrorMessage in interface org.apache.mailet.Mail

Parameters:

msg - the new error message associated with this MailImpl

setMessage

public void setMessage(javax.mail.internet.MimeMessage message)

Set the MimeMessage associated with this MailImpl.

Specified by:

setMessage in interface org.apache.mailet.Mail

Parameters:

message - the new MimeMessage associated with this MailImpl

setRecipients

public void setRecipients(Collection recipients)

Set the recipients for this MailImpl.

Specified by:

setRecipients in interface org.apache.mailet.Mail

Parameters:

recipients - the recipients for this MailImpl

setSender

public void setSender(org.apache.mailet.MailAddress sender)

Set the sender of this MailImpl.

Parameters:

sender - the sender of this MailImpl

setState

public void setState(String state)

Set the state of this MailImpl.

Specified by:

setState in interface org.apache.mailet.Mail

Parameters:

state - the state of this MailImpl

setRemoteHost

public void setRemoteHost(String remoteHost)

Set the remote address associated with this MailImpl.

Parameters:

remoteHost - the new remote host associated with this MailImpl

setRemoteAddr

public void setRemoteAddr(String remoteAddr)

Set the remote address associated with this MailImpl.

Parameters:

remoteAddr - the new remote address associated with this MailImpl

setLastUpdated

public void setLastUpdated(Date lastUpdated)

Set the date this mail was last updated.

Specified by:

setLastUpdated in interface org.apache.mailet.Mail

Parameters:

lastUpdated - the date the mail was last updated

writeMessageTo

public void writeMessageTo(OutputStream out)
                    throws IOException,
                           javax.mail.MessagingException

Writes the message out to an OutputStream.

Parameters:

out - the OutputStream to which to write the content

Throws:

javax.mail.MessagingException - if the MimeMessage is not set for this MailImpl

IOException - if an error occurs while reading or writing from the stream

dispose

public void dispose()

Description copied from interface: Disposable

Dispose the object

Specified by:

dispose in interface Disposable

See Also:

Disposable.dispose()

getAttributesRaw

public HashMap getAttributesRaw()

This method is necessary, when Mail repositories needs to deal explicitly with storing Mail attributes as a Serializable

Note: This method is not exposed in the Mail interface, it is for internal use by James only.

Returns:

Serializable of the entire attributes collection

Since:

2.2.0

setAttributesRaw

public void setAttributesRaw(HashMap attr)

This method is necessary, when Mail repositories needs to deal explicitly with retriving Mail attributes as a Serializable

Note: This method is not exposed in the Mail interface, it is for internal use by James only.

Parameters:

attr - Serializable of the entire attributes collection

Since:

2.2.0

getAttribute

public Serializable getAttribute(String key)

Specified by:

getAttribute in interface org.apache.mailet.Mail

Since:

2.2.0

See Also:

Mail.getAttribute(String)

setAttribute

public Serializable setAttribute(String key,
                        Serializable object)

Specified by:

setAttribute in interface org.apache.mailet.Mail

Since:

2.2.0

See Also:

Mail.setAttribute(String,Serializable)

removeAttribute

public Serializable removeAttribute(String key)

Specified by:

removeAttribute in interface org.apache.mailet.Mail

Since:

2.2.0

See Also:

Mail.removeAttribute(String)

removeAllAttributes

public void removeAllAttributes()

Specified by:

removeAllAttributes in interface org.apache.mailet.Mail

Since:

2.2.0

See Also:

Mail.removeAllAttributes()

getAttributeNames

public Iterator getAttributeNames()

Specified by:

getAttributeNames in interface org.apache.mailet.Mail

Since:

2.2.0

See Also:

Mail.getAttributeNames()

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface org.apache.mailet.Mail

Since:

2.2.0

See Also:

Mail.hasAttributes()

newName

public static String newName(org.apache.mailet.Mail mail)
                      throws javax.mail.MessagingException

Create a unique new primary key name for the given MailObject.

Parameters:

mail - the mail to use as the basis for the new mail name

Returns:

a new name

Throws:

javax.mail.MessagingException

getId

public static String getId()

Generate a new identifier/name for a mail being processed by this server.

Returns:

the new identifier