javax.mail

Class Message

Implemented Interfaces:
Part
Known Direct Subclasses:
MimeMessage

public abstract class Message
extends java.lang.Object
implements Part

An abstract mail message, consisting of headers and content.

A message is retrieved from a folder, and is normally a lightweight object that retrieves its properties on demand. Fetch profiles may be used to prefetch certain properties of a message.

To send a message, an appropriate subclsass is instantiated, its properties set, and it is then delivered via a transport using the Transport.sendMessage method.

Version:
1.4
Author:
Chris Burdess
See Also:
Part

Nested Class Summary

static class
Message.RecipientType
The types of recipients to which a message can be sent.

Field Summary

protected boolean
expunged
True if this message has been expunged.
protected Folder
folder
The containing folder.
protected int
msgnum
The number of this message within its folder, starting from 1, or 0 if the message was not retrieved from a folder.
protected Session
session
The session in scope for this message.

Fields inherited from interface javax.mail.Part

ATTACHMENT, INLINE

Constructor Summary

Message()
Constructor with no folder or session.
Message(Folder folder, int msgnum)
Constructor with a folder and a message number.
Message(Session session)
Constructor with a session.

Method Summary

abstract void
addFrom(Address[] addresses)
Adds addresses to the identity of the person sending this message.
void
addRecipient(Message.RecipientType type, Address address)
Adds the recipient address of the given type.
abstract void
addRecipients(Message.RecipientType type, Address[] addresses)
Adds the recipient addresses of the given type.
Address[]
getAllRecipients()
Returns all the recipient addresses in the message.
abstract Flags
getFlags()
Returns the flags for this message.
Folder
getFolder()
Returns the folder from which this message was obtained.
abstract Address[]
getFrom()
Returns the identity of the person(s) who ordered the sending of this message.
int
getMessageNumber()
Returns the message number for this message within its folder.
abstract Date
getReceivedDate()
Returns the date this message was received.
abstract Address[]
getRecipients(Message.RecipientType type)
Returns all the recipient addresses of the specified type.
Address[]
getReplyTo()
Returns the addresses to which replies should be directed.
abstract Date
getSentDate()
Returns the date this message was sent.
abstract String
getSubject()
Returns the subject of this message.
boolean
isExpunged()
Indicates whether this message is expunged.
boolean
isSet(Flags.Flag flag)
Indicates whether the specified flag is set in this message.
boolean
match(SearchTerm term)
Indicates whether the specified search term applies to this message.
abstract Message
reply(boolean replyToAll)
Returns a new message suitable for a reply to this message.
abstract void
saveChanges()
Save any changes made to this message into its underlying store, if the message was obtained from a folder.
protected void
setExpunged(boolean expunged)
Sets the expunged flag for this message.
void
setFlag(Flags.Flag flag, boolean set)
Sets the specified flag on this message to the given value.
abstract void
setFlags(Flags flag, boolean set)
Sets the specified flags on this message to the given value.
abstract void
setFrom()
Sets the identity of the person sending this message, as obtained from the property "mail.user".
abstract void
setFrom(Address address)
Sets the identity of the person sending this message.
protected void
setMessageNumber(int msgnum)
Sets the message number for this message.
void
setRecipient(Message.RecipientType type, Address address)
Sets the recipient address of the specified type.
abstract void
setRecipients(Message.RecipientType type, Address[] addresses)
Sets the recipient addresses of the specified type.
void
setReplyTo(Address[] addresses)
Sets the addresses to which replies should be directed.
abstract void
setSentDate(Date date)
Sets the date this message was sent.
abstract void
setSubject(String subject)
Sets the subject of this message.

Field Details

expunged

protected boolean expunged
True if this message has been expunged.

folder

protected Folder folder
The containing folder.

msgnum

protected int msgnum
The number of this message within its folder, starting from 1, or 0 if the message was not retrieved from a folder.

session

protected Session session
The session in scope for this message.

Constructor Details

Message

protected Message()
Constructor with no folder or session.

Message

protected Message(Folder folder,
                  int msgnum)
Constructor with a folder and a message number. Used by folder implementations.
Parameters:
folder - the containing folder
msgnum - the sequence number within the folder

Message

protected Message(Session session)
Constructor with a session. Used to create messages for sending.
Parameters:
session - the session in scope

Method Details

addFrom

public abstract void addFrom(Address[] addresses)
            throws MessagingException
Adds addresses to the identity of the person sending this message.
Parameters:
addresses - the senders

addRecipient

public void addRecipient(Message.RecipientType type,
                         Address address)
            throws MessagingException
Adds the recipient address of the given type.

addRecipients

public abstract void addRecipients(Message.RecipientType type,
                                   Address[] addresses)
            throws MessagingException
Adds the recipient addresses of the given type.
Parameters:
type - the recipient type
addresses - the addresses

getAllRecipients

public Address[] getAllRecipients()
            throws MessagingException
Returns all the recipient addresses in the message.

getFlags

public abstract Flags getFlags()
            throws MessagingException
Returns the flags for this message.

Modifying any of these flags does not affect the message flags. Use the setFlags method to change the message's flags.


getFolder

public Folder getFolder()
Returns the folder from which this message was obtained.

getFrom

public abstract Address[] getFrom()
            throws MessagingException
Returns the identity of the person(s) who ordered the sending of this message.

In certain implementations, this may be different from the entity that actually sent the message.


getMessageNumber

public int getMessageNumber()
Returns the message number for this message within its folder.

getReceivedDate

public abstract Date getReceivedDate()
            throws MessagingException
Returns the date this message was received.

getRecipients

public abstract Address[] getRecipients(Message.RecipientType type)
            throws MessagingException
Returns all the recipient addresses of the specified type.
Parameters:
type - the recipient type

getReplyTo

public Address[] getReplyTo()
            throws MessagingException
Returns the addresses to which replies should be directed. This defaults to the sender of the message.

getSentDate

public abstract Date getSentDate()
            throws MessagingException
Returns the date this message was sent.

getSubject

public abstract String getSubject()
            throws MessagingException
Returns the subject of this message.

isExpunged

public boolean isExpunged()
Indicates whether this message is expunged.

isSet

public boolean isSet(Flags.Flag flag)
            throws MessagingException
Indicates whether the specified flag is set in this message.
Parameters:
flag - the flag

match

public boolean match(SearchTerm term)
            throws MessagingException
Indicates whether the specified search term applies to this message.
Parameters:
term - the search term

reply

public abstract Message reply(boolean replyToAll)
            throws MessagingException
Returns a new message suitable for a reply to this message. The new message will have its recipients set appropriately, but will have no content.

The subject field is filled in with the original subject prefixed with "Re:" (unless it already starts with "Re:").

Parameters:
replyToAll - if the reply should be sent to all recipients of this message

saveChanges

public abstract void saveChanges()
            throws MessagingException
Save any changes made to this message into its underlying store, if the message was obtained from a folder. The message may be saved immediately or when its containing folder is closed.

This method ensures that any header fields are consistent with the changed message contents.


setExpunged

protected void setExpunged(boolean expunged)
Sets the expunged flag for this message.

setFlag

public void setFlag(Flags.Flag flag,
                    boolean set)
            throws MessagingException
Sets the specified flag on this message to the given value.
Parameters:
flag - the flag to be set
set - the value to be set

setFlags

public abstract void setFlags(Flags flag,
                              boolean set)
            throws MessagingException
Sets the specified flags on this message to the given value. Any flags in this message that are not specified in the given flags are unaffected.
Parameters:
flag - the flags to be set
set - the value to be set

setFrom

public abstract void setFrom()
            throws MessagingException
Sets the identity of the person sending this message, as obtained from the property "mail.user". If this property is absent, the system property "user.name" is used.

setFrom

public abstract void setFrom(Address address)
            throws MessagingException
Sets the identity of the person sending this message.
Parameters:
address - the sender

setMessageNumber

protected void setMessageNumber(int msgnum)
Sets the message number for this message.

setRecipient

public void setRecipient(Message.RecipientType type,
                         Address address)
            throws MessagingException
Sets the recipient address of the specified type.

setRecipients

public abstract void setRecipients(Message.RecipientType type,
                                   Address[] addresses)
            throws MessagingException
Sets the recipient addresses of the specified type.
Parameters:
type - the recipient type
addresses - the addresses

setReplyTo

public void setReplyTo(Address[] addresses)
            throws MessagingException
Sets the addresses to which replies should be directed.

setSentDate

public abstract void setSentDate(Date date)
            throws MessagingException
Sets the date this message was sent.
Parameters:
date - the sent date of this message

setSubject

public abstract void setSubject(String subject)
            throws MessagingException
Sets the subject of this message.
Parameters:
subject - the subject

© Copyright 2003, 2004 The Free Software Foundation, All rights reserved