mernmail-website/docs/usage.md
Dorian Niemiec a63257f40e
Some checks failed
Deploy Next.js application / deploy (push) Failing after 10m4s
feat: add the MERNMail documentation
2024-11-08 14:40:18 +01:00

109 lines
No EOL
3.6 KiB
Markdown

# Usage
This section provides a comprehensive guide on how to use MERNMail, including the webmail functionality, composer, address book, and settings page.
## Webmail Functionality
### Inbox
The Inbox is where you receive all your emails. Here's how to navigate and manage your inbox:
- **Viewing Emails**: Click on an email to view its contents.
- **Marking as Read/Unread**: Select an email and click the envelope icon next to the email to mark it as read or unread.
- **Deleting Emails**: Select an email and click the trash icon to delete the email.
- **Searching Emails**: Use the search bar to find specific emails.
### Composer
The Composer is used to create and send new emails. Here's how to use it:
- **New Email**: Click the "Compose" button to open the Composer.
- **Recipients**: Enter the recipient's email address in the "To" field. You can also add CC and BCC recipients.
- **Subject**: Enter a subject for your email.
- **Body**: Type your message in the body of the email.
- **Attachments**: Click the "Attach" button to attach files.
- **Sending**: Click the "Send" button to send your email.
### Address Book
The Address Book helps you manage your contacts. Here's how to use it:
- **Adding Contacts**: Click the "Add Contact" button and fill in the contact details.
- **Editing Contacts**: Click on a contact to edit their details.
- **Deleting Contacts**: Click the trash icon next to a contact to delete them.
- **Searching Contacts**: Click the search icon and use the search bar to find specific contacts.
## Settings Page
The Settings page allows you to customize your MERNMail experience. Here are the sections you can configure:
### Language
- **Changing Language**: Select your preferred language from the dropdown menu.
### Notifications
- **Push Notifications**: Enable or disable push notifications for new messages.
### Theme
- **Changing Theme**: Choose between light and dark themes to suit your preference.
### Mailboxes
- **Managing Mailboxes**: Add, edit, or delete mailboxes to organize your emails.
### Identities
- **Managing Identities**: Add, or delete email identities to manage multiple email accounts.
### Signature
- **Adding Signature**: Create and customize your email signature.
- **Editing Signature**: Update your email signature as needed.
## Example Usage Scenarios
### Sending an Email
1. Click the "Compose" button to open the Composer.
2. Enter the recipient's email address in the "To" field.
3. Enter a subject for your email.
4. Type your message in the body of the email.
5. Click the paperclip icon to attach files if needed.
6. Click the "Send" button to send your email.
### Adding a Contact
1. Navigate to the Address Book.
2. Click the "New contact" button.
3. Fill in the contact details, including name, email, and phone number.
4. Click the "Save" button to add the contact.
### Changing the Theme
1. Navigate to the Settings page.
2. Go to the "Theme" section.
3. Select your preferred theme (system, light or dark).
4. The theme will be applied immediately.
### Managing Mailboxes
1. Navigate to the Settings page.
2. Go to the "Mailboxes" section.
4. Enter the mailbox name and click the "+" button.
5. To edit or delete a mailbox, click the respective icons next to the mailbox name.
### Adding an Identity
1. Navigate to the Settings page.
2. Go to the "Identities" section.
4. Enter the identity details, including name and email address.
5. Click the "Add identity" button to add the identity.
### Customizing Your Signature
1. Navigate to the Settings page.
2. Go to the "Signature" section.
3. Enter your desired signature text.
4. Click the "Save signature" button to apply the signature.