|
| |
|
| org.apache.cocoon.mail.MailContext
All known Subclasses: org.apache.cocoon.mail.MailContextHttpSession,
| MailContext | | public class MailContext extends DefaultContext implements LogEnabled(Code) | | Encapsulation of context info of this webmail application
author:
Bernhard Huber
since:
29 December 2002
version:
$Id: MailContext.java 468424 2006-10-27 15:44:53Z vgritsenko $ |
| MAIL_CURRENT_WORKING_COMMAND_ENTRY | | final public static String MAIL_CURRENT_WORKING_COMMAND_ENTRY(Code) | | Description of the Field
|
| MAIL_CURRENT_WORKING_FOLDER_ENTRY | | final public static String MAIL_CURRENT_WORKING_FOLDER_ENTRY(Code) | | Description of the Field
|
| MAIL_SESSION_ENTRY | | final public static String MAIL_SESSION_ENTRY(Code) | | Description of the Field
|
| MAIL_STORE_ENTRY | | final public static String MAIL_STORE_ENTRY(Code) | | Description of the Field
|
| SESSION_MAIL_CONTEXT | | final public static String SESSION_MAIL_CONTEXT(Code) | | attribute name of MailContext object in an application session, eg http-session
|
| MailContext | | MailContext(Context parent)(Code) | | Constructor for the MailContext object
Parameters:
parent - Description of the Parameter |
| canoncializeFoldername | | protected String canoncializeFoldername(String fn)(Code) | | Description of the Method
Parameters:
fn - Description of the Parameter Description of the Return Value |
| enableLogging | | public void enableLogging(Logger logger)(Code) | | Description of the Method
Parameters:
logger - Description of the Parameter |
| get | | public Object get(Object key) throws ContextException(Code) | | A specialization of the plain Context get method.
Implementing special key prefixes
- "param:key" get key from request parameters
- "param-integer:key" get key from request parameters, casting to Integer
- "param-folder:key" get key from request parameters, ie foldername, lookup
foldername using key "folder:foldername"
- key get key via plain context get method
Parameters:
key - Description of the Parameter Description of the Return Value
exception:
ContextException - Description of the Exception |
| getFolder | | public Object getFolder(String folderName) throws ContextException(Code) | | Gets the folder attribute of the MailContext object
Parameters:
folderName - Description of the Parameter The folder value
exception:
ContextException - Description of the Exception |
| getLogger | | protected Logger getLogger()(Code) | | Gets the logger attribute of the MailContext object
The logger value |
| getParameter | | protected String getParameter(String key)(Code) | | Gets the parameter attribute of the MailContext object
Parameters:
key - Description of the Parameter The parameter value |
| getParameterAsInteger | | protected Integer getParameterAsInteger(String key)(Code) | | Gets the parameterAsInteger attribute of the MailContext object
Parameters:
key - Description of the Parameter The parameterAsInteger value |
| getTheFolder | | public Folder getTheFolder(String entry) throws ContextException(Code) | | Gets the theFolder attribute of the MailContext object
Parameters:
entry - Description of the Parameter The theFolder value
exception:
ContextException - Description of the Exception |
| putFolder | | public void putFolder(Folder folder) throws ContextException(Code) | | put a folder in this MailContext object map
Parameters:
folder - Description of the Parameter
exception:
ContextException - Description of the Exception |
| putFolder | | public void putFolder(Folder[] folders) throws ContextException(Code) | | Description of the Method
Parameters:
folders - Description of the Parameter
exception:
ContextException - Description of the Exception |
| removeAllFolders | | public void removeAllFolders()(Code) | | remove all folders in this MailContext object
|
| removeStore | | public void removeStore()(Code) | | Remove and close Store of this MailContext, implicitly remove all folders, too.
|
| setRequest | | public void setRequest(Request request)(Code) | | Sets the request attribute of the MailContext object
Parameters:
request - The new request value |
|
|
|