java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.net.Email

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Serializable
```
public class Email
extends LoggingObject
```
Container object for an email.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected File[]`	`m_Attachments`	the attachments.
`protected EmailAddress[]`	`m_BCC`	the BCC recipients.
`protected String`	`m_Body`	the body.
`protected EmailAddress[]`	`m_CC`	the CC recipients.
`protected EmailAddress`	`m_From`	the sender.
`protected Map<String,byte[]>`	`m_InMemoryAttachments`	the in-memory attachments (filename -> byte array).
`protected String`	`m_Subject`	the subject.
`protected EmailAddress[]`	`m_To`	the recipients.
`static String`	`NO_SUBJECT`	the default subject if none provided.

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

Email()
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Email`	`attachments(File[] attachments)`	Sets the attachments.
`Email`	`bcc(EmailAddress bcc)`	Sets the BCC email address.
`Email`	`bcc(EmailAddress[] bcc)`	Sets the BCC email addresses.
`Email`	`body(String body)`	Sets the body.
`Email`	`cc(EmailAddress cc)`	Sets the CC email address.
`Email`	`cc(EmailAddress[] cc)`	Sets the CC email addresses.
`Email`	`from(EmailAddress from)`	Sets the FROM email address.
`Email`	`from(String from)`	Sets the FROM email address.
`File[]`	`getAttachments()`	Returns the attachments.
`EmailAddress[]`	`getBCC()`	Returns the BCC recipients.
`String`	`getBody()`	Returns the body.
`EmailAddress[]`	`getCC()`	Returns the CC recipients.
`EmailAddress`	`getFrom()`	Returns the sender.
`Map<String,byte[]>`	`getInMemoryAttachments()`	Returns the in-memory attachments.
`String`	`getSubject()`	Returns the subject.
`EmailAddress[]`	`getTo()`	Returns the TO recipients.
`Email`	`inMemoryAttachments(Map<String,byte[]> attachments)`	Sets the in-memory attachments.
`Email`	`subject(String subject)`	Sets the subject.
`Email`	`to(EmailAddress to)`	Sets the TO email address.
`Email`	`to(EmailAddress[] to)`	Sets the TO email addresses.
`Email`	`to(String to)`	Sets the TO email address.
`String`	`toPlainText()`	Turns the email into a plain text string.
`String`	`toString()`	Simple info string for debugging purposes.

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_SUBJECT
```
public static final String NO_SUBJECT
```
    the default subject if none provided.
    
    See Also:
    
    Constant Field Values
  - m_From
```
protected EmailAddress m_From
```
    the sender.
  - m_To
```
protected EmailAddress[] m_To
```
    the recipients.
  - m_CC
```
protected EmailAddress[] m_CC
```
    the CC recipients.
  - m_BCC
```
protected EmailAddress[] m_BCC
```
    the BCC recipients.
  - m_Subject
```
protected String m_Subject
```
    the subject.
  - m_Body
```
protected String m_Body
```
    the body.
  - m_Attachments
```
protected File[] m_Attachments
```
    the attachments.
  - m_InMemoryAttachments
```
protected Map<String,byte[]> m_InMemoryAttachments
```
    the in-memory attachments (filename -> byte array).
- Constructor Detail
  - Email
```
public Email()
```
    Default constructor.
- Method Detail
  - from
```
public Email from(String from)
```
    Sets the FROM email address.
    
    Parameters:
    
    from - the FROM address
    
    Returns:
    
    itself
  - from
```
public Email from(EmailAddress from)
```
    Sets the FROM email address.
    
    Parameters:
    
    from - the FROM address
    
    Returns:
    
    itself
  - to
```
public Email to(String to)
```
    Sets the TO email address.
    
    Parameters:
    
    to - the address, can be null
    
    Returns:
    
    itself
  - to
```
public Email to(EmailAddress to)
```
    Sets the TO email address.
    
    Parameters:
    
    to - the address, can be null
    
    Returns:
    
    itself
  - to
```
public Email to(EmailAddress[] to)
```
    Sets the TO email addresses.
    
    Parameters:
    
    to - the addresses, can be null
    
    Returns:
    
    itself
  - cc
```
public Email cc(EmailAddress cc)
```
    Sets the CC email address.
    
    Parameters:
    
    cc - the address, can be null
    
    Returns:
    
    itself
  - cc
```
public Email cc(EmailAddress[] cc)
```
    Sets the CC email addresses.
    
    Parameters:
    
    cc - the addresses, can be null
    
    Returns:
    
    itself
  - bcc
```
public Email bcc(EmailAddress bcc)
```
    Sets the BCC email address.
    
    Parameters:
    
    bcc - the address, can be null
    
    Returns:
    
    itself
  - bcc
```
public Email bcc(EmailAddress[] bcc)
```
    Sets the BCC email addresses.
    
    Parameters:
    
    bcc - the BCC addresses, can be null
    
    Returns:
    
    itself
  - getFrom
```
public EmailAddress getFrom()
```
    Returns the sender.
    
    Returns:
    
    the sender
  - subject
```
public Email subject(String subject)
```
    Sets the subject.
    
    Parameters:
    
    subject - the subject to use
    
    Returns:
    
    itself
  - body
```
public Email body(String body)
```
    Sets the body.
    
    Parameters:
    
    body - the body to use
    
    Returns:
    
    itself
  - attachments
```
public Email attachments(File[] attachments)
```
    Sets the attachments.
    
    Parameters:
    
    attachments - the attachments, can be null
    
    Returns:
    
    itself
  - inMemoryAttachments
```
public Email inMemoryAttachments(Map<String,byte[]> attachments)
```
    Sets the in-memory attachments.
    
    Parameters:
    
    attachments - the attachments, can be null
    
    Returns:
    
    itself
  - getTo
```
public EmailAddress[] getTo()
```
    Returns the TO recipients.
    
    Returns:
    
    the recipients
  - getCC
```
public EmailAddress[] getCC()
```
    Returns the CC recipients.
    
    Returns:
    
    the recipients
  - getBCC
```
public EmailAddress[] getBCC()
```
    Returns the BCC recipients.
    
    Returns:
    
    the recipients
  - getAttachments
```
public File[] getAttachments()
```
    Returns the attachments.
    
    Returns:
    
    the attachments
  - getInMemoryAttachments
```
public Map<String,byte[]> getInMemoryAttachments()
```
    Returns the in-memory attachments.
    
    Returns:
    
    the attachments
  - getSubject
```
public String getSubject()
```
    Returns the subject.
    
    Returns:
    
    the subject
  - getBody
```
public String getBody()
```
    Returns the body.
    
    Returns:
    
    the body
  - toString
```
public String toString()
```
    Simple info string for debugging purposes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the generated string
  - toPlainText
```
public String toPlainText()
```
    Turns the email into a plain text string.
    
    Returns:
    
    the generated string

Class Email

Field Summary

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Field Detail

NO_SUBJECT

m_From

m_To

m_CC

m_BCC

m_Subject

m_Body

m_Attachments

m_InMemoryAttachments

Constructor Detail

Email

Method Detail

from

from

to

to

to

cc

cc

bcc

bcc

getFrom

subject

body

attachments

inMemoryAttachments

getTo

getCC

getBCC

getAttachments

getInMemoryAttachments

getSubject

getBody

toString

toPlainText