Contact |
Copyright (C) by FooBar |
Disclaimer |
All rights reserved
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/head-col-1/index.xml
Index: index.xml
===================================================================
Top Index
Here you will find a list of available commands, as soon as you login.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/head-col-1/index.xsp
Index: index.xsp
===================================================================
Top Index
Here you will find a list of available commands, as soon as you login.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/head-col-1/mail.xsp
Index: mail.xsp
===================================================================
Index
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-1/mail.xml
Index: mail.xml
===================================================================
Index
FolderList
a list of available folders, starting from root
or relative to current folder
Folder
some folder infos....
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-1/mail.xsp
Index: mail.xsp
===================================================================
Status
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/about.xml
Index: about.xml
===================================================================
About
This site is for demonstrating cool features of
Cocoon.
Especially demonstrating JavaMail access using Cocoon.
Thanks to
Apache Community for support.
A List Apart for their cool webdesign tips.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/asciiart-generator.xml
Index: asciiart-generator.xml
===================================================================
AsciiArtSVGGenerator in Cocoon0.9Technical documentThis document describes the AsciiArtSVGGenerator of Cocoon.
NAME
asciiart-svg
WHAT
The AsciiArtSVGGenerator component is used
to serve ascii art text as SVGserve data.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/extendedresourceexists-action.xml
Index: extendedresourceexists-action.xml
===================================================================
ExtendedResourceExistsAction in Cocoon0.9Technical documentThis document describes the ExtendedResourceExistsAction of Cocoon.
NAME
extended-resource-exists
WHAT
The ExtendedResourceExistsAction component is used
to detect existance of a resource.
The ExtendedResourceExistsAction checks the existance of a resource.
If the resource exists a sitemap parameter to true,
otherwise to false.
The ExtendedResourceExistsAction is used to control the sitemap
processing depending on the existance of a resource.
A use case of ExtendedResourceExistsAction is serving default
pages, in case of non-existance of a page.
The snippet below uses ExtendedResourceExistsAction
serving the document docs/index.html if the
requested document does not exist.
The snippet below presents the basic usage of ExtendedResourceExistsAction.
Note that ExtendedResourceExistsAction creates an
objectMap having exactly on entry named resource-exists. This entry
may have value true, or false.
Thus accessing the wildcard result use {../1}, instead of the
simple {1}.
The snippet below confiures the ExtendedResourceExistsAction
component in the sitemap's components section.
The ExtendedResourceExistsAction has no configurational options.
Setting up the ExtendedResourceExistsAction needs
only specifying the resource by setting the src attribute
of the <map:act> element. This way
ExtendedResourceExistsAction knows what resource to test
for existance.
The ExtendedResourceExistsAction accepts optionally a the
sitemap parameter url, overriding the value presented
by the src attribute.
The ExtendedResourceExistsAction creates alway an
objectMap table, and always sets an resource-exists
entry in this table.
The entry name resource-exists of the objectMap table entry
is fixed, it is not configurable.
The ExtendedResourceExistsAction checks the existance of a resource
by resolving the name of the resource, and trying to get an InputStream
of this resource, accessing remote resources may take some time before
it is obvious that the resource is, or is not available.
01-05-02: initial creation
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Cocoon has already an ResourceExistsAction. This action
creates an objectMap, only in case of resource existance.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/howto-cocoon-webmail.xml
Index: howto-cocoon-webmail.xml
===================================================================
How to use Cocoon WebMail Site0.9Technical documentThis document describes Cocoon WebMail.
This document describes the Cocoon WebMail Site.
The overview section describes the URI space, layout and
resource mapping used by
Cocoon WebMail Site.
The next sections describes the Cocoon sitemap components
used in the Cocoon WebMail Site.
The target audience of this document are sitemap designer, and
developers interested in setting up a Cocoon WebMail Site.
The URI space has following structure, root denotes the root
of this URI space.
As you may figure out *.html serves static document pages,
mail/mail.html, and mail/logout.html serves dynamic Cocoon Webmail pages.
All other resources are static, like images, cascaded stylesheet, and icons.
The asciiart/*.jpg are jpg resource created from simple ascii art text.
The document pages all have the format *.html,
eg. index.html, or howto-cocoon-webmail.html.
The dynamic Cocoon Webmail pages all have the format mail/*.html,
eg. mail/maill.html, or mail/logout.html.
The visible layout of Cocoon Webmail Site is a simple multi column
layout.
The sections contain following piece of information
The header section displays the Cocoon Webmail banner;
the top section is empty for document pages, for
dynamic pages it contains a list of available commands.
The col1 section presents auxilliary information.
The col2 section contains for document pages the document content;
for dynamic pages it presents the content of an executed command,
like a list of mail folders, a list of messages, the content of a message.
The col3 section presents additional links.
Finally the bottom section displays the Cocoon Webmail footer.
For the sake of flexibilty a page requested by an URI is aggregated.
The aggregation parts are located in the resource section directories.
The column layout is realized by using positioning features of CSS. Each aggregation
part is wrapped by an <div> which has CSS positional settings for placing
it some concrete page position.
The Cocoon Webmail Site uses following directory structure
on the filesystem:
As you can figure out each layout section is mapped to a directory. Each of these
directories contains the documents of one section.
Thus for example the request URI of this page is howto-cocoon-webmail.html.
The mid-col-2 section of this page expects an xml document
in the filesystem as docs/mid-col-2/howto-cocoon-webmail.xml.
By design dynamic pages of the Cocoon Webmail application are
requested by an URI of the format mail/*.html, the resource mapping
of these pages maps to the same directories as the static pages.
Thus mail/mail.html maps for the section mid-col-2 to
docs/mid-col-2/mail.xsp.
Beside the usage of the sitemap MailAction there are several sitemap
components, and sitemap constructs used in sitemap of the Cocoon Webmail.
The following sections detail most important Cocoon's sitemap components
of Cocoon WebMail. All of these components are listed in the
sitemap componts section.
resource-exists - Checks existance of a resource
link-translator - Defines link rewriting patterns
mail - action of the Cocoon Webmail application, executes commands, manages
http session, and javamail session.
file - generates XML from an XML file
serverpages - generates XML from an XSP file
asciiart-svg - generates SVG from a TXT file
wildcard - matches simple wildcard of the format *, and **
regexp-default - extension of regexp matcher for setting default values.
It is used to for matching both paginated, and non-paginted URI request.
Setting the default paginator page to 1.
resource - simple resource reader for serving images, and CSS files
request-attribute - selects processing depending on the existance, and content
of a request attribute, selects the suitable XSLT stylesheet for javamail object
to document page transformation.
xslt - XSLT transformer for transforming aggregated site document to html,
transforming javamail documents to a document.
paginator - Paginator transformer for splitting up long pages,
separating document pages by pagesheets/htmlpages.xml, and
separating dynamic pages by pagesheets/mailhtmlpages.xml,
content - defines a view requesting the 'pure' content of a page.
links - defines a view for requesting all outbounding links of a page.
show-page - aggregates a requested URI, triggering the generation of its parts.
The sections making up the content of a page are invoked from here.
load-page - Decides what page file should get loaded, due to the existing
of a resource in the filesystem, serving default pages in case of non-existance
of a requested resource document.
show-page-xsp - Decides what page file should get loaded, due to the existing
of a resource in the filesystem, serving default pages in case of non-existance
of a requested resource document. It generates from XSP instead of XML, in
contrast to load-page.
Each requested document URI uses following sitemap data flow:
Each aggregate part follows in principal following sitemap data flow:
Each requested dynamic URI uses following sitemap data flow:
Each aggregate part follows in principal following sitemap data flow:
As MailAction access a lot of parameters
the following diagram gives an overview of all
parameters involved for processing a request.
As the basic structure of Cocoon WebMail Site has been explained,
setting up, and maintaing a Cocoon WebMail site
- reusing ideas, sitemap snippets, and Cocoon's sitemap components -
shall be easy.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/index.xml
Index: index.xml
===================================================================
CocoonMail Index
This site demonstrates using Cocoon as Webmail Engine.
As it is a demo site you can use Cocoon Webmail.
Moreover some documentation about:
installing,
configuring,
customizing, and
technical background
is available, too.
Some quick installation notes:
Find an IMAP server access.
Configure the sitemap.xmap, by
entering the IMAP server configuration in the format
imap://''mail-userid'':''mail-passwd''@imap-server.foo.bar/.
Replacing imap-server.foo.bar by your imap server.
Try to login.
Send your feedback to Cocoon.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/linktranslatormap-action.xml
Index: linktranslatormap-action.xml
===================================================================
LinkTranslatorMapAction in Cocoon0.9Technical documentThis document describes the LinkTranslatorMapAction of Cocoon.
NAME
link-translator-map
WHAT
The LinkTranslatorMapAction component is used
setup a simple link rewriting.
TYPE
Action, Sitemap Component
BLOCK
Block-Mail/Scratchpad
CLASS
org.apache.cocoon.acting.LinkTranslatorMapAction
SINCE
Cocoon 2.1
CACHEABLE
not applicable
The LinkTranslatorMapAction sets up a simple link rewriting
mapping.
Keeping outbounding links independing from its publishing URI
is a simple usage scenario of LinkTranslatorMapAction.
Explain the sitemap action configuration, options when declaring template action
Explain the sitemap action setup, ie options when using template action
Describe limitation, bugs of LinkTranslatorMapAction
01-05-02: initial creation
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
If you want to continue, using
CocoonMail login, again.
You can read more about CocoonMail here.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/mail-action.xml
Index: mail-action.xml
===================================================================
MailAction in Cocoon0.9Technical documentThis document describes the MailAcion of Cocoon.
NAME
mail
WHAT
The MailAction component is used for
creating javamail objects, and putting them into the request attribute map.
TYPE
Action, Sitemap Component
BLOCK
Scratchpad/Block-Mail
CLASS
org.apache.cocoon.mail.MailAction
SINCE
Cocoon 2.1
CACHEABLE
not applicable
The MailAction is the central for triggering the creation of javamail objects.
Javamail objects as they are created are put into the request attribute map.
Moreover MailAction maintains an http-session, and putting into the
http-session the mail-context of a mail session.
Use the MailAction in case of accessing information accessible via
IMAP, or more general accessible via an registed javamail provider.
Setting up the MailAction requires configuring the mail session.
The parameter store-urlname identifies the store which should be used.
The snippet below spefies using the protocol imap, and using the
imap server host imap-server-host-name.
Moreover the request parameters mail-userid, and mail-passwd
replaces the placeholders ''mail-userid'', and ''mail-passwd''
Finally as the javamail Session class accepts properties, for configuration purpose,
the snippet below switches off the session debugging explicitly.
Parameter names having prefix javax.mail.Session.props: are put
into the javamail session properties map, stripping off the prefix first..
The MailAction has no specific configuration possibilities.
The MailAction has no specific configuration possibilities.
Setting up the MailAction specifies the javamail Session to use, and
principal javamail Store to use.
As noted above MailAction puts XMLizable javamail objects
into the request attribute map. The following table lists the request attribute
names, set by MailAction.
Request Attribues Set By MailAction
Request Attribute Name
Comment
folder
A single folder
folders
Multiple folders
message
A single message
messages
Multiple messages
mail-current-working-folder
The current working folder name
mail-current-working-command
The command processded by MailAction
Each command generates zero, one, or more javamail objects, which are wrapped
to become XMLizable, and put into the request attribute map.
The following sections describe each of the commands above.
This command cats information about a folder
MailFolderCatCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
This command closes, and opens a folder, as a side effects new messages of a folder
are read.
MailRefreshFolderCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
This command list all subfolders of a folder.
MailListFolderCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
folder-pattern
optional
Speficies the folder-pattern to use,
see javamail documentation for allowed wildcards, by default the folder-pattern '%' is used.
This command lists all messages of a folder. This command does not requests
the mail content, only the mail header information is prefetched.
MailListMessagesCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
This command searches for messages. It uses the javamail SearchTerm
for searching, and it searches only in Subject, and From fields of each message.
It uses SubjectTerm, and FromStringTerm for searching.
See the javamail documentation for SearchTerm details.
MailSearchMessagesCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
search
optional
Speficies the search string, by default it has the
value of an empty string, matching all messages.
This command cats information about a message. The message is specified by
it message id. This command requests the content of a message.
MailCatMessageByIdCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
id
mandatory
Speficies the msgid integer value
This command cats information about a message. The message is specified by
it message id. This command requests the content of a message.
MailCatMessageByUIDCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
uid
mandatory
Speficies the uid of a message
This command cats an attachment of a mail.
MailCatMessageByIdCommand parameters
Parametername
Mode
Comment
folder
optional
Speficies the foldername
id
mandatory
Speficies the msgid integer value
part-id
mandatory
Speficies the id of the requested mail part.
As MailAction puts XMLizable javamail objects like
javax.mail.Folder, javax.mail.Message into the request
attribute map, the following sections describe the xml document structure of
these objects
The MailAction is still work in progress.
The http-session handling, and the javamail session handling is not stable
under every cirumstances.
01-04-03: initial creation
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
As MailAction relies on the javamail package, read more about
javamail.
1.1 xml-cocoon2/src/scratchpad/webapp/samples/mail/docs/mid-col-2/regexpuridefaults-matcher.xml
Index: regexpuridefaults-matcher.xml
===================================================================
RegexpURIDefaultsMatcher in Cocoon0.9Technical documentThis document describes the RegexpURIDefaultsMatcher of Cocoon.
NAME
template
WHAT
The RegexpURIDefaultsMatcher component is used
to serve data in a sitemap pipeline.
:
[Back]
[Next]
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org