Skip to content

Commit 8b5a4cb

Browse files
committed
Compatibility information added
1 parent a6b765b commit 8b5a4cb

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Discord: [discord.gg/rd4cN9h6][link-discord]
2626

2727
## Table of Contents
2828
- [Documentations](#documentations)
29+
- [Compatibility](#compatibility)
2930
- [Basic usage example](#basic-usage-example)
3031
- [Known issues](#known-issues)
3132
- [Support](#support)
@@ -40,14 +41,25 @@ Discord: [discord.gg/rd4cN9h6][link-discord]
4041
- Core documentation: [php-imap.com](https://www.php-imap.com/)
4142

4243

44+
## Compatibility
45+
| Version | PHP 5.6 | PHP 7 | PHP 8 |
46+
|:--------|:-------:|:-----:|:-----:|
47+
| v5.x | / | / | X |
48+
| v4.x | / | X | X |
49+
| v3.x | / | X | / |
50+
| v2.x | X | X | / |
51+
| v1.x | X | / | / |
52+
4353
## Basic usage example
4454
This is a basic example, which will echo out all Mails within all imap folders
4555
and will move every message into INBOX.read. Please be aware that this should not be
46-
tested in real life and is only meant to gives an impression on how things work.
56+
tested in real life and is only meant to give an impression on how things work.
4757

4858
```php
4959
use Webklex\PHPIMAP\ClientManager;
5060

61+
require_once "vendor/autoload.php";
62+
5163
$cm = new ClientManager('path/to/config/imap.php');
5264

5365
/** @var \Webklex\PHPIMAP\Client $client */
@@ -86,15 +98,15 @@ foreach($folders as $folder){
8698

8799

88100
### Known issues
89-
| Error | Solution |
90-
| ------------------------------------------------------------------------- | ---------------------------------------------------------- |
91-
| Kerberos error: No credentials cache file found (try running kinit) (...) | Uncomment "DISABLE_AUTHENTICATOR" inside your config and use the `legacy-imap` protocol |
101+
| Error | Solution |
102+
|:---------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
103+
| Kerberos error: No credentials cache file found (try running kinit) (...) | Uncomment "DISABLE_AUTHENTICATOR" inside your config and use the `legacy-imap` protocol |
92104

93105

94106
## Support
95107
If you encounter any problems or if you find a bug, please don't hesitate to create a new [issue](https://github.com/Webklex/php-imap/issues).
96-
However please be aware that it might take some time to get an answer.
97-
Off topic, rude or abusive issues will be deleted without any notice.
108+
However, please be aware that it might take some time to get an answer.
109+
Off-topic, rude or abusive issues will be deleted without any notice.
98110

99111
If you need **commercial** support, feel free to send me a mail at [email protected].
100112

@@ -116,7 +128,7 @@ echo 'your php code...';
116128

117129

118130
## Features & pull requests
119-
Everyone can contribute to this project. Every pull request will be considered but it can also happen to be declined.
131+
Everyone can contribute to this project. Every pull request will be considered, but it can also happen to be declined.
120132
To prevent unnecessary work, please consider to create a [feature issue](https://github.com/Webklex/php-imap/issues/new?template=feature_request.md)
121133
first, if you're planning to do bigger changes. Of course, you can also create a new [feature issue](https://github.com/Webklex/php-imap/issues/new?template=feature_request.md)
122134
if you're just wishing a feature ;)

0 commit comments

Comments
 (0)