org.apache.cocoon.mail
Class MailCommandManager

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.mail.MailCommandManager

public class MailCommandManager
extends org.apache.cocoon.util.AbstractLogEnabled

Manage invocation of mail commands.

Since:
23 October 2002
Version:
$Id: MailCommandManager.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Nested Class Summary
static class MailCommandManager.MailCatAttachmentMessageByIdCommand
          Retrieved a message part by its part id, specifying the message by id, put retrieved part as command result.
static class MailCommandManager.MailCatMessageByIdCommand
          Retrieved a message (envelope plus content) of a folder by its id, put retrieved message as command result.
static class MailCommandManager.MailCatMessageByUIDCommand
          Retrieved a message (envelope plus content) of a folder by its uid, put retrieved message as command result.
static class MailCommandManager.MailFolderCatCommand
          Retrieve folder, and put it as command result.
static class MailCommandManager.MailListFolderCommand
          List all subfolders of a folder, put all retrieved folders as command result.
static class MailCommandManager.MailListMessagesCommand
          Retrieved headers of all messages of a folder, put retrieved messages as command result.
static class MailCommandManager.MailRefreshFolderCommand
          Retrieve folder, and put it as command result.
static class MailCommandManager.MailSearchMessagesCommand
          Description of the Class
 
Field Summary
static String CONTEXT_FOLDER_ENTRY
          Context key specifying the foldername.
static String CONTEXT_FOLDER_PATTERN_ENTRY
          Description of the Field
static String CONTEXT_ID_ENTRY
          Description of the Field
static String CONTEXT_MAX_FOLDER_LEVEL_ENTRY
          Description of the Field
static String CONTEXT_PARTID_ENTRY
          Description of the Field
static String CONTEXT_UID_ENTRY
          Description of the Field
static String DEFAULT_FOLDER_NAME
          Description of the Field
static String DEFAULT_FOLDER_PATTERN
          Description of the Field
 
Constructor Summary
MailCommandManager()
          Creates a new instance of MailHeaderList
 
Method Summary
static void closeFolder(Folder f)
          Close a javamail folder
static void closeStore(Store s)
          Close a javamail store
 List execute(AbstractMailCommand amfa)
          Description of the Method
 List execute(List aList)
          Description of the Method
static void openFolder(Folder f, int mode)
          Open a javamail folder
static void openStore(Store s)
          Open a javamail store
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_FOLDER_NAME

public static final String DEFAULT_FOLDER_NAME
Description of the Field

See Also:
Constant Field Values

DEFAULT_FOLDER_PATTERN

public static final String DEFAULT_FOLDER_PATTERN
Description of the Field

See Also:
Constant Field Values

CONTEXT_FOLDER_ENTRY

public static final String CONTEXT_FOLDER_ENTRY
Context key specifying the foldername.

See Also:
Constant Field Values

CONTEXT_UID_ENTRY

public static final String CONTEXT_UID_ENTRY
Description of the Field

See Also:
Constant Field Values

CONTEXT_ID_ENTRY

public static final String CONTEXT_ID_ENTRY
Description of the Field

See Also:
Constant Field Values

CONTEXT_PARTID_ENTRY

public static final String CONTEXT_PARTID_ENTRY
Description of the Field

See Also:
Constant Field Values

CONTEXT_FOLDER_PATTERN_ENTRY

public static final String CONTEXT_FOLDER_PATTERN_ENTRY
Description of the Field

See Also:
Constant Field Values

CONTEXT_MAX_FOLDER_LEVEL_ENTRY

public static final String CONTEXT_MAX_FOLDER_LEVEL_ENTRY
Description of the Field

See Also:
Constant Field Values
Constructor Detail

MailCommandManager

public MailCommandManager()
Creates a new instance of MailHeaderList

Method Detail

openFolder

public static void openFolder(Folder f,
                              int mode)
                       throws MessagingException
Open a javamail folder

Parameters:
f - Description of the Parameter
mode - folder opening mode, use Folder.READ_WRITE, or Folder.READ_ONLY
Throws:
MessagingException - Description of the Exception

closeFolder

public static void closeFolder(Folder f)
                        throws MessagingException
Close a javamail folder

Parameters:
f - Description of the Parameter
Throws:
MessagingException - Description of the Exception

openStore

public static void openStore(Store s)
                      throws MessagingException
Open a javamail store

Parameters:
s - Description of the Parameter
Throws:
MessagingException - Description of the Exception

closeStore

public static void closeStore(Store s)
                       throws MessagingException
Close a javamail store

Parameters:
s - Description of the Parameter
Throws:
MessagingException - Description of the Exception

execute

public List execute(List aList)
Description of the Method

Parameters:
aList - Description of the Parameter
Returns:
Description of the Return Value

execute

public List execute(AbstractMailCommand amfa)
Description of the Method

Parameters:
amfa - Description of the Parameter
Returns:
Description of the Return Value


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.