Email (Atlassian Mail 5.0.0 API)

java.lang.Object
- com.atlassian.mail.Email

All Implemented Interfaces:

Serializable
```
public class Email
extends Object
implements Serializable
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Email(String to)` Note: By default the message has the "Precedence" header set to "bulk".
`Email(String to, String cc, String bcc)` Note: By default the message has the "Precedence" header set to "bulk".

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(String headerName, String headerValue)`
`boolean`	`equals(Object o)` Body is NOT included in comparing two Email objects
`String`	`getBcc()`
`String`	`getBody()`
`String`	`getCc()`
`String`	`getEncoding()`
`String`	`getFrom()`
`String`	`getFromName()`
`Map`	`getHeaders()`
`String`	`getInReplyTo()`
`String`	`getMessageId()`
`String`	`getMimeType()`
`javax.mail.Multipart`	`getMultipart()`
`String`	`getReplyTo()`
`String`	`getSubject()`
`String`	`getTo()`
`int`	`hashCode()` Body is NOT included in calculating the hashCode for the object.
`boolean`	`isExcludeSubjectPrefix()` If true, indicates that this email should not have its subject prefixed when sent by a `MailServer`
`protected void`	`loadDefaultHeaders()`
`String`	`removeHeader(String headerName)`
`Email`	`setBcc(String bcc)`
`Email`	`setBody(String body)`
`Email`	`setCc(String cc)`
`Email`	`setEncoding(String encoding)`
`Email`	`setExcludeSubjectPrefix(boolean excludeSubjectPrefix)`
`Email`	`setFrom(String from)`
`Email`	`setFromName(String fromName)`
`Email`	`setInReplyTo(String inReplyTo)`
`void`	`setMessageId(String messageId)`
`Email`	`setMimeType(String mimeType)`
`Email`	`setMultipart(javax.mail.Multipart multipart)`
`Email`	`setReplyTo(String replyTo)`
`Email`	`setSubject(String subject)`
`Email`	`setTo(String to)`
`String`	`toString()`

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

Constructor Detail
- Email
```
public Email(String to)
```
  Note: By default the message has the "Precedence" header set to "bulk". Use removeHeader(java.lang.String) to remove
  
  Parameters:
  
  to -
- Email
```
public Email(String to,
             String cc,
             String bcc)
```
  Note: By default the message has the "Precedence" header set to "bulk". Use removeHeader(java.lang.String) to remove
  
  Parameters:
  
  to -

Method Detail

loadDefaultHeaders
```
protected void loadDefaultHeaders()
```

setFrom
```
public Email setFrom(String from)
```

setFromName

public Email setFromName(String fromName)

setTo
```
public Email setTo(String to)
```

setSubject

public Email setSubject(String subject)

setCc
```
public Email setCc(String cc)
```

setBcc
```
public Email setBcc(String bcc)
```

setReplyTo

public Email setReplyTo(String replyTo)

setInReplyTo

public Email setInReplyTo(String inReplyTo)

setBody
```
public Email setBody(String body)
```

setMimeType

public Email setMimeType(String mimeType)

setEncoding

public Email setEncoding(String encoding)

setMultipart

public Email setMultipart(javax.mail.Multipart multipart)

setExcludeSubjectPrefix

public Email setExcludeSubjectPrefix(boolean excludeSubjectPrefix)

getFrom
```
public String getFrom()
```

getFromName
```
public String getFromName()
```

getTo
```
public String getTo()
```

getSubject
```
public String getSubject()
```

getCc
```
public String getCc()
```

getBcc
```
public String getBcc()
```

getReplyTo
```
public String getReplyTo()
```

getInReplyTo
```
public String getInReplyTo()
```

getBody
```
public String getBody()
```

getMimeType
```
public String getMimeType()
```

getEncoding
```
public String getEncoding()
```

getMultipart

public javax.mail.Multipart getMultipart()

getMessageId
```
public String getMessageId()
```

setMessageId

public void setMessageId(String messageId)

isExcludeSubjectPrefix
```
public boolean isExcludeSubjectPrefix()
```
If true, indicates that this email should not have its subject prefixed when sent by a MailServer

equals
```
public boolean equals(Object o)
```
Body is NOT included in comparing two Email objects

Overrides:

equals in class Object

Parameters:

o -

Returns:

hashCode
```
public int hashCode()
```
Body is NOT included in calculating the hashCode for the object.

Overrides:

hashCode in class Object

Returns:

toString
```
public String toString()
```
Overrides:

toString in class Object

addHeader

public void addHeader(String headerName,
                      String headerValue)

removeHeader
```
public String removeHeader(String headerName)
```
Parameters:

headerName -

Returns:

the value of the removed header

getHeaders
```
public Map getHeaders()
```

Class Email

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Email

Email

Method Detail

loadDefaultHeaders

setFrom

setFromName

setTo

setSubject

setCc

setBcc

setReplyTo

setInReplyTo

setBody

setMimeType

setEncoding

setMultipart

setExcludeSubjectPrefix

getFrom

getFromName

getTo

getSubject

getCc

getBcc

getReplyTo

getInReplyTo

getBody

getMimeType

getEncoding

getMultipart

getMessageId

setMessageId

isExcludeSubjectPrefix

equals

hashCode

toString

addHeader

removeHeader

getHeaders