Skip to content

Commit d4512a1

Browse files
committed
Links updated & installation information added
1 parent ca98a9e commit d4512a1

File tree

1 file changed

+58
-31
lines changed

1 file changed

+58
-31
lines changed

README.md

Lines changed: 58 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
# IMAP Library for Laravel
22

3-
[![Latest Version on Packagist][ico-version]][link-packagist]
3+
[![Latest release on Packagist][ico-release]][link-packagist]
4+
[![Latest prerelease on Packagist][ico-prerelease]][link-packagist]
45
[![Software License][ico-license]][link-license]
5-
[![Build Status][ico-travis]][link-travis]
6-
[![Code quality][ico-quality]][link-scrutinizer]
6+
[![Build Status][ico-travis]][link-travis]
7+
[![Code quality][ico-quality]][link-scrutinizer]
78
[![Total Downloads][ico-downloads]][link-downloads]
89
[![Hits][ico-hits]][link-hits]
10+
[![Discord][ico-discord]][link-discord]
11+
[![Snyk][ico-snyk]][link-snyk]
912

1013

1114
## Description
12-
Laravel IMAP is an easy way to integrate both the native php-imap module and an extended custom imap protocol
13-
into your **Laravel** app. This enables your app to not only respond to new emails but also allows it to
14-
read and parse existing mails and much more.
15+
Laravel IMAP is an easy way to integrate both the native php-imap module and an extended custom imap protocol
16+
into your **Laravel** app. This enables your app to not only respond to new emails but also allows it to
17+
read and parse existing mails and much more.
1518

1619
Official documentation: [php-imap.com/frameworks/laravel](https://www.php-imap.com/frameworks/laravel/installation)
1720

18-
Discord: https://discord.gg/vUHrbfbDr9
21+
Discord: [discord.gg/jCcZWCSq][link-discord]
1922

2023
## Table of Contents
2124
- [Documentations](#documentations)
25+
- [Installation](#installation)
2226
- [Basic usage example](#basic-usage-example)
2327
- [Known issues](#known-issues)
2428
- [Support](#support)
@@ -34,6 +38,18 @@ Discord: https://discord.gg/vUHrbfbDr9
3438
- Core documentation: [php-imap.com](https://www.php-imap.com/)
3539

3640

41+
## Installation
42+
This library requires the `mbstring` and `mcrypt` php module. Make sure to install or enable them if they arn't available.
43+
```bash
44+
sudo apt-get install php*-mbstring php*-mcrypt
45+
```
46+
Installation via composer:
47+
```bash
48+
composer require webklex/laravel-imap
49+
```
50+
Additional information such as troubleshooting, legacy support and package publishing can be found here:
51+
[php-imap.com/frameworks/laravel/installation](https://www.php-imap.com/frameworks/laravel/installation)
52+
3753
## Basic usage example
3854
This is a basic example, which will echo out all Mails within all imap folders
3955
and will move every message into INBOX.read. Please be aware that this should not be
@@ -80,32 +96,37 @@ foreach($folders as $folder){
8096
| Kerberos error: No credentials cache file found (try running kinit) (...) | Uncomment "DISABLE_AUTHENTICATOR" inside and use the `legacy-imap` protocol `config/imap.php` |
8197

8298

83-
## Support
84-
If you encounter any problems or if you find a bug, please don't hesitate to create a new [issue](https://github.com/Webklex/laravel-imap/issues).
85-
However please be aware that it might take some time to get an answer.
86-
87-
Off topic, rude or abusive issues will be deleted without any notice.
88-
89-
##### A little notice
99+
## Support
100+
If you encounter any problems or if you find a bug, please don't hesitate to create a new
101+
[issue](https://github.com/Webklex/laravel-imap/issues).
102+
However please be aware that it might take some time to get an answer.
103+
104+
Off topic, rude or abusive issues will be deleted without any notice.
105+
106+
If you need **immediate** or **commercial** support, feel free to send me a mail at [email protected].
107+
108+
##### A little notice
90109
If you write source code in your issue, please consider to format it correctly. This makes it so much nicer to read
91-
and people are more likely to comment and help :)
92-
93-
```php
94-
95-
echo 'your php code...';
96-
97-
```
98-
99-
will turn into:
110+
and people are more likely to comment and help :)
111+
112+
```php
113+
114+
echo 'your php code...';
115+
116+
```
117+
118+
will turn into:
100119
```php
101-
echo 'some comment...';
120+
echo 'your php code...';
102121
```
103-
104-
### Features & pull requests
122+
123+
### Features & pull requests
105124
Everyone can contribute to this project. Every pull request will be considered but it can also happen to be declined.
106-
To prevent unnecessary work, please consider to create a [feature issue](https://github.com/Webklex/laravel-imap/issues/new?template=feature_request.md)
107-
first, if you're planning to do bigger changes. Of course you can also create a new [feature issue](https://github.com/Webklex/laravel-imap/issues/new?template=feature_request.md)
108-
if you're just wishing a feature ;)
125+
To prevent unnecessary work, please consider to create a
126+
[feature issue](https://github.com/Webklex/laravel-imap/issues/new?template=feature_request.md)
127+
first, if you're planning to do bigger changes. Of course you can also create a new
128+
[feature issue](https://github.com/Webklex/laravel-imap/issues/new?template=feature_request.md)
129+
if you're just wishing a feature ;)
109130

110131

111132
## Change log
@@ -119,21 +140,25 @@ If you discover any security related issues, please email [email protected] ins
119140
- [All Contributors][link-contributors]
120141

121142
## Supporters
122-
A special thanks to Jetbrains for supporting this project through their [open source license program](https://www.jetbrains.com/buy/opensource/).
143+
A special thanks to Jetbrains for supporting this project through their
144+
[open source license program](https://www.jetbrains.com/buy/opensource/).
123145

124146
[![Jetbrains][png-jetbrains]][link-jetbrains]
125147

126148
## License
127149
The MIT License (MIT). Please see [License File][link-license] for more information.
128150

129-
[ico-version]: https://img.shields.io/packagist/v/webklex/laravel-imap.svg?style=flat-square
151+
[ico-release]: https://img.shields.io/packagist/v/webklex/laravel-imap.svg?style=flat-square&label=version
152+
[ico-prerelease]: https://img.shields.io/github/v/release/webklex/laravel-imap?include_prereleases&style=flat-square&label=pre-release
130153
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
131154
[ico-travis]: https://img.shields.io/travis/Webklex/laravel-imap/master.svg?style=flat-square
132155
[ico-downloads]: https://img.shields.io/packagist/dt/Webklex/laravel-imap.svg?style=flat-square
133156
[ico-hits]: https://hits.webklex.com/svg/webklex/laravel-imap?
134157
[ico-build]: https://img.shields.io/scrutinizer/build/g/Webklex/laravel-imap/master?style=flat-square
135158
[ico-quality]: https://img.shields.io/scrutinizer/quality/g/Webklex/laravel-imap/master?style=flat-square
136159
[png-jetbrains]: https://www.webklex.com/jetbrains.png
160+
[ico-snyk]: https://snyk-widget.herokuapp.com/badge/composer/webklex/laravel-imap/badge.svg
161+
[ico-discord]: https://img.shields.io/static/v1?label=discord&message=open&color=5865f2&style=flat-square
137162

138163
[link-packagist]: https://packagist.org/packages/Webklex/laravel-imap
139164
[link-travis]: https://travis-ci.org/Webklex/laravel-imap
@@ -145,3 +170,5 @@ The MIT License (MIT). Please see [License File][link-license] for more informat
145170
[link-license]: https://github.com/Webklex/laravel-imap/blob/master/LICENSE
146171
[link-changelog]: https://github.com/Webklex/laravel-imap/blob/master/CHANGELOG.md
147172
[link-jetbrains]: https://www.jetbrains.com
173+
[link-snyk]: https://snyk.io/vuln/composer:webklex%2Flaravel-imap
174+
[link-discord]: https://discord.gg/jCcZWCSq

0 commit comments

Comments
 (0)