k9mail / k9mail-docs Goto Github PK

See comments I made on thunderbird/thunderbird-android#2017 for why this is probably useful.

The documentation currently has to weigh up two separate concerns, feature documentation and user tutorials. It would be better if a more step-by-step tutorial was introduced. We could ignore lots of stuff in this tutorial and focus on basics.

I think a beginner tutorial should:

• Set up an IMAP account
• Send an email
• Receive an email
• Manage email

I think it should not cover PGP/MIME because most users don't use PGP/MIME right now. A second tutorial focusing on PGP/MIME could then be added (allowing the PGP/MIME pages to better focus on documentation).

This work should be done with reference to K-9 changes likely to substantially affect this area (notably: thunderbird/thunderbird-android#1859 and thunderbird/thunderbird-android#1818)

The 1920x1080 images for screenshots are too large and distract from the text. We need a way to either create low-res placeholders, or use CSS to make them smaller.

Relevant: mkdocs/mkdocs#1678

• Update screenshots
• Update 'Security' section
• Update 'Authentication' section
• Add 'Client certificate' section

• Update screenshots
• Remove references to WebDAV accounts (no longer supported)
• Update the text to match what's available in the current version of the app

When sending an email while on airplane mode, K9 helpfully places it under the Outbox folder.
Upon connecting to the internet, messages aren't sent automatically, nor does K9 ask whether messages ought to be sent.
What's more, going to the Outbox and choosing "Send messages" from the 3-point menu does not send the messages at all. The only way is to send the messages to the Drafts folder, and then open each and push send: then the messages are sent successfully.
So it's not an issue with the SMTP config but with K9 itself.
Using K9 6.602 on Android.

• Rename to 'General settings'
• Update screenshot
• Make sure all settings currently available in the app have a description

• Update instructions on how to get to account settings
• Make sure the descriptions match what's currently available in the app

Many of the documentation pages contain screenshots of the app. In order for the screenshots to have a uniform look we should use an emulator image with a specific configuration to create all screenshots.

The instructions could live in the wiki.

Most of this probably needs to be rewritten. It might also make sense to have dedicated pages for import and export.

Sometimes when I select one or more messages in an account inbox, I see an icon next to the hamburger menu that looks like a gray stop sign with a white exclamation mark in it. What does that icon mean? If I select that icon, what happens to the messages that are selected?

Thanks,
Bill

• Add description on how to get to the folder settings screen
• "Folder sync class" -> "Folder poll class"
• Add description for "Folder notification class"

This should probably be split into multiple Android-version-specific pages. The look, behavior, and available options in K-9 Mail differ quite a bit depending on the Android version.

Fixing/updating notifications is the next big item on the roadmap. So we probably shouldn't spend too much time on updating this page until that work is complete.

This should be less of a wikipedia entry on TLS and more K-9 Mail specific. See DefaultTrustedSocketFactory.

Maybe also include a link to the tables in the SSLSocket documentation.

I'm new to this and not sure if this is normal behavior, but when I send an encrypted email using K-9 email (for Android), K-9 requires my password for my OpenPGP encryption key stored on OpenKeyChain. K-9 will 'remember' the password with one of these three options: "until screen off", "for one hour", "for one day", or "until cleared".

Is this normal behavior for K9 to require the password be entered each and every time an encrypted email is sent with K9?

Hopefully I'm describing this correctly. I just would like to know if I am supposed to enter my OpenPGP credentials each time an encrypted email is sent using K-9 email. Thanks!

Is is possible to implement in k9mail RTF (rich text format) mails in k9mail?

Users receiving mails from outlook with attachments can't see them. Attachments are in winmail.dat format.
I remember being able to open simple .doc files in the past.
best regards,
Li70

WebDAV support was deprecated. When setting up a new account WebDAV is no longer an option. In 5.800 existing accounts still work, though. But I don't see a reason to keep the documentation page.

The accounts overview screen no longer exists. This page should probably be split into two pages – one that explains how to use the account switcher and accounts list in the drawer, and one that explains how to manage accounts (create, delete, reorder, etc.). The 'Removing an Account' page should probably be merged with the latter one.

This page should probably contain more information about

• adding contacts
• adding attachments
• saving as draft
• read receipt
• encryption (maybe this should be a separate page)

We should probably have a device specific notes page in the documentation to collate behavioural concerns (that are expected but not intuitive) on specific devices. Basically if it affects a small group of devices and was considered WONTFIX then it's a good potential candidate for this page.

See the issue with the overflow menu on Samsung devices as a possible example.

I forked this with the idea of helping to translate the renewed documentation. I have only done a few files, since those have already been reworked.
Any ideas of how to implement this? I thought that a simple /es/ folder would solve it, but I don't know.
I can keep working in my fork and when the time comes I guess we can figure it out?

Create a page that describes how the Unified Inbox works, how to include/exclude folders and how it can be enabled/disabled.

At some point we'll hopefully support documentation in multiple languages and maybe documentation for specific app versions, e.g. allow users to read/link to the documentation for K-9 Mail X even though K-9 Mail X+1 is the current version. This is not a priority right now, but we should prepare the URLs to support this later.

I propose that instead of a URL like

https://docs.k9mail.app/setup/installation/

we use something like

https://docs.k9mail.app/en/current/setup/installation/

• Remove reference to APG
• Remove reference to historical information
• Update screenshots and description (explain Autocrypt etc.)
• Maybe rename to "End-to-end encryption" because that's what we use inside the app

See https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/

When I select a message in K9 5.804 I see at the top four icons: trash, envelope, download (down-arrow) and folder.

In the “Visible message actions” Display settings, I have selected only Delete and Move.

I clicked the download (down-arrow) icon and the message disappeared.

At https://k9mail.app/documentation/ there is no explanation what the icons mean.

I turn, I do not know what the icons mean (down-arrow) as example, but the icons are always present.

• Describe the meaning of icons in the message list, when a message is selected

Thank you for the app!

It would be nice if the search term was cached sometimes.

The folder class system hasn't changed in quite a while. So this page might not need to be updated.
But someone should carefully go over it to make sure there's no outdated information.

• Update screenshots
• Update 'Security' section
• Update 'Authentication' section
• Add 'Client certificate' section

Hello and thanks for the software, translations and documentation,

I have just translated most of your github page to Catalan language for people to learn about it in our webpage
https://donestech.net/noticia/k-9-mail-gestor-de-comptes-email-que-respecta-la-privacitat-android

For translating the documentation, do we make a pull request, duplicate the "en" folder, made it and make a merge request?

By the way, very funny the photos with the [email protected] XD

It feels like this page needs a major overhaul. We should probably add high level descriptions of transport encryption and end-to-end-encryption that an average user can understand. The "server authentication" section can probably be removed. "Client certificates" should probably get a dedicated page.

I'm not sure about this one. Maybe we should create one post per provider in the FAQ section of the forum? Comments welcome.

When I start a new message to a person with known key, I get a disabled key lock and have to tap it to enable. Shouldn't it be enabled by default? I can't find a setting for this.

Figure out which entries are still relevant and copy them to the FAQ category of the forum. https://forum.k9mail.app/c/faq/6

Change this page to forward to the forum.

Am using app to access Yahoo mail. Due to a data breach involving that account I changed my password. Even though I updated Yahoo password, K-9 still logs in and works as usual. Inside K-9 there appears to be no way to sign out and sign back in with new password. If it's buried somewhere, I cannot find it. Short of uninstalling app and reinstalling how does one sign out and sign back in with a new password. Thanks

"Global settings" have been renamed to "general settings". General settings and account settings can be reached via the 'Settings' option in the drawer. Folder settings via the 'Manage folders' option in the drawer.

• add screenshots
• add description for the message list widget

The 'reading mail' page contains quite a bit of information that is not really about reading mail. We should probably move the description of all the available actions to a separate 'managing mail' page. And then improve the description of how multi-select mode works.

There should probably be separate sections for the message list screen and the message view screen.

We mostly reference this version: https://github.com/k9mail/k-9/wiki/LoggingErrors

We probably shouldn't duplicate this information in the documentation. Maybe write some more general text on reporting bugs and link to the wiki page for how to record a debug log.

Make sure the page matches the current set of permissions used by the app.

Maybe add a comment stating that only the contacts permission needs to be granted by the user, the rest is granted automatically.

This can be used as a starting point: https://forum.k9mail.app/t/how-to-configure-push/1102

It feels like most of this should be rewritten.

From issues raised on K-9 and from the complexity of the eco system it's fairly clear we should document the different types of notification, grouping and the actions and so on available.