jwma Documentation [Development]

*jwma Development - JwmaSendMail Specification*

Main \| Deployment \| Configuration \| Architecture \| Development \| Screenshots \| SF Project Site
Index \| Overview \| Building \| API Docs \| Credits & Contributors

General Remarks

This document represents a specification of JwmaSendMail, which is a servlet based implementation of jwma's abstract mailing controller. It describes the controller targets and tasks in detail.
Note that this implementation has been mainly seperated from the main controller, because it requires multipart/form-data handling support (i.e. to send attachments). Thus ensure that the incoming data always has to be multipart/form-data encoded, which can be achieved easily by adding enctype="multipart/form-data" as attribute to the form tag of the compose form. An explanation of jwma's multipart/form-data handling support can be found in following annotated UML class diagram.
Also important to be aware of, is that historically this controller is not strictly following the target/todo scheme. This means that at the moment you don't necessarily have to add the given target and task descriptions, as the controller will ignore them at the moment.
Related information can be found in the HtmlHelper API documentation, as well as... (add )

Controller Targets

acton=<target>	Description
message	Actions will be related to message. (OPTIONAL)

The following sections will specify all valid tasks for each of these targets.

message

send (OPTIONAL)
Description	Tries to send and/or store the given message and redirects to the last view. This method also handles draft storage, albeit without support for draft attachments.
Parameters	see parameters table
Redirects To	Last view
Method	`doSendMessage()`
URL example	`<URI prefix>?acton=session&todo=login&username=some&password=body`
HtmlHelper	`getMailIdentitySelect() getMailFrequentSelect()`

Parameters

Parameter	Type	Description
`savedraft`	boolean (as String "true"/"false")	flag's request to store a message as draft instead of sending it
`to`	String	Receiver(s;comma separated) of the message, nickname(s;comma seperated, starting with `@`), or a groupname (ending with `:;` for invisible, or `:@;` for visible recipient lists). Examples are: 1. somebody@work.tv,sombody@home.tv 2. @fred,george,nicky (recipient list invisible for receivers) 3. friends:@; (recipient list visible for receivers) 4. colleagues:; (recipient list invisible for receivers)
`ccto`	String	Carbon Copy receiver(s;comma separated) of the message
`bccto`	String	Blind Carbon Copy receiver(s;comma separated) of the message
`attachment`	transport encoded binary	attachment(s) of the message
`subject`	String	subject of the message
`body`	String	body of the message (i.e. content)
`signature`	String	signature of the sender (textual, not cryptographical!)
`toggleautosign`	boolean (as String "true"/"false")	toggles automatical signing setting
`togglerndappend`	boolean (as String "true"/"false")	toggles automatical random append setting
`mailidentity`	String	unique identifier of mailidentity to be used

Although group mailing is now supported, note that it is not recommended to use a jwma based webmail client for something that is better handled by a mailing list software (see Mailman http://www.list.org for example).