com.elasticpath.commons.util
Interface Mailer

All Known Implementing Classes:
MailerImpl

public interface Mailer

Provides the ability to send emails to a given email host.


Method Summary
 void sendEmail()
          Send a text email.
 void sendHtmlEmail()
          Send an html email.
 Mailer setAddressBCC(java.lang.String addressBCC)
          Setter for property addressBCC.
 Mailer setAddressCC(java.lang.String addressCC)
          Setter for property addressCC.
 Mailer setAddressFrom(java.lang.String addressFrom)
          Setter for property addressFrom.
 Mailer setAddressTo(java.lang.String addressTo)
          Setter for property addressTo.
 Mailer setBody(java.lang.String body)
          Setter for property body.
 Mailer setBodyHtml(java.lang.String bodyHtml)
          Setter for property html body.
 Mailer setFromName(java.lang.String fromName)
          Setter for property from name.
 Mailer setMailHost(java.lang.String mailHost)
          Setter for property mail host.
 Mailer setMailPort(java.lang.String mailPort)
          Setter for property mail port.
 Mailer setReturnPath(java.lang.String returnPath)
          Setter for property return path.
 Mailer setSubject(java.lang.String subject)
          Setter for property subject.
 Mailer setToName(java.lang.String toName)
          Setter for property to name.
 

Method Detail

sendEmail

void sendEmail()
               throws EpSystemException
Send a text email.

Throws:
EpSystemException - on failure

sendHtmlEmail

void sendHtmlEmail()
                   throws EpSystemException
Send an html email.

Throws:
EpSystemException - on failure

setAddressBCC

Mailer setAddressBCC(java.lang.String addressBCC)
Setter for property addressBCC.

Parameters:
addressBCC - New value of property addressBCC
Returns:
the mailer itself

setAddressCC

Mailer setAddressCC(java.lang.String addressCC)
Setter for property addressCC.

Parameters:
addressCC - New value of property addressCC.
Returns:
the mailer itself

setAddressFrom

Mailer setAddressFrom(java.lang.String addressFrom)
Setter for property addressFrom.

Parameters:
addressFrom - New value of property addressFrom.
Returns:
the mailer itself

setAddressTo

Mailer setAddressTo(java.lang.String addressTo)
Setter for property addressTo.

Parameters:
addressTo - New value of property addressTo
Returns:
the mailer itself

setBody

Mailer setBody(java.lang.String body)
Setter for property body.

Parameters:
body - New value of property body.
Returns:
the mailer itself

setBodyHtml

Mailer setBodyHtml(java.lang.String bodyHtml)
Setter for property html body.

Parameters:
bodyHtml - New value of property html body.
Returns:
the mailer itself

setFromName

Mailer setFromName(java.lang.String fromName)
Setter for property from name.

Parameters:
fromName - body New value of property from name.
Returns:
the mailer itself

setMailHost

Mailer setMailHost(java.lang.String mailHost)
Setter for property mail host.

Parameters:
mailHost - body New value of property mail host.
Returns:
the mailer itself

setMailPort

Mailer setMailPort(java.lang.String mailPort)
Setter for property mail port.

Parameters:
mailPort - New value of property mail port.
Returns:
the mailer itself

setReturnPath

Mailer setReturnPath(java.lang.String returnPath)
Setter for property return path.

Parameters:
returnPath - body New value of property return path.
Returns:
the mailer itself

setSubject

Mailer setSubject(java.lang.String subject)
Setter for property subject.

Parameters:
subject - New value of property subject.
Returns:
the mailer itself

setToName

Mailer setToName(java.lang.String toName)
Setter for property to name.

Parameters:
toName - body New value of property to name.
Returns:
the mailer itself