diff --git a/docs/user-guide/antispam.md b/docs/user-guide/antispam.md new file mode 100644 index 0000000000..cb7a450bfa --- /dev/null +++ b/docs/user-guide/antispam.md @@ -0,0 +1,26 @@ +# Anti-Spam {#1} + +This section will explain about how anti-spam works, and peak about antispam training. + +### How Anti-Spam Works: + +- Anti-Spam feature in Tmail is designed to classify the messages as spam or not with an configurable score threshold. +- Usually a message will only be considered as spam if it matches multiple criteria; matching just a single test will not usually be enough to reach the threshold. +- Spam is reported on a per user base. +- When a message is classified as spam, it will automatically moved to user's Spam folder + +### Anti-Spam training + +1. Marking Emails as Spam: + +- You can manually mark emails as spam . This action provides feedback to the anti-spam system, helping it learn from user preferences. + +2. Whitelisting: + +- Conversely, you can mark legitimate emails as not spam or whitelist specific senders. This feedback helps the system refine its understanding of trusted sources. + +3. Custom Filtering Rules: + +- Tmail allows users to set up custom filtering rules. For example, you can create rules to automatically move emails containing certain keywords to the spam folder. + +By actively participating in anti-spam training as above, you contribute to a more accurate and personalized spam filtering experience. diff --git a/docs/user-guide/auth.md b/docs/user-guide/auth.md new file mode 100644 index 0000000000..997b889e70 --- /dev/null +++ b/docs/user-guide/auth.md @@ -0,0 +1,33 @@ +# Authenticating in Twake-Mail {#auth} + +Twake-mail supports both being integrated with an identity provider and basic authentication/ + +## Web: Login with OIDC + +![image](https://github.com/user-attachments/assets/21eca674-11fe-4957-9398-d195ee96e544) + + +Upon being launched Twake-Mail detects that your installation supports identification through an indentity provider and redirects to its login page. + +Fill in your credentials supplied by your platform administrator, and the identity provider will redirect you to the Twake-Mail Inbox page. + +## Web: Login with basic authentication + +If Twake-Mail finds no identity provider, Tmail will fallback to basic authentication and ask for your login and password. Fill in your credentials then click Sign in. +If the credentials are correct, you will be logged- in successfullly and go to Inbox thread-view. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/7f086dd6-689e-4391-a77b-7408f4793ac2) + +## Mobile + +For mobile, you need to input your email address first. From this email address, TMail will auto-dectect identity server if your account are supported with identification through an indentity provider Then you need to input credentials supplied by your platform administrator to log in + +![Frame 1 (6)](https://github.com/user-attachments/assets/6e0fa8b2-bb08-4fc1-8e6a-607c23a70418) + + +If Tmail detects that your account are not supported with identification through an indentity provider, you need to connect to your home JMAP email server. Tmail will prompt you for its URL first. Your administrator should have provided you this value. + +Then Twake mail will ask you directly for your credentials to log-in + +![Frame 33](https://github.com/linagora/tmail-flutter/assets/68209176/e2ecc279-95d0-4374-9d7f-7ab19ec9bac3) + diff --git a/docs/user-guide/build.sh b/docs/user-guide/build.sh new file mode 100644 index 0000000000..e2de410c67 --- /dev/null +++ b/docs/user-guide/build.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +# sudo apt-get install pandoc texlive texlive-xetex texlive-fonts-recommended + +pandoc index.md antispam.md auth.md composer.md extra-features.md install.md manage-folders.md profile.md pro-tips.md quota.md read.md search.md -o output.pdf --pdf-engine=xelatex diff --git a/docs/user-guide/composer.md b/docs/user-guide/composer.md new file mode 100644 index 0000000000..e0f7a53c9e --- /dev/null +++ b/docs/user-guide/composer.md @@ -0,0 +1,93 @@ +# Composer {#composer} + + This guide will walk you through the process of using our email composition tool effectively. + + # Creating a New Email in web +1. Click on the "New Email" button. A new email composer will appear +2. "From": By default it will display your default identity. When you click on this field - a drop-down list of your identities will be shown and you can select one of them. The identities you can use in the `From` field can be edited on the [profile page](profile.md). +3. "To": Fill in the recipient's email address in the "To" field. You can add multiple recipients by separating their email addresses with commas. +4. Enter a subject for your email in the "Subject" field. +5. Use the "CC" (Carbon Copy) and "BCC" (Blind Carbon Copy) fields for additional recipients as needed. +- (5.1)`CC`: Carbon Copy: Anyone in this field will see the other recipients of the message. +- (5.2) `BCC`: Blind Carbon Copy: The recipients won't know that you added anyone to 'Bcc'. +6. Signature button: You can click on this button to unfold/fold your signature. The setting of identities and its signature ycan be edited on the [profile page](profile.md). + +![Group 1 (1)](https://github.com/user-attachments/assets/8dcd67da-c15e-4bea-9fd8-45c4cdc5efc6) + + + +7. Text Formatting +Use the formatting options provided to style your email's text. These include : +- (7.1) `Text size` +- (7.2) `Style` +- (7.3) `Font famlily` +- (7.4) `Text color` +- (7.5) `Text background color` +- (7.6) `Bold` +- (7.7) `Italic` +- (7.8) `Underline` +- (7.9) `Strikethrough` +- (7.10) `Paragraph` +- (7.11) `Order list` + +![Group 2 (4)](https://github.com/user-attachments/assets/235b9662-5598-440d-88cc-b0b7ccc605d0) + + + +8. Adding Attachments +To attach files, click on the `attachment icon` and select the files you want to include. +9. Insert images +To insert images to the email body as an inline image, clock on `image icon` then select images that you want to include +10. Code view +When you click on `Code view button`, the email your are writing is displayed in Code view mode. This option is helpfull for developpers who want to debug the sources of the generated email. +11. Sending Your Email +- Click the "Send" button to send your email. Once sent, it will appear in your "Sent" folder. +- You can also click button `Save to Draft` (12) then the email is moved to Draft folder, you can then open it again and continue composing it. +- If you click `Cancel button` (13), the email will be discarded + +14. Managing Sent Emails + +To access sent emails or track the status of your sent email, navigate to the `Sent` folder (14) within your email client. Email currently being sent are located within the `Outbox` (15) and will eventually be moved into the `Sent` folder. + +16. Read receipt + +This feature allows the sender of an email to know when the recipient has opened and read the email. It provides a way for the sender to confirm that the message has been received and viewed by the recipient. + +Here's how read receipt work: +- Sender Requests a Read Receipt: When composing an email, the sender can enable the option to request a read receipt by click on icon (16) then to turn on Request read receipt +- When the recipient receives the email and opens it, they are typically presented with a message or notification asking if they want to send a read receipt back to the sender. The recipient can choose to either send the read receipt or decline the request. +- If the recipient chooses to send a read receipt, their email client will automatically generate and send a notification to the sender, indicating that the email has been opened and read. +- The sender receives the read receipt as a separate email or notification, confirming that the recipient has indeed read the email. + +![Group 3 (1)](https://github.com/user-attachments/assets/e2a0b743-164f-4e0b-87c5-8d0617c2d3ed) + + + # Creating a New Email in Mobile + +1. Click on the "Compose" button, the composer screen will be shown. +2. From: By default it will display your default identity. When you click on `Edit` icon (2.1)- a drop-down list of your identities will be shown and you can select one of them. The identities you can use in the `From` field can be edited on the [profile page](profile.md). +3. Fill in the recipient's email address in the "To" field. +4. Enter a subject for your email in the "Subject" field. +5. Adding Recipients +You can add multiple recipients by separating their email addresses with commas. Use the "CC" (Carbon Copy) and "BCC" (Blind Carbon Copy) fields for additional recipients as needed. +- (5.1)`CC`: Carbon Copy: Anyone in this field will see the other recipients of the message. +- (5.2) `BCC`: Blind Carbon Copy: The recipients won't know that you added anyone to 'Bcc'. + +![Frame 2 (4)](https://github.com/user-attachments/assets/9c49dca6-f464-4a76-8733-a3753bae579f) + +6. Text Formatting +Use the formatting options provided to style your email's text. +7. Adding Attachments +To attach files, click on the `attachment icon` and select the files you want to include +8. Insert images +To insert images to the email body as an inline image, click on `image icon` then select images that you want to include +For the first time you hit button Add attachments/Insert images, you a popup will be shown to ask permission to access Photos ans media in your mobile. +You need to click Allow then browse and select image/attachment from device. +9. Send your mail +- Click the "Send" button to send your email. Once sent, it will appear in your "Sent" folder. + When you click on 3-dot button of top right of compser, you can see 3 options: Request read receipt/Save as draft/Delete +- If you click `Request read receipt` (10, Read receipt request is enabled for this email. +- If you click `Save as draft` (11), the composer is closed and email is saved to Draft folder +- If you click `Delete` (12), the email is discarded. + +![Frame 3 (5)](https://github.com/user-attachments/assets/998c4c21-dc74-4bb3-b63e-344985709052) diff --git a/docs/user-guide/extra-features.md b/docs/user-guide/extra-features.md new file mode 100644 index 0000000000..3647e0e27f --- /dev/null +++ b/docs/user-guide/extra-features.md @@ -0,0 +1,112 @@ +# Extra features {#2} + +This small page will present features specific to Twake-Mail. + +## I. Team-mailboxes + + - "Team mailbox" typically refers to a shared mailbox or a collaborative inbox that multiple users or team members can access. A team mailbox is useful for managing emails collectively, allowing multiple team members to view, respond to, and manage emails in a shared space. + +- The owner of the shared mailbox needs to grant permissions to other team members. This can usually be done through the mailbox settings by the administrator. + +- Once permissions are set, team members can see the team-mailbox on foldet-tree on left panel. Each team-mailbox will contains: + - (1) Team-mailbox name + - (2) Email address of the team-maiilbox + +![Group 194](https://github.com/linagora/tmail-flutter/assets/68209176/3a4c900e-0cf8-4266-a66d-e08d66317fc9) + + +### Read message in my team-mailbox: + +- Every team-mailbox contains folders: + - Inbox + - Drafts + - Outbox + - Sent + - Trash +- You can hide and show a team-mailbox in 2 ways: + 1. Click 3-dots button on the team-mailbox, then select option "Hide folder", then the team-mailbox will be hidden from th folder tree + +![Group 194](https://github.com/linagora/tmail-flutter/assets/68209176/f157ca8f-6176-4447-b9ab-3d0194147dde) + + 2. Click avatar on top right => Manage account => Folder visibility: This screen will list all the folders, including team-mailboxes. I can easily select Hide/Show + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/42b85296-8461-4e4d-b115-a8e2822f3918) + +- You can mark star/unstar an email in the team-mailbox as other folders, then other members having access to the team-mailbox will see the message being star/unstar as well. +- You can mark message as read/unread in the team-mailbox as other folders, then other members having access to the team-mailbox will see the message being read/unread as well. + +### Team-mailbox identities + +- As a team-mailbox member, you can add a team mailbox as an identity so that you can access and manage emails on behalf of that team mailbox. +- You can create a new identity for the team-mailbox, edit/delelte it in the same way [Manage sender's identities](https://github.com/linagora/tmail-flutter/blob/user-guide-skeleton/docs/user-guide/profile.md#identities) + +### Send a message by team-mailbox + +**1. Send a new message** + +- When you click button "Compose", the he composer will be opened +- Whe nyou click to field "From", a drop-down list will be shown your list of identities +- You can select your team-mailbox identity that you created before +- Finish typing message and then choose Send. +- The recipients will see the team-mailbox address as the sender in the message. + + **2. Reply/Forward to the message** + +- When you open one email of a team-mailbox, and click button Reply/Forward +- The composer will be opened with the quoted message +- In "From" field, select team-mailbox identity that you created before then input the mail content and Send. + +## II. Auto-complete + +- This is a feature designed to make composing and addressing emails more convenient. This feature predicts and suggests email addresses as you start typing in the "To," "Cc" (carbon copy), or "Bcc" (blind carbon copy) fields and the Search bar +- When you start typing an email address, the system might suggest matches based on your contacts. +- Email Address Auto-Complete often relies on your existing contacts and address book ( mobile app). +- The existing contacts are contact from your company +- when you open TMail app for the first time, you will be asekd to allow Tmail to access to device's contacts. If you allow permisstion, then when you use auto-complete feature, it will rely on both your company's contacts and phone's contact + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/19038361-b6f6-413a-aac1-ad352a001074) + +![Frame 30](https://github.com/linagora/tmail-flutter/assets/68209176/d9ec88cc-153b-4500-84a5-4d23a019983c) + + +## III. Event information display + +When you receive a calendar event invitation in an email, Twake Mail will display the event details in a format that allows you to easily review and respond to the invitation. + +**1. On Email listing** + +On thread-view, You can see email of calendar events which having title include: + +- (1) The icon indicator events in front of email title + +- (2) The icon indicator .ics file which having in events email + +- (3) The event name on subject + +- (4) The event short description + +- (5) The host name (sender) email who be created an event + +- (6) The event status (New / Updated / Canceled) + +**2. Calendar event on details-view** + +On details-view of an email, you can see description of calendar events which having description include: + +- (1) The Calendar icon indicator event date + +- (2)The event name on subject + +- (3) The notification with color to describe each event status + +- (4) The mini tips information of event (When event will be started!? Who are invited !? Where is the event place!?) + +- (5) Yes/No/Maybe/Mail to attendees buton: You can click one of these button to response to the event invitation. When you click on "Mail to attendees", a new email composer is opened, with all attendees auto-filled as recipients. + +- (6) The description will be demonstrated in email body + +![Group 195](https://github.com/linagora/tmail-flutter/assets/68209176/674f9118-c3d4-4834-b018-153f2b17324a) + +![Group 5 (1)](https://github.com/user-attachments/assets/4e60aa71-0e1c-4c3e-9637-a31afb538117) + +![Group 6 (2)](https://github.com/user-attachments/assets/3a8b3554-055d-45c8-bcad-7918429dbdad) diff --git a/docs/user-guide/images/action1.png b/docs/user-guide/images/action1.png new file mode 100644 index 0000000000..255b4b2889 Binary files /dev/null and b/docs/user-guide/images/action1.png differ diff --git a/docs/user-guide/images/action2.png b/docs/user-guide/images/action2.png new file mode 100644 index 0000000000..23022fbcaa Binary files /dev/null and b/docs/user-guide/images/action2.png differ diff --git a/docs/user-guide/images/action3.png b/docs/user-guide/images/action3.png new file mode 100644 index 0000000000..939bae1629 Binary files /dev/null and b/docs/user-guide/images/action3.png differ diff --git a/docs/user-guide/images/advanced-search.png b/docs/user-guide/images/advanced-search.png new file mode 100644 index 0000000000..6bf0af58be Binary files /dev/null and b/docs/user-guide/images/advanced-search.png differ diff --git a/docs/user-guide/images/auth-mobile-1.jpg b/docs/user-guide/images/auth-mobile-1.jpg new file mode 100644 index 0000000000..c3ff7a1315 Binary files /dev/null and b/docs/user-guide/images/auth-mobile-1.jpg differ diff --git a/docs/user-guide/images/auth-mobile-2.jpg b/docs/user-guide/images/auth-mobile-2.jpg new file mode 100644 index 0000000000..639020be77 Binary files /dev/null and b/docs/user-guide/images/auth-mobile-2.jpg differ diff --git a/docs/user-guide/images/create-folder.png b/docs/user-guide/images/create-folder.png new file mode 100644 index 0000000000..b13c8f1fcf Binary files /dev/null and b/docs/user-guide/images/create-folder.png differ diff --git a/docs/user-guide/images/filters.png b/docs/user-guide/images/filters.png new file mode 100644 index 0000000000..87c1833bc7 Binary files /dev/null and b/docs/user-guide/images/filters.png differ diff --git a/docs/user-guide/images/folder-actions.png b/docs/user-guide/images/folder-actions.png new file mode 100644 index 0000000000..e4c728e8dc Binary files /dev/null and b/docs/user-guide/images/folder-actions.png differ diff --git a/docs/user-guide/images/folder-search.png b/docs/user-guide/images/folder-search.png new file mode 100644 index 0000000000..d18d43565c Binary files /dev/null and b/docs/user-guide/images/folder-search.png differ diff --git a/docs/user-guide/images/folders.png b/docs/user-guide/images/folders.png new file mode 100644 index 0000000000..3634537824 Binary files /dev/null and b/docs/user-guide/images/folders.png differ diff --git a/docs/user-guide/images/main-mobile-2.jpg b/docs/user-guide/images/main-mobile-2.jpg new file mode 100644 index 0000000000..b354ca9bcb Binary files /dev/null and b/docs/user-guide/images/main-mobile-2.jpg differ diff --git a/docs/user-guide/images/main-mobile.jpg b/docs/user-guide/images/main-mobile.jpg new file mode 100644 index 0000000000..a4467ad9fc Binary files /dev/null and b/docs/user-guide/images/main-mobile.jpg differ diff --git a/docs/user-guide/images/main.png b/docs/user-guide/images/main.png new file mode 100644 index 0000000000..d4659ae061 Binary files /dev/null and b/docs/user-guide/images/main.png differ diff --git a/docs/user-guide/images/oidc.png b/docs/user-guide/images/oidc.png new file mode 100644 index 0000000000..4bfc74adb8 Binary files /dev/null and b/docs/user-guide/images/oidc.png differ diff --git a/docs/user-guide/images/open.png b/docs/user-guide/images/open.png new file mode 100644 index 0000000000..dbdcea9093 Binary files /dev/null and b/docs/user-guide/images/open.png differ diff --git a/docs/user-guide/images/quick-search.png b/docs/user-guide/images/quick-search.png new file mode 100644 index 0000000000..2a4584330b Binary files /dev/null and b/docs/user-guide/images/quick-search.png differ diff --git a/docs/user-guide/images/read-receipt-open.png b/docs/user-guide/images/read-receipt-open.png new file mode 100644 index 0000000000..fd3a613425 Binary files /dev/null and b/docs/user-guide/images/read-receipt-open.png differ diff --git a/docs/user-guide/images/read.png b/docs/user-guide/images/read.png new file mode 100644 index 0000000000..db308a772f Binary files /dev/null and b/docs/user-guide/images/read.png differ diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md new file mode 100644 index 0000000000..ee86d6e64f --- /dev/null +++ b/docs/user-guide/index.md @@ -0,0 +1,54 @@ +# Twake-Mail user guide + +This guide intends to present features present in Team-Mail and how to use them. + +It aims at helping users discover the user experience and advanced productivity features present in Team-Mail. + +This guide provides information both for mobile and weg + +## Features covered + + - [Installing the application](#install) + - [Authentication](#auth) + - [Reading and acting on emails](#read.) + - [Writing emails](#composer) + - [Using folders to sort emails](#folder) + - [Quota](#quota) + - [Searching your emails](#search) + - [Managing your account](#profile) + - [Anti-spam](#1) + - [Extra features](#2) + +We also have a page for advanced users looking for [productivity tips](#tips). + +## Main + +![Group 7 (1)](https://github.com/user-attachments/assets/392380b7-baaf-4e72-b175-fa98235c7b27) + + +Once [logged in](#auth) into Team-mail, Team-Mail redirects you to your INBOX (1). This is where you can [read your newly arrived emails](#read). + +The left panel (2) allows you to switch of folder (view emails within another folder), and [manage your folders](#folder). +The left pannel also displays [quota](#quota) information might you need to. + +The search bar (3) at the top allows to [easily and quickly search your mails](#search). Many criteria are also supported within the advanced search might you need to. + +This button opens the [composer](#composer) (4), which allows to write new emails to your friends and colleagues. + +This button opens the list of applications integrated with Team-Mail for your current setup (5). + +This button allows you to open your [profile page](#profile) (6). From there you can: + - Manage your senders identities and signatures + - Set up email rules to automatically sort your mails + - Set up forwards to a third party email service + - Enable your vacation mode + - Manage folder visibility + - And change your language settings. + - This menu also enables you to log out from tmail. + +The same sections are also available on mobile. The default view is your INBOX but by clicking the folder name (7), +you can open the folder tab that allows you to access other menus. + +![Frame 4 (1)](https://github.com/user-attachments/assets/9f46f6ce-df19-4611-9a40-059d521bff68) + + diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md new file mode 100644 index 0000000000..ff14823d7a --- /dev/null +++ b/docs/user-guide/install.md @@ -0,0 +1,81 @@ +# Install Twake Mail application {#install} + +This small guides explains how to install Twake-Mail applications on your devices. + +## Android devices + + **-> How to install the app from the store** +1. Open Google Play Store: Open the Google Play Store app on your Android device. It usually has a shopping bag icon with a colorful triangle. +2. Search for the App: Use the search bar at the top to search for Twake Mail application +3. Select the App: When you find the app, tap on it to open its details page. +4. Install the App: On the app's details page, tap the "Install" button. +5. Wait for Download and Installation: The app will download and install automatically. Once it's installed, the "Install" button will change to "Open." +6. Open the App: You can open the app by tapping "Open" on the app's page or finding its icon in your app drawer. + +![Frame 5 (1)](https://github.com/user-attachments/assets/88debfc3-e66c-4df7-bcf5-3ffecb8d5494) + + + +**-> Which rights the application needs and why?** + +1. Contacts +- When you open Twake Mail app for the first time,and you click Compose button, you will be asked to grant permission for Contacts. When you compose an email, Twake Mail will search your phone contacts and suggest the appopriate recipients + +![Frame 6 (1)](https://github.com/user-attachments/assets/cabfada0-10c1-4486-b6d0-961757244fe0) + +2. Storage: + +- When you are composing an email and you click on icons to attach a file or picture from your phone, you will be asked to grant permission for Storage: + +![Frame 7 (1)](https://github.com/user-attachments/assets/50bcb971-74b1-4a68-8b7a-9d5c017324f2) + + **-> Where to manage rights of the application?** + +1. Open Settings: Go to the "Settings" app on your Android device. + +2. Apps or Application Manager: Scroll down and look for an option like "Apps," "Applications," or "Application Manager." Tap on it. + +3. Select the App Twake Mail: +- Look for an option called "Permissions" or "App Permissions" within the app settings. This will display a list of permissions that the app has requested or been granted. + You can toggle individual permissions on or off, depending on your preferences. + +![Frame 8 (5)](https://github.com/user-attachments/assets/d05e974d-f297-4aab-a454-da17ab2430ff) + + +## Ios devices + + **-> How to install the app from the store** + +1. Open the App Store: Tap on the App Store icon on your device's home screen. +2. Search for the App: Use the search bar at the top to search for Twake Mail application +3. Select the App: Once you've found the app, tap on its icon to open its details page. +4. Install the App: On the app's details page, you'll see an "Install" or "Get" button. Tap on it. You might be prompted to enter your Apple ID password or use Face ID/Touch ID for confirmation. +5. Wait for Download and Installation: The app will download and install automatically. Once it's installed, the "Install" button will change to "Open." +6. Open the App: You can now open the app by tapping "Open" on the app's page or by finding its icon on your home screen. + +![Frame 23 (1)](https://github.com/user-attachments/assets/814b5ece-ec78-4800-b526-361442f96b7a) + + +**-> Which rights the application needs and why?** + + 1. Notification +- When you open Twake Mail app for the first time, you will be asked to grant permission for Notifications: + + 2. Contacts +- When you open Twake Mail app for the first time and you click Compose button, you will be asked to grant permission for Contacts. When you compose an email, TwakeMail will search your phone contacts and suggest the appopriate recipients + +![Frame 24 (1)](https://github.com/user-attachments/assets/a4140927-ac49-4c1c-8b42-218ecdf406dd) + + + **-> Where to manage rights of the application?** + +1. Open Settings: Go to the "Settings" app on your iOS device. + +2. Scroll down and Select the App TwakeMail: + +This will display a list of permissions that the app has requested or been granted. + You can toggle individual permissions on or off, depending on your preferences. + +![Frame 25 (1)](https://github.com/user-attachments/assets/d9698277-b795-4ce7-b5ba-66562f2c8e69) + + diff --git a/docs/user-guide/manage-folders.md b/docs/user-guide/manage-folders.md new file mode 100644 index 0000000000..4f70d2ce18 --- /dev/null +++ b/docs/user-guide/manage-folders.md @@ -0,0 +1,108 @@ +# Manage folders - Web {#folder} + +The left panel of the main view displays folders of this account. + +Folders offers a way to sort and arrange your emails. By clicking on a folder you can see the emails contained in it. A given mail +can only be in one folder. + +![Group 8 (2)](https://github.com/user-attachments/assets/e20ecc8f-b88e-4d6f-944b-fdf78c192525) + + +(1) Next to each folder is displayed the mailbox counter: how many emails are unseen in this folder. + +(2) At the top are displayed mailbox system folders with special roles, this includes: + + - `INBOX`: this is where the new emails arrives by default. + - `Sent`: This is where to store your sent messages + - `Archive`: this is the base folder for your archives: archiving actions moves emails to the right sub-folder based on the sending date. Note that archiving action is not currently implemented. + - `Drafts`: this mailbox lists drafts, emails that had been saved while writing them in the composer. Clicking on an email in this mailbox +will open it in the composer. Drafts are removed once sent. + - `Outbox`: this mailbox displays emails that you sent and are currently processed. Once fully sent they are moved to the `Sent` mailbox + - `Spam`: this mailbox is where messages detected as spam arrives. Read more about [spam handling in Twake_mail](anti-spam.md) + - `Templates`: This mailbox holds your templates. Templates can be re-opened as new mails in the composer, and simplifies the task of frequently sending similar emails. Note that templates special actions is not currently implemented. + - `Recovered`: This is the storage when you restored deleted messages + +Personnal folders section list folders you did create. They are alphabetically ordered. Note that they are displayed as a tree: subfolders are attached to their parent folders, and tree entries can +be folded, unfolded based on your needs. + +(3) One can create extra folders if needed. This will open the `create folder` dialog, letting you select a base folder (defaults to `All mailboxes`) and choose a mailbox name. + +![Create mailbox dialog](images/create-folder.png) + +(4) Let's you find folders by name. This is convenient when you have numerous folders. Note that folder search display both visible and hidden folders. + +![Folder search](images/folder-search.png) + +Users can perform the following actions on folders: + +![Group 9 (1)](https://github.com/user-attachments/assets/327ff7d3-181f-43a9-ba19-8279bd3d9bf5) + + +Those actions includes: + + - (a) Open this folders into a new Tab. + - (b) Create a sub folder under this folder. + - (c) Mark all the emails in this folder as read. This will schedule a task marking you emails as read, eventually decreasing the mailbox counters to 0. + - (d) Move folder allows you to select a new parent folder for a given mailbox. + - (e) Rename a mailbox let you specify a new name for this mailbox. + - (f) Delete mailbox + - (g) Hidde mailbox removes the folder from the folder list without deleting it. You may show this folder again by setting it as visible in the folder visibility tab of your + + +# Mobile + +After log-in to TwakeMail app, you can see default folder is INBOX. When you click on hamburger icon, You can see your folder list + +(1) Next to each folder is displayed the mailbox counter: how many emails are unseen in this folder. + +(2) At the top are displayed mailbox system folders, this includes: INBOX,Sent, Archive, Drafts, Outbox, Spam, Templates, Recovered + +Personnal folders section list folders you did create. They are alphabetically ordered. Note that they are displayed as a tree: subfolders are attached to their parent folders, and tree entries can +be folded, unfolded based on your needs. + + +(3) One can create extra folders if needed. This will open the create folder dialog, letting you select a base folder (defaults to All mailboxes) and choose a folder name. + + +(4) Let's you find folders by name. This is convenient when you have numerous folders. Note that folder search display both visible and hidden folders. + +![Frame 9 (3)](https://github.com/user-attachments/assets/a92c6db5-b35a-4b1f-9698-9bc70efa27ed) + +Users can perform the following actions on folders: + + - (a) New sub- folder + - (b) Mark all the emails in this folder as read. This will schedule a task marking you emails as read, eventually decreasing the mailbox counters to 0. + - (c) Move folder allows you to select a new parent folder for a given mailbox. + - (d) Rename a folder let you specify a new name for this mailbox. + - (e) Delete folder + - (f) Hide folder removes the folder from the folder list without deleting it. You may show this folder again by setting it as visible in the folder visibility tab of your [profile](profile.md). + +On mobile, you can long- press on a folder to see the possible actions for that folder, or you can click button Select on top right then select the folder you want, then the possible actions will be appears at the bottom of screen. + +![Frame 10 (2)](https://github.com/user-attachments/assets/54e99381-d648-4944-966a-bc4f63f239c5) + + +# Specific folder actions: + +## Empty Trash or Delete all Spam emails: +This action will permanently delete all items in Trash/Spam (In web you can click Clean button next to the folder's name) +## Enable/Disable Spam report +- On actions list of Spam folder, you can see option: Enable/Disable spam report +- If you enable Spam report, when you log-in to Twake Mail, you can see a banner that shows report of new Spam messages. +- If you disable Spam report, you will not see the spam banner + +![image 41](https://github.com/user-attachments/assets/5216dd7f-1640-4ce0-b84a-05c9ce98f979) + +![Frame 11 (1)](https://github.com/user-attachments/assets/5d59f2df-1ba8-42d8-ba2c-479f01ef1231) + +## Recovered deleted messages: This action allow to restore deleted messages. +- On actions list of Trash folder, you can see option: Recover deletd messages +- If you select this option, there will be a screen that allows you to input criteria, then click Restore button +- Then the deleted messages which matched inputted criteria will be recovered and saved in folder: "Recovered". The maximum for each recovery is 5 messages + +![image](https://github.com/user-attachments/assets/ed8075bb-839c-46d8-a339-14ec54b942e7) + +![Frame 12 (1)](https://github.com/user-attachments/assets/23d19dea-6294-4347-877f-aa47f81d610a) + + + diff --git a/docs/user-guide/pro-tips.md b/docs/user-guide/pro-tips.md new file mode 100644 index 0000000000..0109a4fcd2 --- /dev/null +++ b/docs/user-guide/pro-tips.md @@ -0,0 +1,167 @@ +# Twake-Mail productivity tips {#tips} + +This page makes a list of all features that Twake Mail advanced users would love. + +## Drag and drop mails + +You can use this feature to move email to another folder + +1. On the email listing view of a folder, find the email you want to move and long-press (tap and hold) it. After a moment, the email will be selected. + +2. While still holding the email, drag it to the desired folder or label. You can scroll through your folders list by dragging the email to the edge of the screen. + +3. Once you have dragged the email to the desired location, release your finger to drop the email. It will be moved to the new folder accordingly. + +You can also select multiple emails by tapping on the sender's profile picture or icon and then dragging them together to the desired location. + + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/ab25efe7-9063-477e-af22-1d7a2617ca3f) + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/4e661adb-d100-451f-94cb-17f4a373b5d3) + + +If you accidentally drag and drop an email, you can quickly undo the action on the pop-up + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/35375803-05f5-4031-b15a-467b8e7cae84) + + +## Drag and drop recipients + +This feature will help you to move recipents easily between fields "To", "Cc", "Bcc" when you compose an email + +1. Either start composing a new email or open an existing email draft where you want to modify the recipients. +2. Look for the area where you add recipients to your email. Typically, this is the "To," "Cc," or "Bcc" field +3. Holding down the recipient's email, drag it to the desired recipient field. For example, if you initially placed the recipient in the "To" field but want to move them to the "Cc" field, drag the recipient to the "Cc" field. +4. Once you have dragged the recipient to the correct field, release your finger (on a touchscreen device) or release the mouse button (on a computer). The recipient should now be moved to the new location. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/99f81433-2f53-4e93-bcb6-993b884d5b9f) + +## Drag and drop text + +This feature allows users to drag text from outside the email composer or message box and drop it inside , making it a convenient way to share information between different applications or sources. + +1. Open Applications: Start by opening the application from which you want to copy text (such as a web page, document, or another app) and the email application where you want to compose your email. + +2. Select and Hold Text: + +In the source application, locate the text you want to copy. Tap and hold the text (on touchscreen devices) or click and hold (with a mouse on computers) until you see handles appear around the selected text. These handles indicate that the text is ready to be moved. + +3. Drag the Text: + +While holding down the selected text, drag your finger (on touchscreen devices) or move the mouse cursor (on computers) to the email composer or message box in the destination application. + +4. Drop the Text: + +Once you are hovering over the email composer or message box, release your finger (on touchscreen devices) or release the mouse button (on computers). The text will be dropped inside the composer. + +You can also Drag and Drop Text Within a Composer when composing an email + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/81b234ab-754a-4cdb-bad6-bd0f09f4aa31) + + + +## Drag and drop attachments + +**Drag and drop attachments from previous email** + +1. Access Previous Email: Open the email that contains the attachment you want to move or copy. + +2. Select and Hold the Attachment: Click and hold the attachment you want to move or copy. On a touchscreen device, tap and hold the attachment. + +3. Drag the Attachment: While holding down the attachment, drag it to the email composer, the composer is shadowed with a text "Drop file here to attach" + +4. Drop the Attachment: Release the mouse button (on a computer) or lift your fingFer (on a touchscreen device) to drop the attachment. + + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/ffbbe0c7-65ae-408d-b2e7-404405e90fb3) + +**Drag and drop attachment from my PC** + +Start Composing an Email: + +1. Begin composing a new email or open an existing draft where you want to attach a file. + +2. Open the File Explorer on your computer. + +3. Locate the File: Navigate to the location where the file you want to attach is stored. + +4. Select and Hold the File: Click and hold (on a computer) on the file you want to attach. + +5. Drag the File: +While holding down the file, drag it over to the email composer. The composer is shadowed and : + +- If I drop selected image, it will be added as inline image +- If I drop selected file which is not image, it will be added as an attachment + +I can select multiple files then drag and drop to the composer to add them as attachments. + + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/343e91ca-e533-4fee-a6b4-243e405a0c01) + +## Creating email rules + +This feature allows user to create email rule quickly in email detail without opening the email rule setting: + +1. Open the email that you want to create a rule for. +2. Click on 3-dots button on top right of screen then select option :"Create a rule with this email". A dialog box will appear. +3. Define Rule Criteria: +In the dialog box, the condition is automatically filled based on the current email : "From" - "Contains" - "Sender email" +4.Choose Actions: +Choose the actions you want the rule to perform. +5. Give your rule a name, and click "OK." + +![image](https://github.com/user-attachments/assets/5507e841-308f-4f7a-9cdc-c2333a22482f) + +![image](https://github.com/user-attachments/assets/3bb1c427-34a3-46a4-bdf4-92431844f128) + + +## Email navigation + +- When you open an emal, you can easily navigate to older/newer email content by clicking on previous/next icons on top right: + +![Group 10 (2)](https://github.com/user-attachments/assets/bbfc8fbb-fd4f-4092-a944-a3da705c3783) + + +## TAB in the composer + +- When I am composing an email, I can use TAB key to move the cursor between different fields in the email composition window, such as the "To," "Subject," and "Body" fields. + +## Email address actions + +- When I click on an eail address, a dialog of actions will be shown incliduding: + + ![image](https://github.com/user-attachments/assets/da287a10-3d95-49ec-829b-65de44a8bbd4) + + +(1) Copy email address: The email address is copied to your clipboard and can be pasted elsewhere. + +(2) Create a rule with this email: This will open Create email rule dialog, with the condition is prefilled :"From" - "Contains" - "Sender email". You can input name and define action to create email rule. + +![Group 11 (1)](https://github.com/user-attachments/assets/208787fa-8378-4266-807d-b1801a7205c5) + +(3) Compose email: This will open the composer with the recipient is prefiied with this email address + +![image](https://github.com/user-attachments/assets/a9edba0d-2a6d-4eab-bdf7-41e40f4b96e9) + + +## Spell check + +Spell check features is designed to help you identify and correct spelling and grammar errors in yout messages. + +1. Compose a New Email: +Open your Tmail account and start composing a new email. +2. Text Input Area: +Type your message in the text input area. The spell check is automatically enabled. +4. Automatic Underlining: +As you type, the spell check feature will automatically underline words that it identifies as potentially misspelled. +5. Right-Click Correction: +To correct a misspelled word, right-click on the underlined word. A context menu will appear with suggested corrections. +7. Correcting Suggestions: +Review the suggested corrections and choose the correct one by clicking on it. Alternatively, you can manually correct the word by typing the correct spelling. + + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/7e4e9154-c0fc-416b-ae7f-1866d8d28c99) + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/04880647-a006-4511-9fa1-85df468a8cce) + + diff --git a/docs/user-guide/profile.md b/docs/user-guide/profile.md new file mode 100644 index 0000000000..720f0a31d3 --- /dev/null +++ b/docs/user-guide/profile.md @@ -0,0 +1,343 @@ +# Profile {#profile} + +After logged in your Tmail account, click on avatar on top right then select option "Manage account" + +![image](https://github.com/user-attachments/assets/3771e3f7-8071-466b-9bed-30424e29ae7a) + + +On Mobile, after you loggin TeanMail application, click on hamburger button => then select Manage account, the Settings screen will be displayed. + +![Frame 13 (1)](https://github.com/user-attachments/assets/7ae8b5c2-ef36-4340-8282-d9a827e8508a) + + +The profile page allows you to: + + - [Manage your senders identities and signatures](#identities) + - [Set up email rules to automatically sort your mails](#email-rules) + - [Set up read receipt request](#email-read-receipts) + - [Set up forwards to a third party email service](#forwarding) + - [Enable your vacation mode](#vacation-mode) + - [Manage folder visibility](#folder-visibility) + - [Change your language settings](#language-settings) + - [This menu also enables you to log out from tmail](#logout) + +![image](https://github.com/user-attachments/assets/2ef0e91c-c1fd-46f9-9984-1da373cf6765) + + +## Identities + +Email identities allow you to manage multiple personas from a single email account. This can be useful for personal, professional, or organizational purposes. Each identity can have its own name and signature. +When you're in Profle page, you can see your identity list + +### 1. Create a new identity + +#### On Web + +- (1) Click on "Create New Identity" button +- (2) Enter the name for the identity. +- (3) Email: Specify the email address associated with this identity. You can select one email from drop-down list. +- (4) Reply to: Specify the email address that will appear on recepient's composer when he reply to your email +- (5) BCC: When you compose a new email wiht this identity, the emails in this field will be added to "Bcc" field of composer automatically +- (6) Customize the signature if needed. +- (7) Set as default identity: When an identity is set as dedault, its settings such as signature, BCC... will be used when you compose a new email. You can still change to a non default identity by selecting it in the composer. +- (8) Click button Create to save the new identity. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/44f74874-2eff-4aa5-97e5-a267d5a26b71) + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/9a02fdae-6aa6-46c2-b599-1bc4d54fb717) + +- You can include an image in signature of the identity, .eg company logo, product logo, project logo.... The image is sent in every email, so it should be an small image (less than 16KB). + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/f114e9c6-5674-42cb-9fc7-6d7404bc972f) + +#### On mobile + +- (1) Click on "Create New Identity" button +- (2) Enter the name for the identity. +- (3) Email: Specify the email address associated with this identity. You can select one email from drop-down list. +- (4) Reply to: Specify the email address that will appear on recepient's composer when he reply to your email +- (5) BCC: When you compose a new email wiht this identity, the emails in this field will be added to "Bcc" field of composer automatically +- (6) Customize the signature if needed. +- (7) Set as default identity: When an identity is set as dedault, its settings such as signature, BCC... will be used when you compose a new email. You can still change to a non default identity by selecting it in the composer. +- (8) Click button Create to save the new identity. +- (9) - You can include an image in signature of the identity, .eg company logo, product logo, project logo.... The image is sent in every email, so it should be an small image (less than 16KB). + +![Frame 8 (1)](https://github.com/linagora/tmail-flutter/assets/68209176/81057675-e258-45d6-baac-752047634fbf) + + +### 2. Edit an existing identity + +#### On Web + +- On identity listing you select radio button of the identity that you want to Edit then touch Edit icon +- On Edit identity screen, you can modify the fields Name, Reply to, Bcc, or signature as required. +- Save your changes. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/5d49cb1b-796a-4815-8ec8-174bef26da66) + +#### On mobile + +- On identity listing you click on the one that you want to Edit then select Edit button +- Modify the fields Name, Reply to, Bcc,checkbox "Set as default", or signature as required. +- Save your changes + +![Frame 9](https://github.com/linagora/tmail-flutter/assets/68209176/5bc30886-692d-41b9-ba2a-345a7e59b247) + +### 3. Delete an Identity + +#### On Web + +- On identity listing you click on the one that you want to Delete Then select Delete button + +- Confirm the deletion. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/4c2204fd-2c5a-4096-a15f-02f804daa6dd) + +### On Mobile + +- On identity listing you click on the one that you want to Delete Then select Delete button + +- Confirm the deletion. + +![Frame 10](https://github.com/linagora/tmail-flutter/assets/68209176/48ffb00f-e44d-4397-9cb3-e83c150d24a9) + + +## Email rules + +- Email rules, also known as filters are powerful tools that allow you to manage your inbox by automatically sorting, moving to a folder, forwarding, or taking other actions on incoming emails. +- In Manage account page, When select "Email rules" on the left menu, you can see the list of current rules + +![Group 12 (1)](https://github.com/user-attachments/assets/a0acc2e2-0ee0-49a9-b68e-20b19cdc469b) + + +![Frame 11](https://github.com/linagora/tmail-flutter/assets/68209176/1385bf23-1c64-46ef-a58c-3eaaef408218) + +### 1. Create a rule + +#### On Web + +- (1) Click on `Add Rule` button +- (2) Select to apply all conditions or any of the conditions below +- (3) Name your rule for easy identification. +- (4) Define the conditions that trigger the rule (e.g., sender, Recipient, subject...). You can click "Add condition" to add more conditions to apply in this rule +- (5) Specify the actions to be taken when the conditions are met (e.g., move to a folder, mark as read). You can click:"Add action" to add more actions to apply in this rule +- (6) Save the new rule. + + +![Group 13 (1)](https://github.com/user-attachments/assets/802bfb24-04c1-4312-a71b-b1169bfc12ac) + + +- The new rule will be applied for upcoming emails. The order to applied email rules is from the latest created date to the earliest created date of filters. + +#### On Mobile + +![Frame 14 (1)](https://github.com/user-attachments/assets/30334a28-ea89-4d12-b969-255d68cbfe91) + +- The new rule will be applied for upcoming emails. The order to applied email rules is from the latest created date to the earliest created date of filters. + +### 2. Edit an Existing Email Rule + +#### On Web +- On the email rule listing, click on Edit icon of the rule you want to edit. +- Modify the conditions or actions as needed. +- Save your changes. + +![Group 14 (1)](https://github.com/user-attachments/assets/81751c82-3396-4de1-b5e9-88d26e4d4016) + +#### On mobile +- On the email rule listing, I click on three-dot button of the rule that I want to Edit, then select option Edit +- Modify the conditions or actions as needed. +- Save your changes. + +![Frame 15 (1)](https://github.com/user-attachments/assets/cd37997f-ac93-4d24-abf0-589ff4c05cac) + +### 3. Delete an email rule + +#### On Web + +- On Email rules listing you click on Delete icon beside the one that you want to Delete +- Confirm the deletion. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/af475797-0afe-47d8-b060-8ec5b50f8fbc) + +#### On mobile + +- On the email rule listing, I click on three-dot button of the rule that I want to Edit, then select option Delete +- Confirm the deletion. + +![Frame 14](https://github.com/linagora/tmail-flutter/assets/68209176/195ffd52-b62d-418b-a6b5-18e0e8d2425d) + +## Email read receipts + +- To find out when an email that you sent was opened, you can request a read receipt. A read receipt is sent to you as an email with the time and date of when your message was opened. +- This setting allows you to automaticaly enable the read receipt for any email that you sent: + +![image](https://github.com/user-attachments/assets/82802328-c9c7-4dc7-84f6-d17c9bf2d5f7) + +![Frame 19 (3)](https://github.com/user-attachments/assets/405fc2c6-2f29-4761-aae4-289c46f0abde) + +- When you compose a new message, read receipt is enabled by default: +![Group 21 (2)](https://github.com/user-attachments/assets/f8c71219-a474-4df4-a1f4-79102cbdfaf8) + + +## Forwarding + +- This feature allows you to automatically send emails you receive to another email address. +- In Manage account page, When select "Forwarding" on the left menu, you can see the list of forwarding email addresses. + +![image](https://github.com/user-attachments/assets/0080a1b6-4296-4caa-b0f4-ae6d3bd482bb) + + +![Frame 16 (1)](https://github.com/user-attachments/assets/d0c47b1b-0ae7-4137-945a-6591bb571194) + + +### 1. Add the forwarding addesses + +#### On Web + +(1) Enter the email address to which you want to forward your emails. You can input multiple email addresses + +(2) Click `Add recipient` buton to save your changes, there will be a successfull notification + +(3) Choose whether to keep a copy of forwarded emails in your original inbox: By default, the toggle is enabled. + - When you enable this toggele, when a new email arrives in your inbox, it is automatically forwaded to the list of recipients below and the email is till in your inbox. This could be helpful in some cases as: + - Consolidating Emails: Forward emails from multiple accounts to a central inbox for easier management. + - Backup: Automatically forward emails to a backup email address + - Forward emails at work to a personal mailbox in your vacation to ensure you don't lose important messages. + - Handle your departure + - ... + - When you disable the toggle, when a new email arrives in, it is automatically forwaded to the list of recipients below and the email is not kept in your inbox. + +![Group 15 (2)](https://github.com/user-attachments/assets/dc0c9be1-aae6-49a5-ad5d-63f998e737c0) + +![Group 16 (1)](https://github.com/user-attachments/assets/42acd010-2182-49c0-83c3-9cb37bfd85be) + + +#### On Mobile + +![Frame 17 (1)](https://github.com/user-attachments/assets/1fe100e3-b0ee-4a54-b3d1-33e1869e5295) + + +### 2. Delete forwading addesses + +#### On Web + +- If you no longer wish to forward your email, you can remove the forwarding email address. +- You can click Delete icon in each forwading address or select multiple addersses (1) then click button `Remove` (2) +- Confirm the deletion (3) + +![Group 17 (1)](https://github.com/user-attachments/assets/4489b283-e051-4963-90da-c5baf2284d87) + + +#### On Mobile + +- You can click Delete icon in each forwading addess (1) or select multiple addesses (2) then click button `Remove` (3) +- Confirm the deletion + +![Frame 18 (1)](https://github.com/user-attachments/assets/b4696bf4-3ece-40bf-9164-dee6e3a339d6) + + +## Vacation mode + +- Automatic vacation replies are messages that are sent automatically to anyone who emails you while you're on vacation. +- Setting up automatic vacation reply is a convenient way to inform your contacts that you're away and won't be able to respond to emails promptly. +- On Manage accout page, YOu can select tab "Vacation" on left menu to access vacation reply settings + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/f2743333-bc42-4cc7-a50e-81121c43a355) + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/eb7a77dc-486f-4733-beb8-f33d4a338299) + + +### 1. Vacation setting + +#### On Web + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/f2743333-bc42-4cc7-a50e-81121c43a355) + +- (1) Turn on the toggle :`Automatically reply to messages when they are received` +- (2) Setting the Date Range: Specify the start and end dates/times for your automatic replies. This ensures that the messages are sent only during your vacation period. +- End date is optional. If you can turn off the toggle `Vacation stops at', it means the vacation does not have an end date and your vacation responder will work until you turn it off or change the setting. +- (3) Subject: Input the automatic reply email's subject +- (4) Compose your vacation reply message. Rich-text options are available +- (5) Save changes. You need to click this button so that your input is applied. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/8bf8aba2-4a1c-4e0f-baca-af02c9fe9ebf) + +When the vacation is enabled, there will be a vacation banner in every screen until the vacation ends or you turn off it: +- (1) When you click on `Turn off`, the vacation responder is disabled immediately and the banner disappears +- (2) When you click on `Vacation setting`, it will open vacation setting page. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/6ddff98e-daf3-42e4-bb46-5b70f11d455a) + +#### On Mobile + +- (1) Turn on the toggle :`Automatically reply to messages when they are received` +- (2) Setting the Date Range: Specify the start and end dates/times for your automatic replies. This ensures that the messages are sent only during your vacation period. +- End date is optional. If you can turn off the toggle `Vacation stops at', it means the vacation does not have an end date and your vacation responder will work until you turn it off or change the setting. +- (3) Subject: Input the automatic reply email's subject +- (4) Compose your vacation reply message. Rich-text options are available +- (5) Save changes. You need to click this button so that your input is applied. + +![Frame 17 (1)](https://github.com/linagora/tmail-flutter/assets/68209176/4ed28990-92ee-4c15-8f07-095906aaa12c) + + +When the vacation is enabled, there will be a vacation banner in every screen until the vacation ends or you turn off it: +- (1) When you click on `Turn off`, the vacation responder is disabled immediately and the banner disappears +- (2) When you click on `Vacation setting`, it will open vacation setting page. + +![Frame 18](https://github.com/linagora/tmail-flutter/assets/68209176/79f35edf-d5b6-48f6-84a0-36738803ac26) + + +### 2. Receive vacation automatic reply + +- When a person sends an email when your vacation mode is enabled, he will receive an automatic reply with the subject and message body which are inputed in your vacation setting screen + +![image](https://github.com/user-attachments/assets/a8c4100c-4fdf-4f05-b0f9-47a3788a0dbf) + + +## Folder visibility + +- Hiding and showing folders is a useful feature that allows you to customize the view of your mailbox and focus on the folders that are most important to you. +- This feature is particularly useful when you have numerous folders but want to focus on specific ones. +- On Manage accout page, YOu can select tab "Folder visibility" on left menu to access Folder visibility settings +- You can change the visibility of personal foder and team-mailbox +- You cannot change the visibility of system folder (Inbox, Archive, Draft, Outbox, Sent, Trash, Spam, Templates) +- In the folder list, If a folder is currently hiden, there will be a button `Show` next to it. If you click on this button, the folder will be shown on the left folder menu of your mailbox +- In the folder list, If a folder is currently shown, there will be a button `Hide` next to it. If you click on this button, the folder will be hidden on the left folder menu of your mailbox + +![Group 18 (1)](https://github.com/user-attachments/assets/f3c5046f-71a2-4660-b52f-6a344f2a5796) + + +![Frame 19](https://github.com/linagora/tmail-flutter/assets/68209176/950010b0-144e-4708-b254-965e9191d081) + + +- You can also click on 3-dot button of a folder then select option "Hide folder, the folder will be hidden immediately + +![Group 19 (1)](https://github.com/user-attachments/assets/be66eb05-c1c9-4ae7-a7a8-b7d273a2357a) + + +- On mobile, when you long-press on a folder, there will be a bottom sheet menu that contains option "Hide folder" + +![Group 142](https://github.com/linagora/tmail-flutter/assets/68209176/65ab7fb3-0b5e-4dbb-9a97-27a659c38b73) + +## Language settings + +- Language setting determinse the language in which you view content, communicate, and interact with TwakeMail application +- By default, the language of the browser (for web) or system language (for mobile) will be used when you first logged-in TwakeMail and you can change it to your prefered language +- On Manage accout page, YOu can select tab "Language and regions" on left menu to access Language settings +- Then you can select the language that you want, it will be applied immediately to your Twake-Mail account. + +![image](https://github.com/user-attachments/assets/3ba8d626-8630-4ec2-8057-186f8ee33c0e) + +![Frame 23](https://github.com/linagora/tmail-flutter/assets/68209176/946e08c8-5ac7-4cb7-ae9d-c2d4a795d717) + +## Logout + +- When you click on Sign-out button on Left menu of Manage account page, you will be logged out immedialtely and redirected to Log-in screen: + +![Group 20 (1)](https://github.com/user-attachments/assets/937aee13-0a9c-424b-a125-115e560c5735) + +![Frame 21](https://github.com/linagora/tmail-flutter/assets/68209176/d784381a-f5b7-4f32-a665-f52215bdb753) + + + diff --git a/docs/user-guide/quota.md b/docs/user-guide/quota.md new file mode 100644 index 0000000000..1cbf858832 --- /dev/null +++ b/docs/user-guide/quota.md @@ -0,0 +1,38 @@ +## Quota information {#quota} + +After logged in your Tmail account, you can see a quota banner at the bottom ofthe left folder tree: + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/6b26f858-18f6-4d18-84da-d3d19b2e384e) + +For mobile, when you access folder tree menu, you can see the quota banner at the bottom of the screen: + +![Frame 34](https://github.com/linagora/tmail-flutter/assets/68209176/8e4c76d5-0483-48f2-88b0-c00ddc91a241) + +This banner includes information: + - Used quota: This shows how much of your allocated storage space you are currently using. + - My account's quota limit: This indicates the total storage space allocated for your account. + +## Warning when the quota reaches the limit + +When your used quota/limit reaches 90%, there will be a floating warning banner at the top of mail list view + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/fb9a14c0-2a6c-4c23-972f-1eebb5827ad8) + +![Frame 35 (1)](https://github.com/linagora/tmail-flutter/assets/68209176/b7c2de24-4729-49f8-af92-408d389a24a9) + +When my storage 100% used, there will be a floating warning banner at the top of mail list view. Now you cannot send or receive email. + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/aafec90b-b421-405a-af8b-cae562b23dea) + +![Frame 36](https://github.com/linagora/tmail-flutter/assets/68209176/00f3585b-2dc1-4f65-b2a6-db9318e975eb) + +### Maximum file size + +When you are composing an email, add some attachments then click button Send, If the maxsize of the email is larger than limitation, there will be an error message" + +![image](https://github.com/linagora/tmail-flutter/assets/68209176/76760001-a821-4553-99ad-fb43747320fb) + + +![Frame 37](https://github.com/linagora/tmail-flutter/assets/68209176/c6977eb9-0f75-441d-af21-db13a52e9dce) + + diff --git a/docs/user-guide/read.md b/docs/user-guide/read.md new file mode 100644 index 0000000000..d1240cca29 --- /dev/null +++ b/docs/user-guide/read.md @@ -0,0 +1,159 @@ +# Reading emails {#read} + +This page explains how to read your emails and explains which actions can be performed on your emails. + +**On Web** + +![Group 22 (2)](https://github.com/user-attachments/assets/c563f638-b778-4541-b3b4-ac98562cb396) + + +**On mobile** + +![Frame 24 (3)](https://github.com/linagora/tmail-flutter/assets/68209176/2ccd6fb9-96cc-4a9e-b89c-783c09fa0dc6) + + +The right panels allows one to read his email. It shows emails within a folder, organized by time. + +Here are the information added to each mails in the mailbox listing: + + - (1) `From`: the identity (firstname, lastname and mail address) of the sender of the email. + - (2) The `date` at which the email was sent + - (3) The `subject` of the email + - (4) If the email has `attachments` then the attachment icom will be displayed + - (5) If the email is `starred` + - (6) If the email is read or not + - (7) If the email forwarded + - (8) If you answered to this mail + - (9) If you both answered and forwarded the mail + +Note the button to reload and look for new emails on the server. +For mobile, you can scroll down to reload and get the new emails from the server. + +## Open en email + +**On web** + +You can open emails by clicking on them: + +![Group 25 (2)](https://github.com/user-attachments/assets/e48b113e-9ef8-4fa6-bf04-f79e3bd7f193) + + +**On mobile** + +![Frame 25](https://github.com/linagora/tmail-flutter/assets/68209176/327e0aee-1513-4000-b524-58b188250112) + + +Here are the information you can see when opening an email: + + - (1) `From`: the identity (firstname, lastname and mail address) of the sender of the email. + - (2) `To`: the identities of the people this email is written to. + - (3) `Cc`: the identities of the people in copy of this email + - (4) The `date` at which the email was sent + - (5) The `folder` in which the email is located + - (6) The `subject` of the email + - (7) The `attachments` of the email. You can download them by clicking them. + - (8) The body of the email, containing its main message. Long emails might require you to scroll in order to read them fully. + - (9) If the email is `starred` + - (10) The navigation arrows allowing to go directly to next or previous email. + +If the sender requested a read receipt, then Twake-Mail will prompt you to send the receipt when you open the email. Twake-Mail will remember your decision. + +![image 59](https://github.com/linagora/tmail-flutter/assets/68209176/47dfeb99-1801-419f-8d29-6bd84e5a3cb5) + +![Frame 26](https://github.com/linagora/tmail-flutter/assets/68209176/24ba1c39-e0de-4900-ac6a-9003e822e173) + + + +## Email actions + +**On web** + +When reading emails, a user can perform some actions on it. + +Quick actions are available in one click and are shown when putting the mouse on an email item: + +![Per email action](images/action1.png) + +Available actions includes: + + - (1) Open this message in a new tab (instead than on the current one) + - (2) Mark as read / mark as unread + - (3) Move this message into another folder. It opens a dialog window to let you choose the target folder. +Note that on web this action can be performed via a drag and drop: take the email and drop it into the target mailbox. + - (4) Move this email to the tash. Same as (3) but you do not have to select the target folder. Note that emails can only be deleted in the Trash (this action is then replaced by "Delete Permanently" +in this mailbox). + - (5) Extra actions are also available: Open this email in a new tab and report this email as Spam (which moves this email into the Spam mailbox. THis email will eventually be reported as Spam to +our anti-spam). + - (6) Mark this message as `starred` + +One can select email by clicking on the sender icon: + +![Actions on selected mails](images/action2.png) + +Actions on selected emails are applied on all selected mails and include: + + - (1) Mark as read / mark as unread + - (2) Mark this message as `starred` + - (3) Move this message into another folder. Note that on web this action can be performed via a drag and drop: take the email and drop it into the target mailbox. + - (4) Report this email as Spam (which moves this email into the Spam mailbox. THis email will eventually be reported as Spam to our anti-spam). + - (5) Move this email to the tash. Same as (3) but you do not have to select the target folder. Note that emails can only be deleted in the Trash (this action is then replaced by "Delete Permanently" +in this mailbox). + +Actions can also be performed on opened emails: + +![Group 34 (1)](https://github.com/user-attachments/assets/bcca4a7f-7e0f-4aa3-8a63-3ed585b7293a) + +Actions on opened email include: + + - (1) Reply/Reply all. It opens a composer, adds `Re:` prefix before the topics, set the sender of the previous email as a `To` recipients and quotes the previous email. + - (2) Forward this mail. It opens a composer, adds `Fwd:` prefix before the topics, quotes the previous email, and let you sepcify the recipients you want. + - (3) Move this message into another folder. It opens a dialog window to let you choose the target folder. + - (4) Mark this message as `starred` + - (5) Move this email to the tash. Same as (3) but you do not have to select the target folder. Note that emails can only be deleted in the Trash (this action is then replaced by "Delete Permanently" +in this mailbox). + - (6) Extra actions are also available. They are detailed below. + - (7) Mark as read / mark as unread + - (8) Report this email as Spam (which moves this email into the Spam mailbox. This email will eventually be reported as Spam to our anti-spam). + - (9) Create an [email rule](profile.md#email-rule) for this email. Email rules allow to declare criteria upon which matching emails would be moved to a folder. + - (10) Archive message: This action will move the message to Archive Folder + - (11) Download message as eml + +**On mobile** + +You can select email(s) by clicking on the sender icon: + +![Frame 27](https://github.com/linagora/tmail-flutter/assets/68209176/3bab5ff7-be24-4886-8919-683c422164e5) + +Actions on selected emails are applied on all selected mails and include: + + - (1) Mark as read / mark as unread + - (2) Mark this message as `starred` + - (3) Move this message into another folder. Note that on web this action can be performed via a drag and drop: take the email and drop it into the target mailbox. + - (4) Report this email as Spam (which moves this email into the Spam mailbox. THis email will eventually be reported as Spam to our anti-spam). + - (5) Move this email to the trash. Same as (3) but you do not have to select the target folder. Note that emails can only be deleted in the Trash (this action is then replaced by "Delete Permanently" +in this mailbox). + +Actions can also be performed on opened emails: + +![Frame 28 (1)](https://github.com/linagora/tmail-flutter/assets/68209176/47dc1bf2-ce81-403e-be90-e44a4c11ed96) + + +- (1) Reply/Reply all: It opens a composer, adds `Re:` prefix before the topics, set the sender email and all other recipients of the previous as a `To` recipients and quotes the previous email. +- (2) Forward this mail. It opens a composer, adds `Fwd:` prefix before the topics, quotes the previous email, and let you sepcify the recipients you want. +- (3) New message: It opens a new composer + - (5) Move this message into another folder. It opens a dialog window to let you choose the target folder. + - (6) Mark this message as `starred` + - (7) Move this email to the trash. Same as (3) but you do not have to select the target folder. Note that emails can only be deleted in the Trash (this action is then replaced by "Delete Permanently" +in this mailbox). + + Extra actions are also available when you click on 3-dot button on top right. They are detailed below: + +![Frame 20 (1)](https://github.com/user-attachments/assets/7983bea0-ace3-4657-8525-4311957c0728) + + + - (8) Mark as read / mark as unread + - (9) Report this email as Spam (which moves this email into the Spam mailbox. This email will eventually be reported as Spam to our anti-spam). + - (10) Create an [email rule](profile.md#email-rule) for this email. Email rules allow to declare criteria upon which matching emails would be moved to a folder. + - (11) Archive message: This action will move the message to Archive folder. + + diff --git a/docs/user-guide/search.md b/docs/user-guide/search.md new file mode 100644 index 0000000000..37cfbccfb1 --- /dev/null +++ b/docs/user-guide/search.md @@ -0,0 +1,79 @@ +# Search {#search} + +## On Web + +TMail offers you several tools to quickly find your emails. + +### Quick search + +The top search bar allows you to quickly look for your emails. Just start typing text in it, and top search results will appear interactively. + +![Group 202](https://github.com/user-attachments/assets/9cda735f-9533-4513-853d-b45b08540e82) + +Additional filters are also added for convenience. Those include: + + - (1) `Has attachment`: If checked, then only emails with attachments will be returned. + - (2) `Last 7 days`: If checked, then only returns emails sent within the last 7 days. + - (3) `From me`: Only includes emails that you sent. + +(4) allows to clear your input. + +(5) allows to enter the advanced search. + + +### Advanced search + +The top search bar button on the left opens the advanced search, allowing you to specify more criteria. + +![Group 214](https://github.com/user-attachments/assets/c54c2780-dd2b-479b-bb71-a782401d9634) + +Those criteria includes: + + - (1) `From`: Specifying who should have sent the emails returned. This field supports auto-complete on your contacts. + - (2) `To`: Specifying who the emails returned should be addressed to. This field supports auto-complete on your contacts. + - (3) `Subject`: Allow specifying words that should appear in the subject of returned emails. + - (4) `Has the word`: Specifies the word that should appear anywhere in the returned email. + - (5) `Doesn't have`: Specifies the word that should not appear anywhere in the returned email. + - (6) `Folder`: Specifies in which folder the returned emails should be placed. + - (7) `Date`: Specifies a time range in which the returned emails should have been sent. + - (8) `Sort by`: Specifies the criteria to display the result order: most recent, oldest, relevance, sender name, subject + - (9) `Has attachment`: If checked, then only emails with attachments will be returned. + +Clicking the (11) search button will launch the search and display all corresponding emails. `Clear filer` (10) will reset your input. + + +### Folder filters + +![Group 35 (2)](https://github.com/user-attachments/assets/318ae15f-a9ac-447d-b0f2-26d5d5748946) + +From the folder display you can easily apply filters to the current folder. + +Filters includes: + + - (1) All emails in this folder with attachments + - (2) All emails in this folder that are not read + - (3) All emails in this folder that are starred + +## On Mobile + +On mobile, When you click on Search bar, start typing text in it, and top search results will appear interactively. + + Under the search bar, there are some tags that allow you to specify more criteria. Those criteria include: + + - (1) `From`: Specifying who should have sent the emails returned. When you click on this tags, a new screen will be opened that allow you to input email address. The system supports auto-complete on your contacts + - (2) `To`: Specifying who the emails returned should be addressed to. When you click on this tags, a new screen will be opened that allow you to input email address. The system supports auto-complete on your contacts + - (3) `Has attachment`: If checked, then only emails with attachments will be returned. + - (4) `All time`: This field specifies the time range in which the returned emails should have been sent. Default option is "All time". When I click on this field, a new screen will be opened. + - (5) `Folder`: Specifies in which folder the returned emails should be placed. Default option is "All folders". When I click on this field, a new screen will be opened. + - (6) `Sort by': Specifies the criteria to display the result order + +![Frame 162](https://github.com/linagora/tmail-flutter/assets/68209176/af0a4d8d-2272-4e49-901a-18e40f9ebc5d) + +![Frame 22 (1)](https://github.com/user-attachments/assets/eba5f489-57f9-4491-9d7a-eee7c25cba1f) + +### Folder Filter +On mobile when you click filter icon, you can select the filter criteria to apply: + +![Frame 21 (4)](https://github.com/user-attachments/assets/4eec908e-b0ec-42d3-a793-e86b36a31847) + +