From 3cdd184bdbd6dcf1b1d8637854bc5f7a353552df Mon Sep 17 00:00:00 2001
From: Christian Mollekopf <chrigi_1@fastmail.fm>
Date: Thu, 22 Oct 2015 14:29:01 +0200
Subject: Documentation

---
 docs/design.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

(limited to 'docs/design.md')

diff --git a/docs/design.md b/docs/design.md
index 4ab2e887..aff49183 100644
--- a/docs/design.md
+++ b/docs/design.md
@@ -49,6 +49,39 @@ Use-case specific controllers are used to operate on the data. Controllers allow
 Rather than splitting controllers by domain type (e.g. an email controller, or a calendar controller), we specifically write controllers for specific usecases (e.g. an email editor), that exposes all required actions. That way we ensure that the API's a UI is working with is always clear an consice, and that we have all domain logic captured in the domain logic layer, rather than the UI layer.
 Of course controllers will need to share functionality internally as soon as an action is available from more than one place.
 
+### Email Domain Logic
+* Folder list
+    * Folder List Controller
+        * Move mail to folder
+        * Move/Copy/Delete folder
+        * Synchronize folder
+    * Folder List Model
+        * Mixes akonadi next queries and subqueries (folder list with smart folders)
+        * name
+        * statistics
+
+* Mail list
+    * MailListController
+        * Mark as read
+        * Flag as important
+        * Move to trash
+    * MailListModel
+        * subject
+        * date
+        * sender
+        * folder
+    * ThreadModel
+        * thread leader (otherwise like maillist model)
+        * number of mails in thread
+
+* Mail Viewer
+    * MailViewController
+        * reply
+        * forward
+        * move to trash
+    * MailModel
+        * subject, date, sender, folder, content, attachments
+
 ## Infrastructure
 
 The infrastructure layer interfaces with the rest of the system. It is the place where we can integrate with various native infrastructure parts.
@@ -59,8 +92,14 @@ Note: The infrastructure blocks will use only types provided by the domain logic
 ### Akonadi Next
 Akonadi Next is used for primary data access and handles all synchronization.
 
+Interactions with Akonadi Next involve:
+* Adding/removing/configuring resources
+* Triggering synchronization
+* Querying of data
+* Creating/Modifying/Removing entities
+
 ### Configuration
-Configuration as traditionally store in config files in ~/.kde
+Configuration as traditionally stored in config files in ~/.kde
 
 ### Notification
 Notifications for the system.
-- 
cgit v1.2.3