com.haulmont.cuba.core.app

Class EmailServiceBean

java.lang.Object

com.haulmont.cuba.core.app.EmailServiceBean

All Implemented Interfaces:

EmailService

@Service(value="cuba_EmailService")
public class EmailServiceBean
extends java.lang.Object
implements EmailService

Field Summary

Fields inherited from interface com.haulmont.cuba.core.app.EmailService

NAME

Constructor Summary

Constructors

Constructor and Description
EmailServiceBean()

Method Summary

Modifier and Type	Method and Description
boolean	isFileStorageUsed()
java.lang.String	loadContentText(SendingMessage sendingMessage) Load content text for given message.
void	sendEmail(EmailInfo info) Send email synchronously.
void	sendEmail(java.lang.String address, java.lang.String caption, java.lang.String body, EmailAttachment... attachment) Send email synchronously.
void	sendEmailAsync(EmailInfo info) Send email asynchronously.
void	sendEmailAsync(EmailInfo info, java.lang.Integer attemptsCount, java.util.Date deadline) Send email asynchronously, with limited number of attempts.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailServiceBean

public EmailServiceBean()

Method Detail

sendEmail

public void sendEmail(java.lang.String address,
                      java.lang.String caption,
                      java.lang.String body,
                      EmailAttachment... attachment)
               throws EmailException

Description copied from interface: EmailService

Send email synchronously.

Specified by:

sendEmail in interface EmailService

Parameters:

address - comma or semicolon separated list of addresses

caption - email subject

body - email body

attachment - email attachments

Throws:

EmailException - in case of any errors

sendEmail

public void sendEmail(EmailInfo info)
               throws EmailException

Description copied from interface: EmailService

Send email synchronously.

Specified by:

sendEmail in interface EmailService

Parameters:

info - email details

Throws:

EmailException - in case of any errors

sendEmailAsync

public void sendEmailAsync(EmailInfo info,
                           java.lang.Integer attemptsCount,
                           java.util.Date deadline)

Description copied from interface: EmailService

Send email asynchronously, with limited number of attempts.

The actual sending is performed by invoking the EmailerAPI.processQueuedEmails() (e.g. from a scheduled task).

Specified by:

sendEmailAsync in interface EmailService

Parameters:

info - email details

attemptsCount - count of attempts to send (1 attempt = 1 emailer cron tick)

deadline - Emailer tries to send message till deadline. If deadline has come and message has not been sent, status of this message is changed to SendingStatus.NOTSENT

sendEmailAsync

public void sendEmailAsync(EmailInfo info)

Description copied from interface: EmailService

Send email asynchronously.

The actual sending is performed by invoking the EmailerAPI.processQueuedEmails() (e.g. from a scheduled task).

Specified by:

sendEmailAsync in interface EmailService

Parameters:

info - email details

loadContentText

public java.lang.String loadContentText(SendingMessage sendingMessage)

Description copied from interface: EmailService

Load content text for given message.

Specified by:

loadContentText in interface EmailService

Returns:

email content text

isFileStorageUsed

public boolean isFileStorageUsed()

Specified by:

isFileStorageUsed in interface EmailService

Returns:

true if email body text and attachments are stored in file storage instead of BLOB columns in database