Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mentawai >> [ mail overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mentawai.mail
Class HtmlEmail  

java.lang.Object
  org.mentawai.mail.Email
      org.mentawai.mail.MultiPartEmail
          org.mentawai.mail.HtmlEmail

---

public class HtmlEmail

extends MultiPartEmail

An HTML multipart email.

This class is used to send HTML formatted email. A text message can also be set for HTML unaware email clients, such as text-based email clients.

This class also inherits from MultiPartEmail, so it is easy to add attachents to the email.

To send an email in HTML, one should create a HtmlEmail, then use the setFrom, addTo, etc. methods. The HTML content can be set with the setHtmlMsg method. The alternate text content can be set with setTextMsg.

Either the text or HTML can be omitted, in which case the "main" part of the multipart becomes whichever is supplied rather than a multipart/alternative.

Version:

$Id: HtmlEmail.java,v 1.3 2005/07/29 21:23:16 soliveira Exp $

---

Field Summary
static int	CID_LENGTH           Defintion of the length of generated CID's
protected  java.lang.String	html           Html part of the message
protected  java.util.List	inlineImages           Embeded images
protected  java.lang.String	text           Text part of the message.

 

Fields inherited from class org.mentawai.mail.MultiPartEmail

 

Fields inherited from class org.mentawai.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_FROM, MAIL_TRANSPORT_PROTOCOL, message, popBeforeSmtp, popHost, popPassword, popUsername, RECEIVER_EMAIL, RECEIVER_NAME, replyList, SENDER_EMAIL, SENDER_NAME, sentDate, SMTP, smtpPort, subject, TEXT_HTML, TEXT_PLAIN, toList, US_ASCII

 

Constructor Summary

HtmlEmail()

 

Method Summary
private  void	buildAttachments()
private  void	buildNoAttachments()
java.lang.String	embed(java.net.URL url, java.lang.String name)           Embeds an URL in the HTML.
void	send()           Does the work of actually sending the email.
HtmlEmail	setHtmlMsg(java.lang.String aHtml)           Set the HTML content.
Email	setMsg(java.lang.String msg)           Set the message.
HtmlEmail	setTextMsg(java.lang.String aText)           Set the text content.

 

Methods inherited from class org.mentawai.mail.MultiPartEmail

addPart, addPart, addPart, attach, attach, attach, attach, attach, getContainer, getPrimaryBodyPart, getSubType, init, isBoolHasAttachments, setBoolHasAttachments, setSubType

 

Methods inherited from class org.mentawai.mail.Email

addBcc, addBcc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addTo, addTo, getMailSession, getSentDate, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setDefaultAuthentication, setDefaultBounceAddress, setDefaultCharset, setDefaultFrom, setDefaultHostName, setFrom, setFrom, setHeaders, setHostName, setMailSession, setPopBeforeSmtp, setSentDate, setSmtpPort, setSubject, setTo, toInternetAddressArray

 

Methods inherited from class java.lang.Object

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

 

Field Detail

CID_LENGTH

public static final int CID_LENGTH

Defintion of the length of generated CID's

See Also:

Constant Field Values

---

text

protected java.lang.String text

Text part of the message. This will be used as alternative text if the email client does not support HTML messages.

---

html

protected java.lang.String html

Html part of the message

---

inlineImages

protected java.util.List inlineImages

Embeded images

Constructor Detail

HtmlEmail

public HtmlEmail()

Method Detail

setTextMsg

public HtmlEmail setTextMsg(java.lang.String aText)
                     throws EmailException

Set the text content.

---

setHtmlMsg

public HtmlEmail setHtmlMsg(java.lang.String aHtml)
                     throws EmailException

Set the HTML content.

---

setMsg

public Email setMsg(java.lang.String msg)
             throws EmailException

Set the message.

This method overrides the MultiPartEmail setMsg() method in order to send an HTML message instead of a full text message in the mail body. The message is formatted in HTML for the HTML part of the message, it is let as is in the alternate text part.

Overrides:

setMsg in class MultiPartEmail

---

embed

public java.lang.String embed(java.net.URL url,
                              java.lang.String name)
                       throws EmailException

Embeds an URL in the HTML.

This method allows to embed a file located by an URL into the mail body. It allows, for instance, to add inline images to the email. Inline files may be referenced with a cid:xxxxxx URL, where xxxxxx is the Content-ID returned by the embed function.

Example of use:

 HtmlEmail he = new HtmlEmail();
 he.setHtmlMsg("<html><img src=cid:" +
  embed("file:/my/image.gif","image.gif") +
  "></html>");
 // code to set the others email fields (not shown)
 

---

send

public void send()
          throws EmailException

Does the work of actually sending the email.

Overrides:

send in class MultiPartEmail

---

buildAttachments

private void buildAttachments()
                       throws javax.mail.MessagingException,
                              EmailException

---

buildNoAttachments

private void buildNoAttachments()
                         throws javax.mail.MessagingException,
                                EmailException

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mentawai >> [ mail overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---