EmailMessage (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.messenger.domain.DisposableMessage<javax.mail.internet.InternetAddress,T>
- - com.neurosys.messenger.domain.email.EmailMessage<T>

Type Parameters:

T - as PayloadType (Any Object.toString() or Multipart)

All Implemented Interfaces:

Message<javax.mail.internet.InternetAddress,T>, Serializable
```
public class EmailMessage<T>
extends DisposableMessage<javax.mail.internet.InternetAddress,T>
```
A generic Email message
The payload could be String or a Multipart Object. How it is interpreted depends on the DisposableMessage.getContentType()

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<javax.mail.internet.InternetAddress>`	`BCCList` If not using bulk and want to show BCC addresses, use this
`protected String`	`BCCListStr` Setting comma separated EMAIL ADDRESSES in this appends to `CCList` or `BCCList` respectively, but does not directly participate in any processing
`protected List<javax.mail.internet.InternetAddress>`	`CCList` If not using bulk and want to show CC addresses, use this
`protected String`	`CCListStr` Setting comma separated EMAIL ADDRESSES in this appends to `CCList` or `BCCList` respectively, but does not directly participate in any processing

Fields inherited from class com.neurosys.messenger.domain.DisposableMessage
contentType, messageId, payload, priority, recipients

Constructor Summary

Constructors
Constructor and Description
`EmailMessage()`
`EmailMessage(EmailMessage messageTemplate)`
`EmailMessage(T payload)`
`EmailMessage(T payload, ContentType contentType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttachehmentSuffix()` The suffix will be added to all attachments to make it comply with standard naming contentions
`List<javax.mail.internet.InternetAddress>`	`getBCCList()` If not using bulk and want to show BCC addresses, use this
`String`	`getBCCListStr()` Setting comma separated EMAIL ADDRESSES in this appends to `BCCList` but does not directly participate in any processing
`List<javax.mail.internet.InternetAddress>`	`getCCList()` If not using bulk and want to show CC addresses, use this
`String`	`getCCListStr()` Setting comma separated EMAIL ADDRESSES in this appends to `CCList` but does not directly participate in any processing
`Map<String,String>`	`getHeaders()`
`Collection<EmailMultiPartBuilder.Part>`	`getParts()`
`javax.mail.internet.InternetAddress`	`getSourceAddress()`
`String`	`getSubject()`
`String`	`getUnsubscribeAction()` Allow the user to un subscribe from the email; usually used with Bulk mails and considered good practice to provide the user the ability to un-subscribe.
`boolean`	`isAllowAttachments()` Allow or filter any Attachments
`boolean`	`isAllowHtml()` Keep or remove any HTML content
`boolean`	`isAttachImagesAsFiles()` All image parts will be added as attachments.
`boolean`	`isBulk()` If set to true, The message will be a Bulk blast / optimize accordingly and set appropriate RFC headers Example see https://support.google.com/mail/bin/answer.py?hl=en&answer=81126#format
`boolean`	`isCanReply()`
`boolean`	`isEmbedImages()` All image parts will be embedded in the email
`void`	`setAllowAttachments(boolean allowAttachments)` Allow or filter any Attachments
`void`	`setAllowHtml(boolean allowHtml)` Keep or remove any HTML content
`void`	`setAttachehmentSuffix(String attachehmentSuffix)` The suffix will be added to all attachments to make it comply with standard naming contentions
`void`	`setAttachImagesAsFiles(boolean attachImagesAsFiles)` All image parts will be added as attachments.
`void`	`setBCCList(List<javax.mail.internet.InternetAddress> bCCList)` If not using bulk and want to show BCC addresses, use this
`void`	`setBCCListStr(String bCCListStr)` Setting comma separated EMAIL ADDRESSES in this appends to `BCCList` but does not directly participate in any processing
`void`	`setBulk(boolean bulk)` If set to true, The message will be a Bulk blast / optimize accordingly and set appropriate RFC headers Example see https://support.google.com/mail/bin/answer.py?hl=en&answer=81126#format
`void`	`setCanReply(boolean canReply)`
`void`	`setCCList(List<javax.mail.internet.InternetAddress> cCList)` If not using bulk and want to show CC addresses, use this
`void`	`setCCListStr(String cCListStr)` Setting comma separated EMAIL ADDRESSES in this appends to `CCList` but does not directly participate in any processing
`void`	`setEmbedImages(boolean embedImages)` All image parts will be embedded in the email
`void`	`setHeaders(Map<String,String> headers)`
`void`	`setParts(Collection<EmailMultiPartBuilder.Part> parts)`
`void`	`setSourceAddress(javax.mail.internet.InternetAddress sourceAddress)`
`void`	`setSubject(String subject)`
`void`	`setUnsubscribeAction(String unsubscribeAction)` Allow the user to un subscribe from the email; usually used with Bulk mails and considered good practice to provide the user the ability to un-subscribe.

Methods inherited from class com.neurosys.messenger.domain.DisposableMessage
getContentType, getMessageId, getPayload, getPriority, getRecipients, setContentType, setMessageId, setPayload, setPriority, setRecipients

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

- Field Detail
  - CCList
```
protected List<javax.mail.internet.InternetAddress> CCList
```
    If not using bulk and want to show CC addresses, use this
  - BCCList
```
protected List<javax.mail.internet.InternetAddress> BCCList
```
    If not using bulk and want to show BCC addresses, use this
  - CCListStr
```
protected transient String CCListStr
```
    Setting comma separated EMAIL ADDRESSES in this appends to CCList or BCCList respectively, but does not directly participate in any processing
  - BCCListStr
```
protected transient String BCCListStr
```
    Setting comma separated EMAIL ADDRESSES in this appends to CCList or BCCList respectively, but does not directly participate in any processing
- Constructor Detail
  - EmailMessage
```
public EmailMessage()
```
  - EmailMessage
```
public EmailMessage(EmailMessage messageTemplate)
             throws Exception
```
    Throws:
    
    Exception
  - EmailMessage
```
public EmailMessage(T payload)
```
  - EmailMessage
```
public EmailMessage(T payload,
                    ContentType contentType)
```
- Method Detail
  - getSourceAddress
```
public javax.mail.internet.InternetAddress getSourceAddress()
```
  - setSourceAddress
```
public void setSourceAddress(javax.mail.internet.InternetAddress sourceAddress)
```
  - getSubject
```
public String getSubject()
```
  - setSubject
```
public void setSubject(String subject)
```
  - isBulk
```
public boolean isBulk()
```
    If set to true, The message will be a Bulk blast / optimize accordingly and set appropriate RFC headers Example see https://support.google.com/mail/bin/answer.py?hl=en&answer=81126#format
    
    Default value:
    
    false
  - setBulk
```
public void setBulk(boolean bulk)
```
    If set to true, The message will be a Bulk blast / optimize accordingly and set appropriate RFC headers Example see https://support.google.com/mail/bin/answer.py?hl=en&answer=81126#format
    
    Default value:
    
    false
  - isCanReply
```
public boolean isCanReply()
```
  - setCanReply
```
public void setCanReply(boolean canReply)
```
  - getHeaders
```
public Map<String,String> getHeaders()
```
  - setHeaders
```
public void setHeaders(Map<String,String> headers)
```
  - getParts
```
public Collection<EmailMultiPartBuilder.Part> getParts()
```
  - setParts
```
public void setParts(Collection<EmailMultiPartBuilder.Part> parts)
```
  - getAttachehmentSuffix
```
public String getAttachehmentSuffix()
```
    The suffix will be added to all attachments to make it comply with standard naming contentions
  - setAttachehmentSuffix
```
public void setAttachehmentSuffix(String attachehmentSuffix)
```
    The suffix will be added to all attachments to make it comply with standard naming contentions
  - isEmbedImages
```
public boolean isEmbedImages()
```
    All image parts will be embedded in the email
    
    Default value:
    
    true
  - setEmbedImages
```
public void setEmbedImages(boolean embedImages)
```
    All image parts will be embedded in the email
    
    Default value:
    
    true
  - isAttachImagesAsFiles
```
public boolean isAttachImagesAsFiles()
```
    All image parts will be added as attachments.
    Works in conjunction with allowAttachments
    
    Default value:
    
    false
  - setAttachImagesAsFiles
```
public void setAttachImagesAsFiles(boolean attachImagesAsFiles)
```
    All image parts will be added as attachments.
    Works in conjunction with allowAttachments
    
    Default value:
    
    false
  - isAllowAttachments
```
public boolean isAllowAttachments()
```
    Allow or filter any Attachments
    
    Default value:
    
    true
  - setAllowAttachments
```
public void setAllowAttachments(boolean allowAttachments)
```
    Allow or filter any Attachments
    
    Default value:
    
    true
  - isAllowHtml
```
public boolean isAllowHtml()
```
    Keep or remove any HTML content
    
    Default value:
    
    true
  - setAllowHtml
```
public void setAllowHtml(boolean allowHtml)
```
    Keep or remove any HTML content
    
    Default value:
    
    true
  - getUnsubscribeAction
```
public String getUnsubscribeAction()
```
    Allow the user to un subscribe from the email; usually used with Bulk mails and considered good practice to provide the user the ability to un-subscribe.
    
    Sample:
    List-Unsubscribe: ,
    
    See Also:
    
    2369 - http://tools.ietf.org/search/rfc2369
  - setUnsubscribeAction
```
public void setUnsubscribeAction(String unsubscribeAction)
```
    Allow the user to un subscribe from the email; usually used with Bulk mails and considered good practice to provide the user the ability to un-subscribe.
    
    Sample:
    List-Unsubscribe: ,
    
    See Also:
    
    2369 - http://tools.ietf.org/search/rfc2369
  - getCCList
```
public List<javax.mail.internet.InternetAddress> getCCList()
```
    If not using bulk and want to show CC addresses, use this
  - setCCList
```
public void setCCList(List<javax.mail.internet.InternetAddress> cCList)
```
    If not using bulk and want to show CC addresses, use this
  - getBCCList
```
public List<javax.mail.internet.InternetAddress> getBCCList()
```
    If not using bulk and want to show BCC addresses, use this
  - setBCCList
```
public void setBCCList(List<javax.mail.internet.InternetAddress> bCCList)
```
    If not using bulk and want to show BCC addresses, use this
  - getCCListStr
```
public String getCCListStr()
```
    Setting comma separated EMAIL ADDRESSES in this appends to CCList but does not directly participate in any processing
  - setCCListStr
```
public void setCCListStr(String cCListStr)
                  throws javax.mail.internet.AddressException
```
    Setting comma separated EMAIL ADDRESSES in this appends to CCList but does not directly participate in any processing
    
    Throws:
    
    javax.mail.internet.AddressException
  - getBCCListStr
```
public String getBCCListStr()
```
    Setting comma separated EMAIL ADDRESSES in this appends to BCCList but does not directly participate in any processing
  - setBCCListStr
```
public void setBCCListStr(String bCCListStr)
                   throws javax.mail.internet.AddressException
```
    Setting comma separated EMAIL ADDRESSES in this appends to BCCList but does not directly participate in any processing
    
    Throws:
    
    javax.mail.internet.AddressException

Class EmailMessage<T>

Field Summary

Fields inherited from class com.neurosys.messenger.domain.DisposableMessage

Constructor Summary

Method Summary

Methods inherited from class com.neurosys.messenger.domain.DisposableMessage

Methods inherited from class java.lang.Object

Field Detail

CCList

BCCList

CCListStr

BCCListStr

Constructor Detail

EmailMessage

EmailMessage

EmailMessage

EmailMessage

Method Detail

getSourceAddress

setSourceAddress

getSubject

setSubject

isBulk

setBulk

isCanReply

setCanReply

getHeaders

setHeaders

getParts

setParts

getAttachehmentSuffix

setAttachehmentSuffix

isEmbedImages

setEmbedImages

isAttachImagesAsFiles

setAttachImagesAsFiles

isAllowAttachments

setAllowAttachments

isAllowHtml

setAllowHtml

getUnsubscribeAction

setUnsubscribeAction

getCCList

setCCList

getBCCList

setBCCList

getCCListStr

setCCListStr

getBCCListStr

setBCCListStr