org.codehaus.plexus.mailsender
Class MailMessage

java.lang.Object
  org.codehaus.plexus.mailsender.MailMessage

public class MailMessage
extends java.lang.Object

Version:

$Id: MailMessage.java 5555 2007-02-01 15:17:45Z evenisse $

Author:

Trygve Laugstøl, Emmanuel Venisse

Nested Class Summary

static class

MailMessage.Address

Field Summary

static java.lang.String	TYPE_HTML
static java.lang.String	TYPE_TEXT

Constructor Summary

MailMessage()

Method Summary

void	addBcc(MailMessage.Address bcc)
void	addBcc(java.lang.String mailbox, java.lang.String name)
void	addCc(MailMessage.Address cc)
void	addCc(java.lang.String mailbox, java.lang.String name)
void	addHeader(java.lang.String headerName, java.lang.String headerValue) Adds the given value to the headers identified by headerName.
void	addTo(MailMessage.Address to)
void	addTo(java.lang.String mailbox, java.lang.String name)
java.util.List	getBccAddresses()
java.util.List	getCcAddresses()
java.lang.String	getContent()
java.lang.String	getContentType()
MailMessage.Address	getFrom()
java.util.Map	getHeaders()
MailMessage.Address	getReplyTo()
java.util.Date	getSendDate()
java.lang.String	getSubject()
java.util.List	getToAddresses()
void	setContent(java.lang.String content)
void	setContentType(java.lang.String contentType)
void	setFrom(MailMessage.Address from)
void	setFrom(java.lang.String mailbox, java.lang.String name)
java.util.List	setHeader(java.lang.String headerName, java.lang.String headerValue) Sets the named header to the given value.
void	setReplyTo(MailMessage.Address replyTo)
void	setReplyTo(java.lang.String mailbox, java.lang.String name)
void	setSendDate(java.util.Date sendDate)
void	setSubject(java.lang.String subject)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_HTML

public static final java.lang.String TYPE_HTML

See Also:

Constant Field Values

TYPE_TEXT

public static final java.lang.String TYPE_TEXT

See Also:

Constant Field Values

Constructor Detail

MailMessage

public MailMessage()

Method Detail

getFrom

public MailMessage.Address getFrom()

setFrom

public void setFrom(java.lang.String mailbox,
                    java.lang.String name)
             throws MailSenderException

Throws:

MailSenderException

setFrom

public void setFrom(MailMessage.Address from)

getReplyTo

public MailMessage.Address getReplyTo()

setReplyTo

public void setReplyTo(java.lang.String mailbox,
                       java.lang.String name)
                throws MailSenderException

Throws:

MailSenderException

setReplyTo

public void setReplyTo(MailMessage.Address replyTo)

getToAddresses

public java.util.List getToAddresses()

addTo

public void addTo(java.lang.String mailbox,
                  java.lang.String name)
           throws MailSenderException

Throws:

MailSenderException

addTo

public void addTo(MailMessage.Address to)
           throws MailSenderException

Throws:

MailSenderException

getCcAddresses

public java.util.List getCcAddresses()

addCc

public void addCc(java.lang.String mailbox,
                  java.lang.String name)
           throws MailSenderException

Throws:

MailSenderException

addCc

public void addCc(MailMessage.Address cc)
           throws MailSenderException

Throws:

MailSenderException

getBccAddresses

public java.util.List getBccAddresses()

addBcc

public void addBcc(java.lang.String mailbox,
                   java.lang.String name)
            throws MailSenderException

Throws:

MailSenderException

addBcc

public void addBcc(MailMessage.Address bcc)
            throws MailSenderException

Throws:

MailSenderException

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

getContent

public java.lang.String getContent()

setContent

public void setContent(java.lang.String content)

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(java.lang.String contentType)

getSendDate

public java.util.Date getSendDate()

setSendDate

public void setSendDate(java.util.Date sendDate)

getHeaders

public java.util.Map getHeaders()

addHeader

public void addHeader(java.lang.String headerName,
                      java.lang.String headerValue)

Adds the given value to the headers identified by headerName. RFC 822 provides the rules for what text may constitute a header name and value.

Parameters:

headerName - the name of the header to append this value to

headerValue - the value to append

setHeader

public java.util.List setHeader(java.lang.String headerName,
                                java.lang.String headerValue)

Sets the named header to the given value. RFC 822 provides the rules for what text may constitute a header name and value.

Parameters:

headerName - the named header to set

headerValue - the value to set

Returns:

the List of values that was previously set under this headerName