generated from Nodarx/template
42 lines
1.5 KiB
Markdown
42 lines
1.5 KiB
Markdown
# IMAP Mail Provider Module
|
|
|
|
This module provides an implementation of an IMAP mail provider using the `gricob/imap` library. It is designed to facilitate email operations such as managing mailboxes and messages through the IMAP protocol.
|
|
|
|
## Features
|
|
|
|
- **Service Location**: Configures connection details including host, port, and encryption type.
|
|
- **Service Identity**: Manages user credentials securely.
|
|
- **Mailbox Management**: Supports operations for listing, fetching, creating, modifying, and deleting mailboxes and messages.
|
|
- **Autodiscovery**: Implements methods for discovering IMAP services automatically.
|
|
|
|
## Installation
|
|
|
|
To install the module, run the following command in the module directory:
|
|
|
|
```bash
|
|
composer install
|
|
```
|
|
|
|
This will install the required dependencies, including `gricob/imap`.
|
|
|
|
## Usage
|
|
|
|
1. **Service Test**: Use the `serviceTest()` method to check connectivity to the IMAP server.
|
|
2. **Discover Services**: Call `serviceDiscover()` to find available mail services.
|
|
3. **Mailbox Operations**: Utilize the `RemoteMailService` to perform operations such as listing mailboxes and managing messages.
|
|
|
|
## Example
|
|
|
|
```php
|
|
$provider = new KTXM\ProviderImapMail\Providers\Provider();
|
|
$provider->serviceTest();
|
|
$mailboxes = $provider->serviceDiscover();
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the LICENSE file for details. |