co.ecg.alpaca.toolkit.helper.report.email

Class AlpacaEmail

java.lang.Object

org.apache.commons.mail.Email

org.apache.commons.mail.MultiPartEmail

org.apache.commons.mail.HtmlEmail

co.ecg.alpaca.toolkit.helper.report.email.AlpacaEmail

public class AlpacaEmail
extends org.apache.commons.mail.HtmlEmail

Controls the sending of Alpaca Events via Email Created on: Sep 21, 2015

Author:

Matthew Keathley - support@e-c-grouP.EmailProperties.com

Field Summary

Fields inherited from class org.apache.commons.mail.HtmlEmail

CID_LENGTH, html, inlineEmbeds, inlineImages, text

Fields inherited from class org.apache.commons.mail.Email

ATTACHMENTS, authenticator, bccList, bounceAddress, ccList, charset, content, CONTENT_TYPE, contentType, debug, EMAIL_BODY, EMAIL_SUBJECT, emailBody, FILE_SERVER, fromAddress, headers, hostName, ISO_8859_1, KOI8_R, MAIL_DEBUG, MAIL_HOST, MAIL_PORT, MAIL_SMTP_AUTH, MAIL_SMTP_CONNECTIONTIMEOUT, MAIL_SMTP_FROM, MAIL_SMTP_PASSWORD, MAIL_SMTP_SOCKET_FACTORY_CLASS, MAIL_SMTP_SOCKET_FACTORY_FALLBACK, MAIL_SMTP_SOCKET_FACTORY_PORT, MAIL_SMTP_TIMEOUT, MAIL_SMTP_USER, MAIL_TRANSPORT_PROTOCOL, MAIL_TRANSPORT_TLS, message, popBeforeSmtp, popHost, popPassword, popUsername, RECEIVER_EMAIL, RECEIVER_NAME, replyList, SENDER_EMAIL, SENDER_NAME, sentDate, SMTP, smtpPort, socketConnectionTimeout, socketTimeout, ssl, sslSmtpPort, subject, TEXT_HTML, TEXT_PLAIN, tls, toList, US_ASCII

Constructor Summary

Constructors

Constructor and Description
AlpacaEmail() Creates a new AlpacaEmail

Method Summary

Modifier and Type	Method and Description
static void	emailUserEvent(User user, EmailEvent event, String template) Sends an Email Event that is associated with the given User.
static List<ToAddress>	getToAddressList() Returns the list of ToAddress objects as defined in the Alpaca Configuration.
org.apache.commons.mail.Email	setSubject(String subject) Creates the subject line for the email
void	setToAddressesForUser(User user) Sets the Email ToAddresses for a given user using the dynamic configuration

Methods inherited from class org.apache.commons.mail.HtmlEmail

buildMimeMessage, embed, embed, embed, embed, embed, embed, setHtmlMsg, setMsg, setTextMsg

Methods inherited from class org.apache.commons.mail.MultiPartEmail

addPart, addPart, addPart, attach, attach, attach, attach, attach, attach, createBodyPart, createMimeMultipart, getContainer, getPrimaryBodyPart, getSubType, init, isBoolHasAttachments, isInitialized, setBoolHasAttachments, setInitialized, setSubType

Methods inherited from class org.apache.commons.mail.Email

addBcc, addBcc, addBcc, addBcc, addCc, addCc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, addTo, createMimeMessage, getBccAddresses, getBounceAddress, getCcAddresses, getFromAddress, getHostName, getMailSession, getMimeMessage, getReplyToAddresses, getSentDate, getSmtpPort, getSocketConnectionTimeout, getSocketTimeout, getSslSmtpPort, getSubject, getToAddresses, isSendPartial, isSSL, isSSLCheckServerIdentity, isSSLOnConnect, isStartTLSEnabled, isStartTLSRequired, isTLS, send, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setFrom, setHeaders, setHostName, setMailSession, setMailSessionFromJNDI, setPopBeforeSmtp, setReplyTo, setSendPartial, setSentDate, setSmtpPort, setSocketConnectionTimeout, setSocketTimeout, setSSL, setSSLCheckServerIdentity, setSSLOnConnect, setSslSmtpPort, setStartTLSEnabled, setStartTLSRequired, setTLS, setTo, toInternetAddressArray, updateContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

AlpacaEmail

public AlpacaEmail()
            throws org.apache.commons.mail.EmailException

Creates a new AlpacaEmail

Throws:

org.apache.commons.mail.EmailException - Thrown if the from address fails to be set

Method Detail

emailUserEvent

public static void emailUserEvent(User user,
                                  EmailEvent event,
                                  String template)
                           throws org.apache.commons.mail.EmailException

Sends an Email Event that is associated with the given User. This email is formatted as defined in the properties template configuration for a UserEvent.

Parameters:

user - The user associated with the event.

event - The email event that contains the message to be sent.

template - The email template to use. Can be left NULL to use the default template.

Throws:

org.apache.commons.mail.EmailException - Thrown if an error occurs while sending the email

getToAddressList

public static List<ToAddress> getToAddressList()

Returns the list of ToAddress objects as defined in the Alpaca Configuration.

Returns:

The available list of ToAddress values.

setSubject

public org.apache.commons.mail.Email setSubject(String subject)

Creates the subject line for the email

Overrides:

setSubject in class org.apache.commons.mail.Email

Returns:

The resulting Email

setToAddressesForUser

public void setToAddressesForUser(User user)
                           throws org.apache.commons.mail.EmailException

Sets the Email ToAddresses for a given user using the dynamic configuration

Parameters:

user - The user to set ToAddresses for

Throws:

org.apache.commons.mail.EmailException - Thrown if an error occurs while setting the to address.