https://github.com/mohammadrezaamani/gonjeshk
Gonjeshk is a powerful Python mail client framework designed for asyncio, offering seamless integration with a variety of email providers including Gmail and Yahoo.
https://github.com/mohammadrezaamani/gonjeshk
Last synced: 3 months ago
JSON representation
Gonjeshk is a powerful Python mail client framework designed for asyncio, offering seamless integration with a variety of email providers including Gmail and Yahoo.
- Host: GitHub
- URL: https://github.com/mohammadrezaamani/gonjeshk
- Owner: MohammadrezaAmani
- License: mit
- Created: 2023-11-16T23:51:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-17T00:50:18.000Z (over 1 year ago)
- Last Synced: 2025-01-13T11:12:22.329Z (5 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gonjeshk AsyncMail Client Framework
**Gonjeshk** is a versatile and feature-rich Python mail client framework built on top of asyncio, providing seamless support for various email providers such as Gmail, Yahoo, and more. It is designed to simplify the process of sending, receiving, and managing emails with a focus on performance and extensibility.
## Features
### 1. Advanced Search Functionality
Search and filter emails based on sender, subject, date, attachments, and more, using a powerful and intuitive search syntax.
### 2. Smart Filters
Automatically categorize and organize emails with intelligent filters for a clutter-free inbox.
### 3. Conversation View
Group related emails into conversations, providing a threaded view for improved organization.
### 4. Threading
Display related messages in a single thread for a coherent and streamlined email experience.
### 5. Quick Replies
Respond promptly with canned responses and quick reply options.
### 6. Read Receipts
Request and receive read receipts for sent emails to track engagement.
### 7. Undo Send
Revoke sent emails within a short time frame using the undo feature.
### 9. Email Templates
Create and save email templates for common messages, increasing productivity.
### 10. Integration with Calendar
Connect seamlessly with calendar apps to schedule meetings and events directly from the email client.
### Getting Started
Follow these steps to integrate the AsyncMail framework into your project:
1. Install the AsyncMail package using pip:
```bash
pip install asyncmail
```
2. Import the AsyncMail client into your project:
```python
from gonjeshk import AsyncMailClient
```
3. Initialize the client with your email provider credentials:
```python
client = AsyncMailClient(provider="gmail", username="your_username", password="your_password")
```
4. Explore the rich set of features and functions provided by the AsyncMail client.
### Example Usage
```python
# Send an email
await client.send_email(to="[email protected]", subject="Hello", body="Greetings from AsyncMail!")
# Retrieve emails
emails = await client.get_emails(folder="inbox", limit=10)
# Apply filters
filtered_emails = await client.search_emails(query="from:[email protected] subject:important")
# ... and much more!
```
### Advanced Configuration
The AsyncMail framework provides a range of configuration options to tailor the client to your specific needs. Refer to the [Configuration Guide](docs/configuration.md) for detailed information.
### Contribution
We welcome contributions! If you have ideas for new features, improvements, or bug fixes, please submit a pull request. Refer to the [Contribution Guidelines](CONTRIBUTING.md) for more information.
### License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
### Acknowledgments
A special thanks to the contributors who have helped shape and improve the AsyncMail framework.
---
Feel free to adjust and expand upon this template to suit your specific project details and structure.