Skip to content

Commit

Permalink
First cut at documentation of notifications #32
Browse files Browse the repository at this point in the history
  • Loading branch information
philipwhiuk committed Jan 8, 2017
1 parent 36e531a commit f67ec5b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions _includes/documentation-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ <h5>Documentation</h5>
<li><a href="/documentation/folders.html">Folders</a></li>
<li><a href="/documentation/reading.html">Reading E-mail</a></li>
<li><a href="/documentation/sending.html">Sending E-mail</a></li>
<li><a href="/documentation/notifications.html">Notifications</a></li>
<li><a href="/documentation/security.html">Security</a></li>
<li><a href="/documentation/settings.html">Settings</a></li>
<li><a href="/documentation/storage.html">Storage</a></li>
Expand Down
1 change: 1 addition & 0 deletions documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ If you have any comments please feel free to <a href="contribute.html">provide f
* [Folders](/documentation/folders.html)
* [Reading E-mail](/documentation/reading.html)
* [Sending E-mail](/documentation/sending.html)
* [Notifications](/documentation/notifications.html)
* [Security](/documentation/security.html)
* [Settings](/documentation/settings.html)
* [Widgets](/documentation/widgets.html)
Expand Down
36 changes: 36 additions & 0 deletions documentation/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Notifications
nav_hide: true
layout: default
---

{% include documentation-header.html %}


# Notifications

Notifications are a key part of any communications tool and K-9 has, through it's development put considerable effort into designing a notifications system that both accomodates users and and works as well as possible across a broad range of devices.

In this section, the use of notifications by K-9 is documented.

## New Mail Notifications

The most commonly seen notification is the new mail notification.

A single new mail notification will appear as a simple notification, showing the sender, the subject and the start of the email. Actions are provided which are (by default):

* Reply
* Mark Read
* Delete

Multiple emails to the same account are collapsed, stacked into a single notification, showing the sender and the subject. Dragging down on the stacked notification expands the unread emails into separate notifications, which then function as described above.

Tapping on the stacked notification clears it and opens the Inbox for that account.

Tapping on an individual email's notification clears it and opens that email.

## Error Notifications

If (for example) an account's password changes and K-9 can no longer receive email, a notification will be created informing you of the authentication failure.

Tapping on the notification will open the Incoming Server settings screen to correct the problem.

0 comments on commit f67ec5b

Please sign in to comment.