com.haulmont.cuba.core.global

Class EmailInfo

java.lang.Object

com.haulmont.cuba.core.global.EmailInfo

All Implemented Interfaces:

java.io.Serializable

public class EmailInfo
extends java.lang.Object
implements java.io.Serializable

Contains email details: list of recipients, from address, caption, body and attachments. See constructors for more information.

See Also:

EmailService, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTML_CONTENT_TYPE
static java.lang.String	TEXT_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
EmailInfo(java.lang.String addresses, java.lang.String caption, java.lang.String body) Constructor.
EmailInfo(java.lang.String addresses, java.lang.String caption, java.lang.String body, java.lang.String bodyContentType) Constructor.
EmailInfo(java.lang.String addresses, java.lang.String caption, java.lang.String from, java.lang.String body, EmailAttachment... attachments) Constructor.
EmailInfo(java.lang.String addresses, java.lang.String caption, java.lang.String from, java.lang.String templatePath, java.util.Map<java.lang.String,java.io.Serializable> templateParameters, EmailAttachment... attachments) Constructor.
EmailInfo(java.lang.String addresses, java.lang.String caption, java.lang.String from, java.lang.String body, java.lang.String bodyContentType, EmailAttachment... attachments) Constructor.
EmailInfo(java.lang.String addresses, java.lang.String caption, java.lang.String from, java.lang.String bodyContentType, java.lang.String templatePath, java.util.Map<java.lang.String,java.io.Serializable> templateParameters, EmailAttachment... attachments) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
java.lang.String	getAddresses()
EmailAttachment[]	getAttachments()
java.lang.String	getBody()
java.lang.String	getBodyContentType()
java.lang.String	getCaption()
java.lang.String	getFrom()
java.util.List<EmailHeader>	getHeaders()
java.util.Map<java.lang.String,java.io.Serializable>	getTemplateParameters()
java.lang.String	getTemplatePath()
void	setAddresses(java.lang.String addresses)
void	setAttachments(EmailAttachment[] attachments)
void	setBody(java.lang.String body)
void	setBodyContentType(java.lang.String bodyContentType)
void	setCaption(java.lang.String caption)
void	setFrom(java.lang.String from)
void	setHeaders(java.util.List<EmailHeader> headers)
void	setTemplateParameters(java.util.Map<java.lang.String,java.io.Serializable> templateParameters)
void	setTemplatePath(java.lang.String templatePath)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTML_CONTENT_TYPE

public static final java.lang.String HTML_CONTENT_TYPE

See Also:

Constant Field Values

TEXT_CONTENT_TYPE

public static final java.lang.String TEXT_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

EmailInfo

public EmailInfo(java.lang.String addresses,
                 java.lang.String caption,
                 @Nullable
                 java.lang.String from,
                 java.lang.String templatePath,
                 java.util.Map<java.lang.String,java.io.Serializable> templateParameters,
                 EmailAttachment... attachments)

Constructor. Example usage:

     EmailInfo emailInfo = new EmailInfo(
          "john.doe@company.com,jane.roe@company.com",
          "Company news",
          "do-not-reply@company.com",
          "com/company/sample/email_templates/news.txt",
          Collections.singletonMap("some_var", some_value)
     );
 

If you want to set content body type you can use EmailInfo(String, String, String, String, String, Map, EmailAttachment...) instead or use setBodyContentType() method.

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

from - "from" address. If null, a default provided by cuba.email.fromAddress app property is used.

templatePath - path to a Freemarker template which is used to create the message body. The template is loaded through Resources in the core module.

templateParameters - map of parameters to be passed to the template

attachments - email attachments. Omit this parameter if there are no attachments.

EmailInfo

public EmailInfo(java.lang.String addresses,
                 java.lang.String caption,
                 @Nullable
                 java.lang.String from,
                 java.lang.String bodyContentType,
                 java.lang.String templatePath,
                 java.util.Map<java.lang.String,java.io.Serializable> templateParameters,
                 EmailAttachment... attachments)

Constructor. Example usage:

     EmailInfo emailInfo = new EmailInfo(
          "john.doe@company.com,jane.roe@company.com",
          "Company news",
          "do-not-reply@company.com",
          EmailInfo.HTML_CONTENT_TYPE,
          "com/company/sample/email_templates/news.txt",
          Collections.singletonMap("some_var", some_value)
     );
 

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

from - "from" address. If null, a default provided by cuba.email.fromAddress app property is used.

bodyContentType - email body like "text/plain; charset=UTF-8" or "text/html; charset=UTF-8", etc

templatePath - path to a Freemarker template which is used to create the message body. The template is loaded through Resources in the core module.

templateParameters - map of parameters to be passed to the template

attachments - email attachments. Omit this parameter if there are no attachments.

EmailInfo

public EmailInfo(java.lang.String addresses,
                 java.lang.String caption,
                 @Nullable
                 java.lang.String from,
                 java.lang.String body,
                 EmailAttachment... attachments)

Constructor.

     EmailInfo emailInfo = new EmailInfo(
          "john.doe@company.com,jane.roe@company.com",
          "Company news",
          null,
          "Some content"
     );
 

If you want to set content body type you can use EmailInfo(String, String, String, String, String, EmailAttachment...) instead or use setBodyContentType() method.

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

from - "from" address. If null, a default provided by cuba.email.fromAddress app property is used.

body - email body

attachments - email attachments. Omit this parameter if there are no attachments.

EmailInfo

public EmailInfo(java.lang.String addresses,
                 java.lang.String caption,
                 @Nullable
                 java.lang.String from,
                 java.lang.String body,
                 java.lang.String bodyContentType,
                 EmailAttachment... attachments)

Constructor.

     EmailInfo emailInfo = new EmailInfo(
          "john.doe@company.com,jane.roe@company.com",
          "Company news",
          null,
          "Some content",
          EmailInfo.TEXT_CONTENT_TYPE
     );
 

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

from - "from" address. If null, a default provided by cuba.email.fromAddress app property is used.

body - email body

bodyContentType - email body like "text/plain; charset=UTF-8" or "text/html; charset=UTF-8", etc

attachments - email attachments. Omit this parameter if there are no attachments.

EmailInfo

public EmailInfo(java.lang.String addresses,
                 java.lang.String caption,
                 java.lang.String body)

Constructor. The "from" address is taken from the cuba.email.fromAddress app property.

     EmailInfo emailInfo = new EmailInfo(
          "john.doe@company.com,jane.roe@company.com",
          "Company news",
          "Some content"
     );
 

If you want to set content body type you can use EmailInfo(String, String, String, String) instead or use setBodyContentType() method.

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

body - email body

EmailInfo

public EmailInfo(java.lang.String addresses,
                 java.lang.String caption,
                 java.lang.String body,
                 java.lang.String bodyContentType)

Constructor. The "from" address is taken from the cuba.email.fromAddress app property.

     EmailInfo emailInfo = new EmailInfo(
         "john.doe@company.com,jane.roe@company.com",
         "Company news",
         "Some content",
         EmailInfo.TEXT_CONTENT_TYPE"
     );
 

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

body - email body

bodyContentType - email body like "text/plain; charset=UTF-8" or "text/html; charset=UTF-8", etc

Method Detail

getAddresses

public java.lang.String getAddresses()

setAddresses

public void setAddresses(java.lang.String addresses)

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String caption)

getTemplatePath

public java.lang.String getTemplatePath()

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

getBody

public java.lang.String getBody()

setBody

public void setBody(java.lang.String body)

getAttachments

public EmailAttachment[] getAttachments()

setAttachments

public void setAttachments(EmailAttachment[] attachments)

getTemplateParameters

public java.util.Map<java.lang.String,java.io.Serializable> getTemplateParameters()

setTemplateParameters

public void setTemplateParameters(java.util.Map<java.lang.String,java.io.Serializable> templateParameters)

getFrom

public java.lang.String getFrom()

setFrom

public void setFrom(java.lang.String from)

getHeaders

public java.util.List<EmailHeader> getHeaders()

setHeaders

public void setHeaders(java.util.List<EmailHeader> headers)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

getBodyContentType

public java.lang.String getBodyContentType()

setBodyContentType

public void setBodyContentType(java.lang.String bodyContentType)