- Overview
- Features
- Installation
- Usage
- Configuration
- Customization
- Contributing
- License
- Contact
- Releases
PyMail is a terminal-based email client designed for users who prefer a lightweight and efficient way to manage their emails. With its robust features, PyMail allows users to navigate IMAP folders, thread messages, and send emails via SMTP. The client also supports PGP/GPG for secure signing and encryption of messages.
You can download the latest version of PyMail from the Releases section.
- IMAP Folder Navigation: Easily browse your email folders.
- Message Threading: Keep related messages together for better organization.
- Search Functionality: Quickly find emails with a simple search.
- SMTP-Based Sending: Send emails seamlessly from the terminal.
- PGP/GPG Support: Sign and encrypt your emails inline for added security.
- Attachments: Send and receive files with your emails.
- Drafts in Your Editor: Edit drafts in your preferred text editor.
- Customizable Shortcuts: Tailor keyboard shortcuts to fit your workflow.
- Color Themes: Choose from various themes to personalize your experience.
- Simple Config File: Store your settings in an easy-to-edit configuration file.
To install PyMail, follow these steps:
-
Clone the Repository:
git clone https://github.com/Mreshu001/PyMail.git cd PyMail -
Install Dependencies: Ensure you have Python 3.6 or higher. Install the required packages using pip:
pip install -r requirements.txt
-
Run the Application: Start PyMail by executing:
python main.py
After installation, you can start using PyMail. Here’s how to get started:
-
Launch the Application: Run the application from your terminal.
-
Login: Enter your email credentials to log in. Ensure you have enabled IMAP access in your email settings.
-
Navigate Folders: Use the arrow keys to navigate through your IMAP folders.
-
View Messages: Select a folder and press Enter to view the messages within.
-
Send an Email: Press
Cto compose a new email. Fill in the recipient, subject, and body, then send it. -
Search for Emails: Press
/to initiate a search. Type your query and hit Enter.
PyMail uses a simple configuration file to store your settings. Here’s how to configure it:
-
Locate the Config File: The configuration file is named
config.jsonand is located in the root directory of the PyMail project. -
Edit the Config File: Open
config.jsonin your text editor and adjust the settings as needed. You can set your email server, username, and other preferences. -
Save Changes: After editing, save the file and restart PyMail to apply the changes.
PyMail allows for various customizations to enhance your user experience:
- Keyboard Shortcuts: Modify the shortcuts in the
config.jsonfile to suit your workflow. - Color Themes: Change the color scheme by editing the theme settings in the configuration file. You can choose from predefined themes or create your own.
We welcome contributions to PyMail! Here’s how you can help:
-
Fork the Repository: Click on the "Fork" button at the top right of the page.
-
Create a New Branch:
git checkout -b feature/your-feature-name
-
Make Your Changes: Implement your feature or fix.
-
Commit Your Changes:
git commit -m "Add your message here" -
Push to Your Fork:
git push origin feature/your-feature-name
-
Create a Pull Request: Go to the original repository and submit a pull request.
PyMail is licensed under the GPLv3 License. See the LICENSE file for details.
For questions or support, you can reach out to Bocaletto Luca at your-email@example.com.
To download the latest version of PyMail, visit the Releases section. Download the appropriate file and execute it to start using the client.
This project covers various topics related to email management and security. Here are some relevant tags:
- bocaletto-luca
- client
- customizable
- encryption
- gpg
- gplv3
- imap
- open-source
- pgp
- pymail
- python
- smtp
Feel free to explore the repository and contribute to the project!