org.apache.james.mime4j.dom

Interface Message

All Superinterfaces:

Body, Disposable, Entity

All Known Implementing Classes:

AbstractMessage, MessageImpl

public interface Message
extends Entity, Body

An MIME message (as defined in RFC 2045).

Method Summary

Methods

Modifier and Type	Method and Description
void	createMessageId(String hostname) Creates and sets a new Message-ID header field for this message.
AddressList	getBcc() Returns the value of the Bcc header field of this message as AddressList object or null if it is not present.
AddressList	getCc() Returns the value of the Cc header field of this message as AddressList object or null if it is not present.
Date	getDate() Returns the value of the Date header field of this message as Date object or null if it is not present.
MailboxList	getFrom() Returns the value of the From header field of this message as MailboxList object or null if it is not present.
String	getMessageId() Returns the value of the Message-ID header field of this message or null if it is not present.
AddressList	getReplyTo() Returns the value of the Reply-To header field of this message as AddressList object or null if it is not present.
Mailbox	getSender() Returns the value of the Sender header field of this message as Mailbox object or null if it is not present.
String	getSubject() Returns the (decoded) value of the Subject header field of this message or null if it is not present.
AddressList	getTo() Returns the value of the To header field of this message as AddressList object or null if it is not present.
void	setBcc(Address... bcc) Sets the Bcc header field of this message to the specified addresses.
void	setBcc(Address bcc) Sets the Bcc header field of this message to the specified address.
void	setBcc(Collection<? extends Address> bcc) Sets the Bcc header field of this message to the specified addresses.
void	setCc(Address... cc) Sets the Cc header field of this message to the specified addresses.
void	setCc(Address cc) Sets the Cc header field of this message to the specified address.
void	setCc(Collection<? extends Address> cc) Sets the Cc header field of this message to the specified addresses.
void	setDate(Date date) Sets the Date header field for this message.
void	setDate(Date date, TimeZone zone) Sets the Date header field for this message.
void	setFrom(Collection<Mailbox> from) Sets the From header field of this message to the specified mailbox addresses.
void	setFrom(Mailbox... from) Sets the From header field of this message to the specified mailbox addresses.
void	setFrom(Mailbox from) Sets the From header field of this message to the specified mailbox address.
void	setReplyTo(Address... replyTo) Sets the Reply-To header field of this message to the specified addresses.
void	setReplyTo(Address replyTo) Sets the Reply-To header field of this message to the specified address.
void	setReplyTo(Collection<? extends Address> replyTo) Sets the Reply-To header field of this message to the specified addresses.
void	setSender(Mailbox sender) Sets the Sender header field of this message to the specified mailbox address.
void	setSubject(String subject) Sets the Subject header field for this message.
void	setTo(Address... to) Sets the To header field of this message to the specified addresses.
void	setTo(Address to) Sets the To header field of this message to the specified address.
void	setTo(Collection<? extends Address> to) Sets the To header field of this message to the specified addresses.

Methods inherited from interface org.apache.james.mime4j.dom.Entity

getBody, getCharset, getContentTransferEncoding, getDispositionType, getFilename, getHeader, getMimeType, getParent, isMultipart, removeBody, setBody, setHeader, setParent

Methods inherited from interface org.apache.james.mime4j.dom.Body

getParent, setParent

Methods inherited from interface org.apache.james.mime4j.dom.Disposable

dispose

Method Detail

getMessageId

String getMessageId()

Returns the value of the Message-ID header field of this message or null if it is not present.

Returns:

the identifier of this message.

createMessageId

void createMessageId(String hostname)

Creates and sets a new Message-ID header field for this message. A Header is created if this message does not already have one.

Parameters:

hostname - host name to be included in the identifier or null if no host name should be included.

getSubject

String getSubject()

Returns the (decoded) value of the Subject header field of this message or null if it is not present.

Returns:

the subject of this message.

setSubject

void setSubject(String subject)

Sets the Subject header field for this message. The specified string may contain non-ASCII characters, in which case it gets encoded as an 'encoded-word' automatically. A Header is created if this message does not already have one.

Parameters:

subject - subject to set or null to remove the subject header field.

getDate

Date getDate()

Returns the value of the Date header field of this message as Date object or null if it is not present.

Returns:

the date of this message.

setDate

void setDate(Date date)

Sets the Date header field for this message. This method uses the default TimeZone of this host to encode the specified Date object into a string.

Parameters:

date - date to set or null to remove the date header field.

setDate

void setDate(Date date,
           TimeZone zone)

Sets the Date header field for this message. The specified TimeZone is used to encode the specified Date object into a string.

Parameters:

date - date to set or null to remove the date header field.

zone - a time zone.

getSender

Mailbox getSender()

Returns the value of the Sender header field of this message as Mailbox object or null if it is not present.

Returns:

the sender of this message.

setSender

void setSender(Mailbox sender)

Sets the Sender header field of this message to the specified mailbox address.

Parameters:

sender - address to set or null to remove the header field.

getFrom

MailboxList getFrom()

Returns the value of the From header field of this message as MailboxList object or null if it is not present.

Returns:

value of the from field of this message.

setFrom

void setFrom(Mailbox from)

Sets the From header field of this message to the specified mailbox address.

Parameters:

from - address to set or null to remove the header field.

setFrom

void setFrom(Mailbox... from)

Sets the From header field of this message to the specified mailbox addresses.

Parameters:

from - addresses to set or null or no arguments to remove the header field.

setFrom

void setFrom(Collection<Mailbox> from)

Sets the From header field of this message to the specified mailbox addresses.

Parameters:

from - addresses to set or null or an empty collection to remove the header field.

getTo

AddressList getTo()

Returns the value of the To header field of this message as AddressList object or null if it is not present.

Returns:

value of the to field of this message.

setTo

void setTo(Address to)

Sets the To header field of this message to the specified address.

Parameters:

to - address to set or null to remove the header field.

setTo

void setTo(Address... to)

Sets the To header field of this message to the specified addresses.

Parameters:

to - addresses to set or null or no arguments to remove the header field.

setTo

void setTo(Collection<? extends Address> to)

Sets the To header field of this message to the specified addresses.

Parameters:

to - addresses to set or null or an empty collection to remove the header field.

getCc

AddressList getCc()

Returns the value of the Cc header field of this message as AddressList object or null if it is not present.

Returns:

value of the cc field of this message.

setCc

void setCc(Address cc)

Sets the Cc header field of this message to the specified address.

Parameters:

cc - address to set or null to remove the header field.

setCc

void setCc(Address... cc)

Sets the Cc header field of this message to the specified addresses.

Parameters:

cc - addresses to set or null or no arguments to remove the header field.

setCc

void setCc(Collection<? extends Address> cc)

Sets the Cc header field of this message to the specified addresses.

Parameters:

cc - addresses to set or null or an empty collection to remove the header field.

getBcc

AddressList getBcc()

Returns the value of the Bcc header field of this message as AddressList object or null if it is not present.

Returns:

value of the bcc field of this message.

setBcc

void setBcc(Address bcc)

Sets the Bcc header field of this message to the specified address.

Parameters:

bcc - address to set or null to remove the header field.

setBcc

void setBcc(Address... bcc)

Sets the Bcc header field of this message to the specified addresses.

Parameters:

bcc - addresses to set or null or no arguments to remove the header field.

setBcc

void setBcc(Collection<? extends Address> bcc)

Sets the Bcc header field of this message to the specified addresses.

Parameters:

bcc - addresses to set or null or an empty collection to remove the header field.

getReplyTo

AddressList getReplyTo()

Returns the value of the Reply-To header field of this message as AddressList object or null if it is not present.

Returns:

value of the reply to field of this message.

setReplyTo

void setReplyTo(Address replyTo)

Sets the Reply-To header field of this message to the specified address.

Parameters:

replyTo - address to set or null to remove the header field.

setReplyTo

void setReplyTo(Address... replyTo)

Sets the Reply-To header field of this message to the specified addresses.

Parameters:

replyTo - addresses to set or null or no arguments to remove the header field.

setReplyTo

void setReplyTo(Collection<? extends Address> replyTo)

Sets the Reply-To header field of this message to the specified addresses.

Parameters:

replyTo - addresses to set or null or an empty collection to remove the header field.