jwma Development - Preferences Documentation
 
Main | Deployment | Configuration | Architecture | Development | Screenshots | SF Project Site
Index | Overview | Building | API Docs | Credits & Contributors

Introduction

This document describes the architecture of the preferences part of the model, and specifies the supported preferences available in jwma. Note that some of the fields will probably never edited by the user, rather they are automatically set by the application (marked with * below). Basically all parameters will be populated from the site's template when a user's preferences are created the first time; for certain fields the default setting from the template is more interesting (see those marked with ** below). Finally there are fields which will be populated with host specific configuration (these are marked with *** below).
The preferences model is based on three levels, two of which are pure interfaces, modeling view and controller/model based access respectively. The actual implementations are supposed to be provided with the preferences persistence plugin. Figure 1 presents a class diagram with an overview of the preferences part of the model.

Figure 1: Preferences Model Overview

Note that jwma is designed to support an arbitrary number mail identities, in a 1-n relationship to the preferences. See the API documentation for more details:
The following two sections describe the data stored in preferences respectively mail identity instance. The identifier in the last column is supposed to be used throughout the project (e.g. HTML form field names, XML tag identifiers, variable names), to allow rapid recognition and association.


Preferences Data

Data field (cn) Description Identifier
User Identity* The identity of the user, a unique identifier associating the user with the preferences data. This field will be set automatically. useridentity
Firstname Firstname of the user. firstname
Lastname Lastname of the user. lastname
Last login* Last successful login, is automatically updated. lastlogin
Contact Database* A unique identifier for the contact database associated with the user.This field will be set automatically. contactdb
Default Mail Identity A unique identifier for the default mail identity associated with the user. defaultmailidentity
Language The users preferred language (as two-letter ISO code) language
Quote Character Quote character, that is used to quote messages on replies. quotechar
Auto Quoting Determines whether messages are automatically quoted on replies, or not. This setting can be toggled from the message view for each case. autoquote
Root Mail Folder*** The root mail folder of a user. This setting can be determined by the post office specific configuration. rootfolder
Trash Folder ** The path of the trash folder, for deleted messages. This field can be determined by the site template.Note that the folder should be a direct subfolder of the root folder. trashfolder
Draft Folder ** The path of the draft folder, for draft messages. This field can be determined by the site template.Note that the folder should be a direct subfolder of the root folder. draftfolder
Read-mail Archive The folder where mails from the INBOX are moved to, when they were read by the user. This field can be determined by the site template. Note that the folder should be a direct subfolder of the root folder. readmailarchive
Automove Read-mail Determines whether messages are moved from the INBOX to the read-mail archive when read, or not. If set (i.e.true), then jwma moves the read mail automatically on logout. automoveread
Sent-mail Archive The folder where outgoing messages are archived. This field can be determined by the site template. Note that the folder should be a direct subfolder of the root folder. sentmailarchive
Autoarchive Sent-mail Determines whether messages are archived when sent, or not. If set (i.e. true), then jwma automatically saves an instance of each outgoing message in the sent-mail archive. autoarchivesent
Auto-empty Trash Determines whether messages in the trash should be cleaned up automatically or not. If set (i.e. true), then jwma automatically deletes all messages in the trash on logout. autoempty
Message Processor** The processor to be used when displaying messages. msgprocessor
Date Format Pattern** The date format pattern used when displaying dates. dfpattern
Expert Allows to hide certain configuration details from the inexperienced user. expert
Style** Stores a possible style related parameter. (e.g. a style-sheet, an image prefix etc.) style
Display Inlined Allows to switch between inline and description displaying of mail attachments. inline


Mail Identity Data

Data field (cn) Description Identifier
Name The name (identifier) of the mail identity. mid.name
From Address The user's from address. mid.from
Reply-To Address*** The user's preferred reply-to address. This setting can be determined by the post office specific configuration. mid.replyto
Signature Standard signature of the user. mid.signature
Related Contact Unique identifier of a contact from the contact database, which represents the mail identity. mid.relcontact
Auto Signing Determines whether messages should be automatically signed (with the standard signature), or not. Actually it just presets the pull down in the compose form. mid.autosigning
Random Append A random append type. mid.randomappend
Note A note, for a description or comment about the mail identity. mid.note

© 2000-2003 jwma team