org.apache.james.transport.mailets
Class AddFooter
java.lang.Object
|
+--org.apache.mailet.GenericMailet
|
+--org.apache.james.transport.mailets.AddFooter
- All Implemented Interfaces:
- Mailet, MailetConfig
- public class AddFooter
- extends GenericMailet
This mailet will attach text to the end of the message (like a footer). Right
now it only supports simple messages without multiple parts.
Method Summary |
protected void |
addToHTML(javax.mail.internet.MimePart part)
|
protected void |
addToText(javax.mail.internet.MimePart part)
|
protected void |
attachFooter(javax.mail.internet.MimePart part)
|
java.lang.String |
getFooterHTML()
This is exposed as a method for easy subclassing to provide alternate ways
to get the footer text. |
java.lang.String |
getFooterText()
This is exposed as a method for easy subclassing to provide alternate ways
to get the footer text. |
java.lang.String |
getMailetInfo()
Returns information about the mailet, such as author, version, and
copyright. |
void |
init()
A convenience method which can be overridden so that there's no
need to call super.init(config). |
void |
service(Mail mail)
Takes the message and attaches a footer message to it. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AddFooter
public AddFooter()
init
public void init()
throws javax.mail.MessagingException
- Description copied from class:
GenericMailet
- A convenience method which can be overridden so that there's no
need to call super.init(config).
Instead of overriding init(MailetConfig), simply override this
method and it will be called by GenericMailet.init(MailetConfig config).
The MailetConfig object can still be retrieved via getMailetConfig().
- Overrides:
init
in class GenericMailet
- Following copied from class:
org.apache.mailet.GenericMailet
- Throws:
javax.mail.MessagingException
- if an exception occurs that interrupts the mailet's normal operation
service
public void service(Mail mail)
throws javax.mail.MessagingException
- Takes the message and attaches a footer message to it. Right now, it only
supports simple messages. Needs to have additions to make it support
messages with alternate content types or with attachments.
- Overrides:
service
in class GenericMailet
- Following copied from class:
org.apache.mailet.GenericMailet
- Parameters:
mail
- - the Mail object that contains the MimeMessage and
routing information- Throws:
javax.mail.MessagingException
- - if an exception occurs that interferes with the mailet's normal operation
occurred
getFooterText
public java.lang.String getFooterText()
- This is exposed as a method for easy subclassing to provide alternate ways
to get the footer text.
getFooterHTML
public java.lang.String getFooterHTML()
- This is exposed as a method for easy subclassing to provide alternate ways
to get the footer text. By default, this will take the footer text,
converting the linefeeds to <br> tags.
getMailetInfo
public java.lang.String getMailetInfo()
- Description copied from class:
GenericMailet
- Returns information about the mailet, such as author, version, and
copyright. By default, this method returns an empty string. Override
this method to have it return a meaningful value.
- Overrides:
getMailetInfo
in class GenericMailet
- Following copied from class:
org.apache.mailet.GenericMailet
- Returns:
- String information about this mailet, by default an empty string
addToText
protected void addToText(javax.mail.internet.MimePart part)
throws javax.mail.MessagingException,
java.io.IOException
addToHTML
protected void addToHTML(javax.mail.internet.MimePart part)
throws javax.mail.MessagingException,
java.io.IOException
attachFooter
protected void attachFooter(javax.mail.internet.MimePart part)
throws javax.mail.MessagingException,
java.io.IOException
Copyright © 2001 Apache Jakarta Project. All Rights Reserved.