CommonEmail (Jodd API Documentation)

java.lang.Object
- jodd.mail.CommonEmail

Direct Known Subclasses:

Email, ReceivedEmail
```
public abstract class CommonEmail
extends java.lang.Object
```
Common stuff for both Email and ReceivedEmail

Field Summary

Fields
Modifier and Type	Field and Description
`protected EmailAddress[]`	`bcc`
`protected EmailAddress[]`	`cc`
`protected EmailAddress`	`from`
`protected java.util.Map<java.lang.String,java.lang.String>`	`headers`
`protected java.util.List<EmailMessage>`	`messages`
`static int`	`PRIORITY_HIGH`
`static int`	`PRIORITY_HIGHEST`
`static int`	`PRIORITY_LOW`
`static int`	`PRIORITY_LOWEST`
`static int`	`PRIORITY_NORMAL`
`protected EmailAddress[]`	`replyTo`
`protected java.util.Date`	`sentDate`
`protected java.lang.String`	`subject`
`protected java.lang.String`	`subjectEncoding`
`protected EmailAddress[]`	`to`
`static java.lang.String`	`X_PRIORITY`

Constructor Summary

Constructors
Constructor and Description

CommonEmail()

Constructors
Constructor and Description
`CommonEmail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBcc(EmailAddress to)` Appends BCC address.
`void`	`addCc(EmailAddress to)` Appends CC address.
`void`	`addMessage(EmailMessage emailMessage)`
`void`	`addMessage(java.lang.String text, java.lang.String mimeType)`
`void`	`addMessage(java.lang.String text, java.lang.String mimeType, java.lang.String encoding)`
`void`	`addReplyTo(EmailAddress to)` Appends REPLY-TO address.
`void`	`addTo(EmailAddress to)` Appends TO address.
`protected java.util.Map<java.lang.String,java.lang.String>`	`getAllHeaders()` Returns all headers as a `HashMap`.
`java.util.List<EmailMessage>`	`getAllMessages()` Returns all messages.
`EmailAddress[]`	`getBcc()` Returns BCC addresses.
`EmailAddress[]`	`getCc()` Returns CC addresses.
`EmailAddress`	`getFrom()` Returns FROM `address`.
`java.lang.String`	`getHeader(java.lang.String name)`
`int`	`getPriority()` Returns emails priority (1 - 5) or `-1` if priority not available.
`EmailAddress[]`	`getReplyTo()` Returns REPLY-TO addresses.
`java.util.Date`	`getSentDate()` Returns e-mails sent date.
`java.lang.String`	`getSubject()` Returns message subject.
`java.lang.String`	`getSubjectEncoding()` Returns the message subject encoding.
`EmailAddress[]`	`getTo()` Returns TO addresses.
`void`	`setBcc(EmailAddress... bccs)` Sets BCC addresses.
`void`	`setCc(EmailAddress... ccs)` Sets CC addresses.
`void`	`setFrom(EmailAddress from)` Sets the FROM address.
`void`	`setHeader(java.lang.String name, java.lang.String value)` Sets a new header value.
`void`	`setPriority(int priority)` Sets email priority.
`void`	`setReplyTo(EmailAddress... replyTo)` Sets REPLY-TO addresses.
`void`	`setSentDate(java.util.Date date)` Sets e-mails sent date.
`void`	`setSubject(java.lang.String subject)` Sets message subject.
`void`	`setSubject(java.lang.String subject, java.lang.String encoding)` Sets message subject with specified encoding to override default platform encoding.
`void`	`setTo(EmailAddress... tos)` Sets TO addresses.

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

Field Detail

X_PRIORITY

public static final java.lang.String X_PRIORITY

See Also:: Constant Field Values

PRIORITY_HIGHEST
```
public static final int PRIORITY_HIGHEST
```
See Also:

Constant Field Values

PRIORITY_HIGH
```
public static final int PRIORITY_HIGH
```
See Also:

Constant Field Values

PRIORITY_NORMAL
```
public static final int PRIORITY_NORMAL
```
See Also:

Constant Field Values

PRIORITY_LOW
```
public static final int PRIORITY_LOW
```
See Also:

Constant Field Values

PRIORITY_LOWEST
```
public static final int PRIORITY_LOWEST
```
See Also:

Constant Field Values

from
```
protected EmailAddress from
```

to
```
protected EmailAddress[] to
```

replyTo
```
protected EmailAddress[] replyTo
```

cc
```
protected EmailAddress[] cc
```

bcc
```
protected EmailAddress[] bcc
```

subject
```
protected java.lang.String subject
```

subjectEncoding

protected java.lang.String subjectEncoding

messages

protected java.util.List<EmailMessage> messages

headers

protected java.util.Map<java.lang.String,java.lang.String> headers

sentDate
```
protected java.util.Date sentDate
```

Constructor Detail
- CommonEmail
```
public CommonEmail()
```

Method Detail
- setFrom
```
public void setFrom(EmailAddress from)
```
  Sets the FROM address.
- getFrom
```
public EmailAddress getFrom()
```
  Returns FROM address.
- setTo
```
public void setTo(EmailAddress... tos)
```
  Sets TO addresses.
- addTo
```
public void addTo(EmailAddress to)
```
  Appends TO address.
- getTo
```
public EmailAddress[] getTo()
```
  Returns TO addresses.
- setReplyTo
```
public void setReplyTo(EmailAddress... replyTo)
```
  Sets REPLY-TO addresses.
- addReplyTo
```
public void addReplyTo(EmailAddress to)
```
  Appends REPLY-TO address.
- getReplyTo
```
public EmailAddress[] getReplyTo()
```
  Returns REPLY-TO addresses.
- setCc
```
public void setCc(EmailAddress... ccs)
```
  Sets CC addresses.
- addCc
```
public void addCc(EmailAddress to)
```
  Appends CC address.
- getCc
```
public EmailAddress[] getCc()
```
  Returns CC addresses.
- setBcc
```
public void setBcc(EmailAddress... bccs)
```
  Sets BCC addresses.
- addBcc
```
public void addBcc(EmailAddress to)
```
  Appends BCC address.
- getBcc
```
public EmailAddress[] getBcc()
```
  Returns BCC addresses.
- setSubject
```
public void setSubject(java.lang.String subject)
```
  Sets message subject.
- setSubject
```
public void setSubject(java.lang.String subject,
                       java.lang.String encoding)
```
  Sets message subject with specified encoding to override default platform encoding. If the subject contains non US-ASCII characters, it will be encoded using the specified charset. If the subject contains only US-ASCII characters, no encoding is done and it is used as-is. The application must ensure that the subject does not contain any line breaks. See MimeMessage.setSubject(String, String).
- getSubject
```
public java.lang.String getSubject()
```
  Returns message subject.
- getSubjectEncoding
```
public java.lang.String getSubjectEncoding()
```
  Returns the message subject encoding.
- getAllMessages
```
public java.util.List<EmailMessage> getAllMessages()
```
  Returns all messages.
- addMessage
```
public void addMessage(EmailMessage emailMessage)
```
- addMessage
```
public void addMessage(java.lang.String text,
                       java.lang.String mimeType,
                       java.lang.String encoding)
```
- addMessage
```
public void addMessage(java.lang.String text,
                       java.lang.String mimeType)
```
- getAllHeaders
```
protected java.util.Map<java.lang.String,java.lang.String> getAllHeaders()
```
  Returns all headers as a HashMap.
- setHeader
```
public void setHeader(java.lang.String name,
                      java.lang.String value)
```
  Sets a new header value.
- getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
- setPriority
```
public void setPriority(int priority)
```
  Sets email priority. Values of 1 through 5 are acceptable, with 1 being the highest priority, 3 = normal and 5 = lowest priority.
- getPriority
```
public int getPriority()
```
  Returns emails priority (1 - 5) or -1 if priority not available.
  
  See Also:
  
  setPriority(int)
- setSentDate
```
public void setSentDate(java.util.Date date)
```
  Sets e-mails sent date. If input parameter is null then date will be when email is physically sent.
- getSentDate
```
public java.util.Date getSentDate()
```
  Returns e-mails sent date. If return value is null then date will be set during the process of sending.
  
  Returns:
  
  email's sent date or null if it will be set later.

Class CommonEmail

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

X_PRIORITY

PRIORITY_HIGHEST

PRIORITY_HIGH

PRIORITY_NORMAL

PRIORITY_LOW

PRIORITY_LOWEST

from

to

replyTo

cc

bcc

subject

subjectEncoding

messages

headers

sentDate

Constructor Detail

CommonEmail

Method Detail

setFrom

getFrom

setTo

addTo

getTo

setReplyTo

addReplyTo

getReplyTo

setCc

addCc

getCc

setBcc

addBcc

getBcc

setSubject

setSubject

getSubject

getSubjectEncoding

getAllMessages

addMessage

addMessage

addMessage

getAllHeaders

setHeader

getHeader

setPriority

getPriority

setSentDate

getSentDate