com.haulmont.cuba.core.app

Interface EmailService

All Known Implementing Classes:

EmailServiceBean

public interface EmailService

Service for sending emails.

Field Summary

Fields

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

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) Deprecated.
void	sendEmail(java.lang.String address, java.lang.String caption, java.lang.String body, java.lang.String bodyContentType, 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.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

sendEmail

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

Deprecated.

Use sendEmail(String, String, String, String, EmailAttachment...) instead.

Send email synchronously.

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

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

Send email synchronously.

Parameters:

address - 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

attachment - email attachments

Throws:

EmailException - in case of any errors

sendEmail

void sendEmail(EmailInfo info)
        throws EmailException

Send email synchronously.

Parameters:

info - email details

Throws:

EmailException - in case of any errors

sendEmailAsync

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

Send email asynchronously, with limited number of attempts.

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

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

void sendEmailAsync(EmailInfo info)

Send email asynchronously.

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

Parameters:

info - email details

loadContentText

java.lang.String loadContentText(SendingMessage sendingMessage)

Load content text for given message.

Returns:

email content text

isFileStorageUsed

boolean isFileStorageUsed()

Returns:

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