org.opencms.mail
Class CmsHtmlMail

java.lang.Object
  extended byorg.apache.commons.mail.Email
      extended byorg.apache.commons.mail.MultiPartEmail
          extended byorg.apache.commons.mail.HtmlEmail
              extended byorg.opencms.mail.CmsHtmlMail
Direct Known Subclasses:
A_CmsNotification

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

This class is used to send an HTML formatted email with optional attachments.

A text message can also be set for HTML unaware email clients, such as text-based email clients.

It uses the Apache Commons Email API and extends the provided classes to conveniently generate emails using the OpenCms configuration.

Since:
6.0.0
Version:
$Revision: 1.10 $
Author:
Andreas Zahner

Field Summary
 
Fields inherited from class org.apache.commons.mail.Email
ATTACHMENTS, charset, CONTENT_TYPE, EMAIL_BODY, EMAIL_SUBJECT, FILE_SERVER, ISO_8859_1, KOI8_R, MAIL_DEBUG, MAIL_HOST, MAIL_SMTP_AUTH, MAIL_SMTP_FROM, MAIL_TRANSPORT_PROTOCOL, message, RECEIVER_EMAIL, RECEIVER_NAME, SENDER_EMAIL, SENDER_NAME, SMTP, TEXT_HTML, TEXT_PLAIN, US_ASCII
 
Constructor Summary
CmsHtmlMail()
          Default constructor of a CmsHtmlMail.
 
Methods inherited from class org.apache.commons.mail.HtmlEmail
embed, isValid, send, setHtmlMsg, setMsg, setTextMsg
 
Methods inherited from class org.apache.commons.mail.MultiPartEmail
attach, attach, attach, attach, attach, getContainer, getPrimaryBodyPart
 
Methods inherited from class org.apache.commons.mail.Email
addBcc, addBcc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addTo, addTo, getSentDate, setAuthentication, setAuthenticator, setBcc, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setHeaders, setHostName, setSentDate, setSubject, setTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsHtmlMail

public CmsHtmlMail()
Default constructor of a CmsHtmlMail.

The mail host name and the mail from address are set to the OpenCms default values of the configuration.