Email (Domingo 1.5.2 API)

java.lang.Object
- de.jakop.lotus.domingo.map.BaseInstance
- - de.jakop.lotus.domingo.groupware.Email

```
public final class Email
extends BaseInstance
```
Represents a Notes mail document.

Author:

Kurt Riede

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Email.Importance` Represents all possible values for the importance.
`static class`	`Email.Priority` Represents all possible values for the priority.

Constructor Summary

Constructors
Constructor and Description

Email()
Constructor.

Email(Email memo)
Constructor.

Constructors
Constructor and Description
`Email()` Constructor.
`Email(Email memo)` Constructor.

Method Summary

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

Methods inherited from class de.jakop.lotus.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 String getSubject()
```
    Returns:
    
    Returns the subject.
  - setSubject
```
public void setSubject(String subject)
```
    Parameters:
    
    subject - The subject to set
  - getBcc
```
public List getBcc()
```
    Returns the list of blind copy recipients.
    
    Returns:
    
    list of blind copy recipients
  - setBcc
```
public void setBcc(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(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(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(String bcc)
```
    Adds a name to the list of the blind copy recipients.
    
    Parameters:
    
    bcc - The sendTo to set.
  - addBcc
```
public void addBcc(List bcc)
```
    Adds list of names to the list of the blind copy recipients.
    
    Parameters:
    
    bcc - The sendTo to set.
  - getRecipients
```
public List getRecipients()
```
    Returns:
    
    Returns the recipients.
  - setRecipients
```
public void setRecipients(Collection recipients)
```
    Parameters:
    
    recipients - The recipients to set.
  - setRecipients
```
public void setRecipients(List recipients)
```
    Parameters:
    
    recipients - The recipients to set.
  - setRecipient
```
public void setRecipient(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(String recipient)
```
    Parameters:
    
    recipient - The recipient to set.
  - getCc
```
public List getCc()
```
    Returns:
    
    Returns the sopyTo.
  - setCc
```
public void setCc(Collection copyTo)
```
    Parameters:
    
    copyTo - The copyTo to set.
  - setCc
```
public void setCc(List copyTo)
```
    Parameters:
    
    copyTo - The copyTo to set.
  - addCc
```
public void addCc(String sendTo)
```
    Parameters:
    
    sendTo - The sendTo to set.
  - addCc
```
public void addCc(List sendTo)
```
    Parameters:
    
    sendTo - The sendTo to set.
  - getFrom
```
public String getFrom()
```
    Returns:
    
    Returns the from.
  - setFrom
```
public void setFrom(String from)
```
    Parameters:
    
    from - The from to set.
  - getPrincipal
```
public String getPrincipal()
```
    Returns:
    
    Returns the principal.
  - setPrincipal
```
public void setPrincipal(String principal)
```
    Parameters:
    
    principal - The principal to set.
  - getReplyTo
```
public String getReplyTo()
```
    Returns:
    
    Returns the replyTo.
  - setReplyTo
```
public void setReplyTo(String replyTo)
```
    Parameters:
    
    replyTo - The replyTo to set.
  - getBody
```
public String getBody()
```
    Returns the body of the email as an unformatted string.
    
    Returns:
    
    unformatted body
  - setBody
```
public void setBody(String body)
```
    Sets the body of the email as an unformatted string.
    
    Parameters:
    
    body - unformatted body
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Adds a new header attribute.
    
    Parameters:
    
    name - the name of the attribute
    
    value - the value of the attribute
  - removeHeader
```
public void removeHeader(String name)
```
    Removes a header attribute.
    
    Parameters:
    
    name - the name of the attribute
  - getAllHeaderNames
```
public Set getAllHeaderNames()
```
    Returns the set of all header names.
    
    Returns:
    
    set of all header names
  - getHeader
```
public void getHeader(String name)
```
    Returns the value of a given named header attribute.
    
    Parameters:
    
    name - the name of the attribute
  - getHeaders
```
public 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(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 Set headerNames()
```
    Returns a set of the names of all available header attributes..
    
    Returns:
    
    set of header attribute names
  - addHeaders
```
public void addHeaders(Map map)
```
    Adds all given attributes to the set of headers.
    
    Parameters:
    
    map - of attributes to add
  - addCategories
```
public void addCategories(Collection categories)
```
    Adds a collection of categories.
    
    Parameters:
    
    categories - the categories to add
  - addCategories
```
public void addCategories(String category)
```
    Adds a single category.
    
    Parameters:
    
    category - the category to add
  - setCategories
```
public void setCategories(Set categories)
```
    Sets the set of categories.
    
    Parameters:
    
    categories - the categories to set
  - setCategories
```
public void setCategories(Collection categories)
```
    Sets the set of categories.
    
    Parameters:
    
    categories - the categories to set
  - getCategories
```
public 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 Calendar getDeliveredDate()
```
    Get the Delivery Date/Time.
    
    Returns:
    
    date message was delivered.
  - setDeliveredDate
```
public void setDeliveredDate(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

Class Email

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class de.jakop.lotus.domingo.map.BaseInstance

Methods inherited from class java.lang.Object

Constructor Detail

Email

Email

Method Detail

getSubject

setSubject

getBcc

setBcc

setBcc

setBcc

addBcc

addBcc

getRecipients

setRecipients

setRecipients

setRecipient

addRecipient

getCc

setCc

setCc

addCc

addCc

getFrom

setFrom

getPrincipal

setPrincipal

getReplyTo

setReplyTo

getBody

setBody

addHeader

removeHeader

getAllHeaderNames

getHeader

getHeaders

clearHeaders

containsHeader

headerNames

addHeaders

addCategories

addCategories

setCategories

setCategories

getCategories

getImportance

setImportance

getPriority

setPriority

getDeliveredDate

setDeliveredDate

getSaveOnSend

setSaveOnSend