com.haulmont.cuba.core.global

Class EmailInfoBuilder

java.lang.Object

com.haulmont.cuba.core.global.EmailInfoBuilder

@Component(value="cuba_EmailInfoBuilder")
 @Scope(value="prototype")
public class EmailInfoBuilder
extends java.lang.Object

EmailInfo builder.

Use setters to provide parameters and then invoke the build method to obtain the EmailInfo instance.

Sample usage:

 EmailInfo emailInfo = EmailInfoBuilder.create()
               .setAddresses(addresses)
               .setCaption("Email subject")
               .setBody("Some email body")
               .build();

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
EmailInfoBuilder() INTERNAL
EmailInfoBuilder(java.lang.String addresses, java.lang.String caption, java.lang.String body) INTERNAL

Method Summary

Modifier and Type	Method and Description
EmailInfoBuilder	addAttachment(EmailAttachment attachment)
EmailInfoBuilder	addHeader(EmailHeader header)
EmailInfoBuilder	addTemplateParameter(java.lang.String name, java.io.Serializable value)
EmailInfo	build()
static EmailInfoBuilder	create() EmailInfo emailInfo = EmailInfo.create() .setAddresses("john.doe@company.com,jane.roe@company.com") .setCaption("Company news") .setBody("Some content") .build();
static EmailInfoBuilder	create(java.lang.String addresses, java.lang.String caption, java.lang.String body) EmailInfo emailInfo = EmailInfo.create("john.doe@company.com,jane.roe@company.com", "Company news", "Some content").build();
java.lang.String	getAddresses()
EmailAttachment[]	getAttachments()
java.lang.String	getBcc()
java.lang.String	getBody()
java.lang.String	getBodyContentType()
java.lang.String	getCaption()
java.lang.String	getCc()
java.lang.String	getFrom()
java.util.List<EmailHeader>	getHeaders()
java.util.Map<java.lang.String,java.io.Serializable>	getTemplateParameters()
java.lang.String	getTemplatePath()
boolean	isSendInOneMessage()
EmailInfoBuilder	setAddresses(java.lang.String addresses)
EmailInfoBuilder	setAttachments(EmailAttachment... attachments)
EmailInfoBuilder	setBcc(java.lang.String bcc) Result of this method call (i.e., setting addresses of the email BCC field) is ignored during the message creation if isSendInOneMessage() returns false (default behaviour), because, in this case, the message is generated for each of the recipients separately.
EmailInfoBuilder	setBody(java.lang.String body)
EmailInfoBuilder	setBodyContentType(java.lang.String bodyContentType)
EmailInfoBuilder	setCaption(java.lang.String caption)
EmailInfoBuilder	setCc(java.lang.String cc) Result of this method call (i.e., setting addresses of the email CC field) is ignored during the message creation if isSendInOneMessage() returns false (default behaviour), because, in this case, the message is generated for each of the recipients separately.
EmailInfoBuilder	setFrom(java.lang.String from)
EmailInfoBuilder	setHeaders(java.util.List<EmailHeader> headers)
EmailInfoBuilder	setSendInOneMessage(boolean sendInOneMessage) Flag sendInOneMessage is for backward compatibility with previous CUBA versions.
EmailInfoBuilder	setTemplateParameters(java.util.Map<java.lang.String,java.io.Serializable> templateParameters)
EmailInfoBuilder	setTemplatePath(java.lang.String templatePath)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

EmailInfoBuilder

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

INTERNAL

EmailInfoBuilder

public EmailInfoBuilder()

INTERNAL

Method Detail

create

public static EmailInfoBuilder create()

     EmailInfo emailInfo = EmailInfo.create()
          .setAddresses("john.doe@company.com,jane.roe@company.com")
          .setCaption("Company news")
          .setBody("Some content")
          .build();
 

create

public static EmailInfoBuilder create(java.lang.String addresses,
                                      java.lang.String caption,
                                      java.lang.String body)

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

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

body - email body

setAddresses

public EmailInfoBuilder setAddresses(java.lang.String addresses)

Parameters:

addresses - Recipient email addresses separated with "," or ";" symbol.

getAddresses

public java.lang.String getAddresses()

getCc

public java.lang.String getCc()

setCc

public EmailInfoBuilder setCc(java.lang.String cc)

Result of this method call (i.e., setting addresses of the email CC field) is ignored during the message creation if isSendInOneMessage() returns false (default behaviour), because, in this case, the message is generated for each of the recipients separately.

getBcc

public java.lang.String getBcc()

setBcc

public EmailInfoBuilder setBcc(java.lang.String bcc)

Result of this method call (i.e., setting addresses of the email BCC field) is ignored during the message creation if isSendInOneMessage() returns false (default behaviour), because, in this case, the message is generated for each of the recipients separately.

isSendInOneMessage

public boolean isSendInOneMessage()

setSendInOneMessage

public EmailInfoBuilder setSendInOneMessage(boolean sendInOneMessage)

Flag sendInOneMessage is for backward compatibility with previous CUBA versions. If sendInOneMessage = true then one message will be sent for all recipients and it will include CC and BCC. Otherwise CC and BCC are ignored and multiple messages by the number of recipients in addresses will be sent.

getCaption

public java.lang.String getCaption()

setCaption

public EmailInfoBuilder setCaption(java.lang.String caption)

Parameters:

caption - email subject

getFrom

public java.lang.String getFrom()

setFrom

public EmailInfoBuilder setFrom(java.lang.String from)

Parameters:

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

getTemplatePath

public java.lang.String getTemplatePath()

setTemplatePath

public EmailInfoBuilder setTemplatePath(java.lang.String templatePath)

Parameters:

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

getTemplateParameters

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

setTemplateParameters

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

Parameters:

templateParameters - map of parameters to be passed to the template

addTemplateParameter

public EmailInfoBuilder addTemplateParameter(java.lang.String name,
                                             java.io.Serializable value)

getBody

public java.lang.String getBody()

setBody

public EmailInfoBuilder setBody(java.lang.String body)

Parameters:

body - email body

getBodyContentType

public java.lang.String getBodyContentType()

setBodyContentType

public EmailInfoBuilder setBodyContentType(java.lang.String bodyContentType)

Parameters:

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

getAttachments

public EmailAttachment[] getAttachments()

setAttachments

public EmailInfoBuilder setAttachments(EmailAttachment... attachments)

Parameters:

attachments - email attachments

addAttachment

public EmailInfoBuilder addAttachment(EmailAttachment attachment)

getHeaders

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

setHeaders

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

addHeader

public EmailInfoBuilder addHeader(EmailHeader header)

build

public EmailInfo build()