Skip to content

Commit

Permalink
feat: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robert-virkus committed Mar 4, 2024
1 parent 223f95b commit 77c73e2
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 20 deletions.
27 changes: 7 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,20 @@
# Codename: Maily
Mail app for iOS, Android and hopefully more platforms in the future. Developed in [Flutter](https://flutter.dev).

## Test Maily
You can test an early access version of Maily today:
* on Android at [Google Play](https://play.google.com/store/apps/details?id=de.enough.enough_mail_app).
* on iOS with [TestFlight](https://testflight.apple.com/join/6TFIg0uJ).

## Screenshots Android
[<img src="screenshots/welcome.png" width="320"/>](screenshots/welcome.png)
[<img src="screenshots/compose_honey.png" width="320"/>](screenshots/compose_honey.png)
[<img src="screenshots/contact_interactions.png" width="320"/>](screenshots/contact_interactions.png)
[<img src="screenshots/message_actions.png" width="320"/>](screenshots/message_actions.png)
[<img src="screenshots/messages_actions.png" width="320"/>](screenshots/messages_actions.png)
[<img src="screenshots/design2.png" width="320"/>](screenshots/design2.png)
# enough_mail_app
Base mail components in Flutter.

For a full email app based on this project, see [maily](https://github.com/Enough-Software/maily).

## Features
* POP and IMAP service providers are supported, though POP accounts are not tested at this moment
* Multiple account support
* Unified account - when you have at least 2 accounts, a unified account will show up automatically - with unified inbox, sent, trash, etc
* Mail management: delete, mark as read/unread
* Unsubscribe from newslettters easily
* Unsubscribe from newsletters easily
* View attachments in app - photos, PDFs, video and audio files
* Compose messages: compose new messages and reply to/forward mails with WYSIWG editor
* Save and continue draft messages
* Attach photo-, audio-, video- or generic files. Attach your current location.
* Swipe right to left to delete and swipe left to right to mark as read/unread
* Personalizae swipe actions
* Personalize swipe actions
* Optionally you can block external images when viewing mails
* You can specify aliases and check for + alias support by your mail provider
* Swipe left or right in the message details to view the next/previous message
Expand Down Expand Up @@ -64,8 +53,6 @@ This is how you contribute:

When you have compile problems this is usually due to not getting the latest version from git. Call `flutter pub upgrade` to ensure that you are on the latest version of all referenced projects. Since translations are generated you can ignore all translation problems, just start the build, afterwards the localization compilation problems will be gone.

For some features you will need to add the relevant keys to *assets/keys.txt*, currently the following key is required:
* giphy: https://developers.giphy.com/

## Localizations
When you change translations, re-generate the translations files by calling `flutter gen-l10n`.
Expand All @@ -82,11 +69,11 @@ by calling `dart run build_runner build --delete-conflicting-outputs`.

## Related Projects
Check out these related projects:
* [maily](https://github.com/Enough-Software/maily) email app based on enough_mail_app.
* [enough_mail](https://github.com/Enough-Software/enough_mail) mail libraries in pure Dart.
* [enough_mail_html](https://github.com/Enough-Software/enough_mail_html) generates HTML out of a `MimeMessage`.
* [enough_mail_flutter](https://github.com/Enough-Software/enough_mail_flutter) provides some common Flutter widgets for any mail app.
* [enough_media](https://github.com/Enough-Software/enough_media) provides media rendering widgets.
* [enough_convert](https://github.com/Enough-Software/enough_convert) provides the encodings missing from `dart:convert`.


![Maily Logo](/maily.png)
Binary file removed maily.png
Binary file not shown.
Binary file removed screenshots/compose_honey.png
Binary file not shown.
Binary file removed screenshots/contact_interactions.png
Binary file not shown.
Binary file removed screenshots/design2.png
Binary file not shown.
Binary file removed screenshots/message_actions.png
Binary file not shown.
Binary file removed screenshots/messages_actions.png
Binary file not shown.
Binary file removed screenshots/welcome.png
Binary file not shown.

0 comments on commit 77c73e2

Please sign in to comment.