Mailbox (Domingo 1.5.2 API)

All Known Implementing Classes:

MailDatabase
```
public interface Mailbox
```
Interface to the mail functionality of a Notes mail database.

Author:

Kurt Riede

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Email`	`forward(Email memo)` Creates a new memo as a forward of an existing memo.
`Email`	`forward(Email memo, boolean withAttachments)` Creates a new memo as a forward to an existing memo.
`Email`	`getEmail(EmailDigest emailDigest)` Returns the email represented by the given email-digest.
`Iterator`	`getInbox()` Returns an iterator over all mails in the Inbox.
`Iterator`	`getInbox(boolean reverseOrder)` Returns an iterator over all mails in the Inbox.
`String`	`getOwner()` Returns the name of the owner of a mailbox.
`Email`	`newEmail()` Creates a new Memo.
`void`	`remove(Email memo)` Deletes an existing memo.
`void`	`remove(EmailDigest memo)` Deletes an existing memo.
`Email`	`reply(Email memo, boolean withHistory, boolean withAttachments)` Creates a new memo as a reply to the sender of the original memo.
`Email`	`replyToAll(Email memo, boolean withHistory, boolean withAttachments)` Creates a new memo as a reply to all original recipients of the original memo.
`void`	`saveAsDraft(Email memo)` Sends a memo.
`void`	`send(Email memo)` Sends a memo.

- Method Detail
  - getOwner
```
String getOwner()
```
    Returns the name of the owner of a mailbox.
    
    Returns:
    
    name of owner
  - getInbox
```
Iterator getInbox()
```
    Returns an iterator over all mails in the Inbox.
    
    Returns:
    
    iterator over all mails in the Inbox
  - getInbox
```
Iterator getInbox(boolean reverseOrder)
```
    Returns an iterator over all mails in the Inbox.
    Depending on how the inbox is sorted (ascending or descending by date), choose where to start reading mails.
    
    Parameters:
    
    reverseOrder - whether to start at the beginning or at the end
    
    Returns:
    
    iterator over all mails in the Inbox
  - newEmail
```
Email newEmail()
```
    Creates a new Memo.
    
    Returns:
    
    the new Memo instance
  - saveAsDraft
```
void saveAsDraft(Email memo)
```
    Sends a memo.
    
    Parameters:
    
    memo - the memo to send
  - send
```
void send(Email memo)
```
    Sends a memo.
    
    Parameters:
    
    memo - the memo to send
  - forward
```
Email forward(Email memo)
```
    Creates a new memo as a forward of an existing memo.
    
    Parameters:
    
    memo - the memo to forward
    
    Returns:
    
    forward memo
  - forward
```
Email forward(Email memo,
              boolean withAttachments)
```
    Creates a new memo as a forward to an existing memo.
    
    Parameters:
    
    memo - an existing memo
    
    withAttachments - forward with or without attachments
    
    Returns:
    
    the reply memo
  - reply
```
Email reply(Email memo,
            boolean withHistory,
            boolean withAttachments)
```
    Creates a new memo as a reply to the sender of the original memo.
    
    Parameters:
    
    memo - the memo to forward
    
    withHistory - if the original mail should be included
    
    withAttachments - if attachments should be included
    
    Returns:
    
    reply memo
  - replyToAll
```
Email replyToAll(Email memo,
                 boolean withHistory,
                 boolean withAttachments)
```
    Creates a new memo as a reply to all original recipients of the original memo.
    
    Parameters:
    
    memo - the memo to forward
    
    withHistory - if the original mail should be included
    
    withAttachments - if attachments should be included
    
    Returns:
    
    reply memo
  - remove
```
void remove(Email memo)
```
    Deletes an existing memo.
    
    Parameters:
    
    memo - a memo to delete
  - remove
```
void remove(EmailDigest memo)
```
    Deletes an existing memo.
    
    Parameters:
    
    memo - a memo digest to delete
  - getEmail
```
Email getEmail(EmailDigest emailDigest)
```
    Returns the email represented by the given email-digest.
    
    Parameters:
    
    emailDigest - an email-digest
    
    Returns:
    
    the corresponding email

Interface Mailbox

Method Summary

Method Detail

getOwner

getInbox

getInbox

newEmail

saveAsDraft

send

forward

forward

reply

replyToAll

remove

remove

getEmail