org.adroitlogic.ultraesb.api.mediation

Interface EmailSupport

public interface EmailSupport

Email transport related operations

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
void	addBCCAddress(Message msg, java.lang.String email) Adds a BCC email address to the given message to be used when sending the message out via the email transport
void	addBCCAddresses(Message msg, java.util.List emails) Adds a list of BCC email addresses to the given message to be used when sending out via email transport
void	addCCAddress(Message msg, java.lang.String email) Adds a CC email address to the given message to be used when sending out via email transport
void	addCCAddresses(Message msg, java.util.List emails) Adds a list of CC email addresses to the given message to be used when sending out via email transport
void	setFromAddress(Message msg, java.lang.String email) Sets the SMTP from address for the given message to be used in sending the message out via the email transport
void	setSMTPCredentials(Message msg, java.lang.String user, java.lang.String password) Sets and overrides any already defined SMTP credentials to the given message to be used in sending the message out via the SMTP transport
void	setSubject(Message msg, java.lang.String subject) Sets the email subject for the outgoing message via the email transport

Method Detail

setSubject

void setSubject(Message msg,
              java.lang.String subject)

Sets the email subject for the outgoing message via the email transport

Parameters:

msg - the message to which the subject to be set

subject - the subject to be set for the given message

addCCAddress

void addCCAddress(Message msg,
                java.lang.String email)

Adds a CC email address to the given message to be used when sending out via email transport

Parameters:

msg - the message to add the CC email address

email - the email address to be added to the CC list

addCCAddresses

void addCCAddresses(Message msg,
                  java.util.List emails)

Adds a list of CC email addresses to the given message to be used when sending out via email transport

Parameters:

msg - the message to add the CC email addresses

emails - the email addresses list to be added to the CC list

addBCCAddress

void addBCCAddress(Message msg,
                 java.lang.String email)

Adds a BCC email address to the given message to be used when sending the message out via the email transport

Parameters:

msg - the message to add the BCC email address

email - the email address to be added to the BCC list

addBCCAddresses

void addBCCAddresses(Message msg,
                   java.util.List emails)

Adds a list of BCC email addresses to the given message to be used when sending out via email transport

Parameters:

msg - the message to add the BCC email addresses

emails - the email addresses list to be added to the BCC list

setFromAddress

void setFromAddress(Message msg,
                  java.lang.String email)

Sets the SMTP from address for the given message to be used in sending the message out via the email transport

Parameters:

msg - the message to which the given from address will be set

email - the from email address to be set to the message

setSMTPCredentials

void setSMTPCredentials(Message msg,
                      java.lang.String user,
                      java.lang.String password)

Sets and overrides any already defined SMTP credentials to the given message to be used in sending the message out via the SMTP transport

Parameters:

msg - the message to which the SMTP credentials are set

user - the SMTP user to be used in sending out the message

password - the SMTP authentication password to be used in sending the message out