org.apache.james.transport.mailets.listservcommands
Class UnSubscribe

java.lang.Object
  org.apache.james.transport.mailets.listservcommands.BaseCommand
      org.apache.james.transport.mailets.listservcommands.UnSubscribe

All Implemented Interfaces:

IListServCommand

public class UnSubscribe
extends BaseCommand

UnSubscribe handles the unsubscribe command. It is configured by:

<command name="unsubscribe" class="UnSubscribe"/>

It uses the formatted text-based resources for its return mail body:

• unsubscribe

After formatting the text, the message is delivered with BaseCommand.sendStandardReply(org.apache.mailet.Mail, java.lang.String, java.lang.String, java.lang.String) Note, prior to formatting and sending any text, the user is checked to see that they are currently subscribed to this list. If so, they will be sent a confirmation mail to be processed by UnSubscribeConfirm

Since:

2.2.0

Version:

CVS $Revision: 494012 $ $Date: 2007-01-08 10:23:58 +0000 (Mon, 08 Jan 2007) $

See Also:

UnSubscribeConfirm

Field Summary

protected XMLResources

xmlResources

Fields inherited from class org.apache.james.transport.mailets.listservcommands.BaseCommand

commandListservManager, commandName, configuration, mailetContext

Constructor Summary

UnSubscribe()

Method Summary

protected boolean	checkSubscriptionStatus(Mail mail) Checks to see that this user is already subscribed, if not return false and send a message
void	init(ICommandListservManager commandListservManager, org.apache.avalon.framework.configuration.Configuration configuration) Perform any required initialization
void	onCommand(Mail mail) After ensuring that the user is currently subscribed, confirmation mail will be sent to be processed by UnSubscribeConfirm.

Methods inherited from class org.apache.james.transport.mailets.listservcommands.BaseCommand

generateMail, getCommandListservManager, getCommandName, getConfiguration, getMailetContext, getStandardProperties, getUsersRepository, initXMLResources, log, log, sendStandardReply

Methods inherited from class java.lang.Object

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

Field Detail

xmlResources

protected XMLResources xmlResources

Constructor Detail

UnSubscribe

public UnSubscribe()

Method Detail

init

public void init(ICommandListservManager commandListservManager,
                 org.apache.avalon.framework.configuration.Configuration configuration)
          throws org.apache.avalon.framework.configuration.ConfigurationException

Description copied from class: BaseCommand

Perform any required initialization

Specified by:

init in interface IListServCommand

Overrides:

init in class BaseCommand

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

onCommand

public void onCommand(Mail mail)
               throws javax.mail.MessagingException

After ensuring that the user is currently subscribed, confirmation mail will be sent to be processed by UnSubscribeConfirm.

Parameters:

mail -

Throws:

javax.mail.MessagingException

checkSubscriptionStatus

protected boolean checkSubscriptionStatus(Mail mail)
                                   throws javax.mail.MessagingException

Checks to see that this user is already subscribed, if not return false and send a message

Parameters:

mail -

Returns:

false if the user isn't subscribed, true otherwise

Throws:

javax.mail.MessagingException