Installation and Configuration

Change logs

Phase 1: WYSIWYG editor support
- HTMLArea and FCKeditor is included in the Mailtool package (2.1)
- (Now Mailtool 2.2 and 2.3 dropped independent WYSIWYG editor-support. Instead, Mailtool will use Sakai library's wysiwyg editors)
Phase 2: Attachment support
- Gmail-like attachment
  - use <sakai:inputFileUpload>
  - remove link for each attachment
  - check if there's duplicate file among attachment list (If so, ignore)
- EmailService.sendMail() is refactored for attachment
- Support multipart message along with Attachment(s)
Phase 3: Automatic configuration and options page
- Automatic configuration
  - Right after Mailtool is added to the site, it's functional without any configuration.
  - Default/Initialization: role id, realm id, recipview, subject prefix will be initialized automatically.
- Site-configurable "Options" page is added (by admin and the authorized role whose "mailtool.admin" function should be set to true before site creation)
  - "send me a copy" checkbox: on/off switch & set default
  - "add to email archive" checkbox: on/off switch & set default
  - "choose selection view" dropdown with new values ("Users", "Roles", "Users by Role", "Side-by-Side", "Scrolling-list")
  - "reply-to" radio button
  - "message format" radio button
  - "subject prefix" text input
  - "Renaming roles": All roles in the site will be automatically shown and its names are changeable

Installation

Requirements:same as Sakai 2.2 (http://source.sakaiproject.org/release/2.2.2/#overview)

svn: https://source.sakaiproject.org/contrib/mailtool/trunk/

How to build/deploy

Check out the source from the above url (using Subversion or TortoiseSVN) to the sakai source directory.
Go to the source directory.
Run "maven sakai". (You may need to edit build.properties for reflecting the location of your tomcat home)

Configuration

— /sakai/sakai.properties
Mailtool uses the following four sakai-wide settings

smtp@org.sakaiproject.email.api.EmailService=localhost
content.upload.max=5
wysiwyg.editor=FCKeditor

There are two optional settings. If these do not exist, Mailtool will use default values.

mailtool.max.num.attachment=(default: unlimited)
mailtool.upload.directory=(default: /tmp/)
mailtool.show.renaming.roles=(default: no) ; "yes" will turn on "Renaming Roles" in options

-- Two permissions: Admin can allow the following two permission via "Administrator workspace -> Realms". Admin should set the permission before adding Mailtool to the site.

1) mailtool.admin

2) mailtool.send

— /mailtool/WEB-INF/web.xml (Sakai/Tomcat Admin can modify)

...
<\!-\- This will override the setting "content.upload.max" in sakai.properties
<init-param>
<param-name>upload.max</param-name>
<param-value>5</param-value>
</init-param>
\-->
...

(This value will override sakai.properties' content.upload.max)

---/mailtool/tools/sakai.mailtool.xml (Site's maintainer can modify) - Do not change these values if possible. All are configurable in options page from 2.3)
<configuration name="wysiwygeditor" value="" />    (no longer used since 2.2)
<configuration name="subjectprefix" value="" />      (configurable in options) - no change
<configuration name="recipview" value="" />         (configurable in options) - no change for compatibility with old versions (user/role/tree/sidebyside/foothill)
<configuration name="emailarchive" value="" />      (configurable in options) - usage is changed. valid values are "yes" or "no"
<configuration name="sendmecopy" value="" />      (configurable in options) - new in 2.3. valid values are "yes" or "no"
<configuration name="replyto" value="" />            (configurable in options) - new in 2.3. valid values are "yes" or "no" or email address
<configuration name="messageformat" value="" /> (configurable in options) - new in 2.3. valid values are "plaintext" or "htmltext"
<configuration name="displayinvalidemailaddrs" value="" />   no change
<configuration name="mail.newlock.siteid" value="" />           no longer used

<configuration name="role1realmid" value="" />       (configurable in options) - no change
<configuration name="role1d" value="" />                (configurable in options) - no change
<configuration name="role1singular" value="" />    (configurable in options) - no change
<configuration name="role1plural" value="" />         (configurable in options) - no change
....
<configuration name="role15realmid" value="" />       (configurable in options) - no change
<configuration name="role15d" value="" />                (configurable in options) - no change
<configuration name="role15singular" value="" />    (configurable in options) - no change
<configuration name="role15plural" value="" />         (configurable in options) - no change

This setting also can be changed in
My Workspace->Site->"____siteid__" -> "Add Edit/Pages" -> "_Mailtool" -> "Tools" -> "___toolid____"

— Use sakaiscript for setup
See http://bugs.sakaiproject.org/confluence/display/ENTR/2005/07/19/Steve+Githens'+Web+Services

Usage

When create a new site:
Just choose Mailtool from the list of the tools

When add Mailtool to the existing site
My Workspace -> Worksite Setup -> Check box next to "____siteid____" -> Click "Revise" -> "Edit tools" -> Check "Mailtool"

Known bugs/limitations

When "Attach a file" link is clicked, Sakai RequestFilter's warning is printed: This one not affect any part of the Mailtool.(Being inspected)
When HTMLArea wysiwyg editor is used and user change the recipients view, the contents in HTMLArea will be lost.
(Not happens in FCKeditor or Plain text editor)
When the message with attachment(s) is archived, the archived message will not contain attachment. Instead, it have the info(filename and size) of the attachment(s)

Contact

SOO IL KIM