de.bea.domingo.groupware
Class Email

java.lang.Object
  de.bea.domingo.map.BaseInstance
      de.bea.domingo.groupware.Email

public final class Email
extends BaseInstance

Represents a Notes mail document.

Author:

Kurt Riede

Nested Class Summary

static class	Email.Importance Represents all possible values for the importance.
static class	Email.Priority Represents all possible values for the priority.

Constructor Summary

Email()
Constructor.

Email(Email memo)
Constructor.

Method Summary

void	addBcc(java.util.List bcc) Adds list of names to the list of the blind copy recipients.
void	addBcc(java.lang.String bcc) Adds a name to the list of the blind copy recipients.
void	addCategories(java.util.Collection categories) Adds a collection of categories.
void	addCategories(java.lang.String category) Adds a single category.
void	addCc(java.util.List sendTo)
void	addCc(java.lang.String sendTo)
void	addHeader(java.lang.String name, java.lang.String value) Adds a new header attribute.
void	addHeaders(java.util.Map map) Adds all given attributes to the set of headers.
void	addRecipient(java.lang.String recipient)
void	clearHeaders() Clears all other header information.
boolean	containsHeader(java.lang.Object name) Checks if a header attribute exists.
java.util.Set	getAllHeaderNames() Returns the set of all header names.
java.util.List	getBcc() Returns the list of blind copy recipients.
java.lang.String	getBody() Returns the body of the email as an unformatted string.
java.util.Set	getCategories() Returns an iterator over all categories.
java.util.List	getCc()
java.util.Calendar	getDeliveredDate() Get the Delivery Date/Time.
java.lang.String	getFrom()
void	getHeader(java.lang.String name) Returns the value of a given named header attribute.
java.util.Map	getHeaders() Returns the map of all header attribute.
Email.Importance	getImportance() Returns the importance.
java.lang.String	getPrincipal()
Email.Priority	getPriority() Returns the priority.
java.util.List	getRecipients()
java.lang.String	getReplyTo()
boolean	getSaveOnSend() Returns if the mail should be saved after send or not.
java.lang.String	getSubject()
java.util.Set	headerNames() Returns a set of the names of all available header attributes..
void	removeHeader(java.lang.String name) Removes a header attribute.
void	setBcc(java.util.Collection bcc) Sets the list of blind copy recipients to a list of names.
void	setBcc(java.util.List bcc) Sets the list of blind copy recipients to a list of names.
void	setBcc(java.lang.String bcc) Sets the list of blind copy recipients to a single name.
void	setBody(java.lang.String body) Sets the body of the email as an unformatted string.
void	setCategories(java.util.Set categories) Sets the set of categories.
void	setCc(java.util.Collection copyTo)
void	setCc(java.util.List copyTo)
void	setDeliveredDate(java.util.Calendar deliveredDate) Set the Delivery Date/Time.
void	setFrom(java.lang.String from)
void	setImportance(Email.Importance importance) Sets the importance.
void	setPrincipal(java.lang.String principal)
void	setPriority(Email.Priority priority) Sets the priority.
void	setRecipient(java.lang.String recipients) Sets the list of recipients to a single name.
void	setRecipients(java.util.Collection recipients)
void	setRecipients(java.util.List recipients)
void	setReplyTo(java.lang.String replyTo)
void	setSaveOnSend(boolean saveOnSend) Sets if the mail should be saved after send or not.
void	setSubject(java.lang.String subject)

Methods inherited from class de.bea.domingo.map.BaseInstance

getUnid, setUnid

Methods inherited from class java.lang.Object

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

Constructor Detail

Email

public Email()

Constructor.

Email

public Email(Email memo)

Constructor.

Parameters:

memo - another memo for copying data from.

Method Detail

getSubject

public java.lang.String getSubject()

Returns:

Returns the subject.

setSubject

public void setSubject(java.lang.String subject)

Parameters:

subject - The subject to set

getBcc

public java.util.List getBcc()

Returns the list of blind copy recipients.

Returns:

list of blind copy recipients

setBcc

public void setBcc(java.util.Collection bcc)

Sets the list of blind copy recipients to a list of names. All previously existing names are removed.

Parameters:

bcc - list of names

setBcc

public void setBcc(java.util.List bcc)

Sets the list of blind copy recipients to a list of names. All previously existing names are removed.

Parameters:

bcc - list of names

setBcc

public void setBcc(java.lang.String bcc)

Sets the list of blind copy recipients to a single name. All previously existing names are removed.

Parameters:

bcc - The sendTo to set.

addBcc

public void addBcc(java.lang.String bcc)

Adds a name to the list of the blind copy recipients.

Parameters:

bcc - The sendTo to set.

addBcc

public void addBcc(java.util.List bcc)

Adds list of names to the list of the blind copy recipients.

Parameters:

bcc - The sendTo to set.

getRecipients

public java.util.List getRecipients()

Returns:

Returns the recipients.

setRecipients

public void setRecipients(java.util.Collection recipients)

Parameters:

recipients - The recipients to set.

setRecipients

public void setRecipients(java.util.List recipients)

Parameters:

recipients - The recipients to set.

setRecipient

public void setRecipient(java.lang.String recipients)

Sets the list of recipients to a single name. All previously existing names are removed.

Parameters:

recipients - The recipients to set.

addRecipient

public void addRecipient(java.lang.String recipient)

Parameters:

recipient - The recipient to set.

getCc

public java.util.List getCc()

Returns:

Returns the sopyTo.

setCc

public void setCc(java.util.Collection copyTo)

Parameters:

copyTo - The copyTo to set.

setCc

public void setCc(java.util.List copyTo)

Parameters:

copyTo - The copyTo to set.

addCc

public void addCc(java.lang.String sendTo)

Parameters:

sendTo - The sendTo to set.

addCc

public void addCc(java.util.List sendTo)

Parameters:

sendTo - The sendTo to set.

getFrom

public java.lang.String getFrom()

Returns:

Returns the from.

setFrom

public void setFrom(java.lang.String from)

Parameters:

from - The from to set.

getPrincipal

public java.lang.String getPrincipal()

Returns:

Returns the principal.

setPrincipal

public void setPrincipal(java.lang.String principal)

Parameters:

principal - The principal to set.

getReplyTo

public java.lang.String getReplyTo()

Returns:

Returns the replyTo.

setReplyTo

public void setReplyTo(java.lang.String replyTo)

Parameters:

replyTo - The replyTo to set.

getBody

public java.lang.String getBody()

Returns the body of the email as an unformatted string.

Returns:

unformatted body

setBody

public void setBody(java.lang.String body)

Sets the body of the email as an unformatted string.

Parameters:

body - unformatted body

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Adds a new header attribute.

Parameters:

name - the name of the attribute

value - the value of the attribute

removeHeader

public void removeHeader(java.lang.String name)

Removes a header attribute.

Parameters:

name - the name of the attribute

getAllHeaderNames

public java.util.Set getAllHeaderNames()

Returns the set of all header names.

Returns:

set of all header names

getHeader

public void getHeader(java.lang.String name)

Returns the value of a given named header attribute.

Parameters:

name - the name of the attribute

getHeaders

public java.util.Map getHeaders()

Returns the map of all header attribute.

Returns:

map of header attributes

clearHeaders

public void clearHeaders()

Clears all other header information.

containsHeader

public boolean containsHeader(java.lang.Object name)

Checks if a header attribute exists.

Parameters:

name - name of the attribute to check

Returns:

true if the attribute exists, else false

headerNames

public java.util.Set headerNames()

Returns a set of the names of all available header attributes..

Returns:

set of header attribute names

addHeaders

public void addHeaders(java.util.Map map)

Adds all given attributes to the set of headers.

Parameters:

map - of attributes to add

addCategories

public void addCategories(java.util.Collection categories)

Adds a collection of categories.

Parameters:

categories - the categories to add

addCategories

public void addCategories(java.lang.String category)

Adds a single category.

Parameters:

category - the category to add

setCategories

public void setCategories(java.util.Set categories)

Sets the set of categories.

Parameters:

categories - the categories to set

getCategories

public java.util.Set getCategories()

Returns an iterator over all categories.

Returns:

iterator over all categories.

getImportance

public Email.Importance getImportance()

Returns the importance.

Returns:

importance

setImportance

public void setImportance(Email.Importance importance)

Sets the importance.

Parameters:

importance - importance

getPriority

public Email.Priority getPriority()

Returns the priority.

Returns:

priority

setPriority

public void setPriority(Email.Priority priority)

Sets the priority.

Parameters:

priority - priority

getDeliveredDate

public java.util.Calendar getDeliveredDate()

Get the Delivery Date/Time.

Returns:

date message was delivered.

setDeliveredDate

public void setDeliveredDate(java.util.Calendar deliveredDate)

Set the Delivery Date/Time.

Parameters:

deliveredDate - date email was delivered.

getSaveOnSend

public boolean getSaveOnSend()

Returns if the mail should be saved after send or not.

Returns:

true if the mail should be saved after send, else false

setSaveOnSend

public void setSaveOnSend(boolean saveOnSend)

Sets if the mail should be saved after send or not.

The default value is true.

Parameters:

saveOnSend - true if the mail should be saved after send, else false