org.apache.james.transport.mailets
Class AddFooter

java.lang.Object
  extended by org.apache.mailet.GenericMailet
      extended by org.apache.james.transport.mailets.AbstractAddFooter
          extended by org.apache.james.transport.mailets.AddFooter
All Implemented Interfaces:
Mailet, MailetConfig

public class AddFooter
extends AbstractAddFooter

This mailet will attach text to the end of the message (like a footer). Right now it only supports simple messages without multiple parts.


Constructor Summary
AddFooter()
           
 
Method Summary
 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()
          Return a string describing this mailet.
 void init()
          Initialize the mailet
 
Methods inherited from class org.apache.james.transport.mailets.AbstractAddFooter
addToHTML, addToText, attachFooter, service
 
Methods inherited from class org.apache.mailet.GenericMailet
destroy, getInitParameter, getInitParameter, getInitParameterNames, getMailetConfig, getMailetContext, getMailetName, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddFooter

public AddFooter()
Method Detail

init

public void init()
          throws javax.mail.MessagingException
Initialize the mailet

Overrides:
init in class GenericMailet
Throws:
javax.mail.MessagingException - if an exception occurs that interrupts the mailet's normal operation

getFooterText

public java.lang.String getFooterText()
This is exposed as a method for easy subclassing to provide alternate ways to get the footer text.

Specified by:
getFooterText in class AbstractAddFooter
Returns:
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.

Specified by:
getFooterHTML in class AbstractAddFooter
Returns:
the HTML version of the footer text

getMailetInfo

public java.lang.String getMailetInfo()
Return a string describing this mailet.

Specified by:
getMailetInfo in interface Mailet
Overrides:
getMailetInfo in class GenericMailet
Returns:
a string describing this mailet


Copyright ? 2002-2009 The Apache Software Foundation. All Rights Reserved.