Skip to content

Commit f226d8e

Browse files
WebklexWebklex
committed
INIT
0 parents  commit f226d8e

17 files changed

+1376
-0
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
vendor
2+
composer.lock
3+
.idea

‎.travis.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
language: php
2+
3+
php:
4+
- hhvm
5+
- 7.0
6+
- 5.6
7+
- 5.5
8+
9+
matrix:
10+
fast_finish: true
11+
allow_failures:
12+
- php: hhvm
13+
14+
sudo: false
15+
16+
install: composer install --no-interaction
17+
18+
script:
19+
- mkdir -p build/logs
20+
- vendor/bin/phpunit --coverage-clover build/logs/clover.xml
21+
22+
after_success:
23+
- sh -c 'if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then php vendor/bin/coveralls -v; fi;'
24+
25+
notifications:
26+
email:
27+
on_success: always
28+
on_failure: always
29+

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to `webklex/laravel-imap` will be documented in this file.
4+
5+
Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
6+
7+
## [UNRELEASED]
8+
9+
### Added
10+
- new laravel-imap package

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2016 Webklex
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2016 Malte Goldenbaum <[email protected]>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

‎README.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# IMAP Library for Laravel
2+
3+
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE.md)
5+
[![Build Status][ico-travis]][link-travis]
6+
[![Total Downloads][ico-downloads]][link-downloads]
7+
8+
9+
[...]
10+
11+
## Install
12+
13+
Via Composer
14+
15+
``` bash
16+
$ composer require webklex/laravel-imap
17+
```
18+
19+
## Setup
20+
21+
Add the service provider to the providers array in `config/app.php`.
22+
23+
``` php
24+
'providers' => [
25+
Webklex\IMAP\Providers\LaravelServiceProvider::class,
26+
];
27+
```
28+
29+
## Publishing
30+
31+
You can publish everything at once
32+
33+
``` php
34+
php artisan vendor:publish --provider="Webklex\IMAP\Providers\LaravelServiceProvider"
35+
```
36+
37+
or you can publish groups individually.
38+
39+
``` php
40+
php artisan vendor:publish --provider="Webklex\IMAP\Providers\LaravelServiceProvider" --tag="config"
41+
```
42+
43+
## Usage
44+
45+
[...]
46+
47+
Access the IMAP Client by its Facade (Webklex\IMAP\Facades\Client).
48+
Therefor you might want to add an alias to the aliases array within the `config/app.php` file.
49+
50+
``` php
51+
'aliases' => [
52+
'Client' => Webklex\IMAP\Facades\Client::class
53+
];
54+
```
55+
56+
## Change log
57+
58+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
59+
60+
## Testing
61+
62+
``` bash
63+
$ composer test
64+
```
65+
66+
## Security
67+
68+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
69+
70+
## Credits
71+
72+
- [Webklex][link-author]
73+
- All Contributors
74+
75+
## License
76+
77+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
78+
79+
[ico-version]: https://img.shields.io/packagist/v/Webklex/laravel-imap.svg?style=flat-square
80+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
81+
[ico-travis]: https://img.shields.io/travis/Webklex/laravel-imap/master.svg?style=flat-square
82+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/Webklex/laravel-imap.svg?style=flat-square
83+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/Webklex/laravel-imap.svg?style=flat-square
84+
[ico-downloads]: https://img.shields.io/packagist/dt/Webklex/laravel-imap.svg?style=flat-square
85+
86+
[link-packagist]: https://packagist.org/packages/Webklex/laravel-imap
87+
[link-travis]: https://travis-ci.org/Webklex/laravel-imap
88+
[link-scrutinizer]: https://scrutinizer-ci.com/g/Webklex/laravel-imap/code-structure
89+
[link-code-quality]: https://scrutinizer-ci.com/g/Webklex/laravel-imap
90+
[link-downloads]: https://packagist.org/packages/Webklex/laravel-imap
91+
[link-author]: https://github.com/webklex

‎composer.json‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"name": "webklex/laravel-imap",
3+
"type": "library",
4+
"description": "Laravel IMAP client",
5+
"keywords": [
6+
"webklex",
7+
"laravel",
8+
"imap",
9+
"laravel-imap",
10+
"mail"
11+
],
12+
"homepage": "https://github.com/webklex/laravel-imap",
13+
"license": "MIT",
14+
"authors": [
15+
{
16+
"name": "Malte Goldenbaum",
17+
"email": "[email protected]",
18+
"role": "Developer"
19+
}
20+
],
21+
"require": {
22+
"php": ">=5.5.9",
23+
"laravel/framework": "~5.2.0",
24+
"nesbot/carbon": "^1.22"
25+
},
26+
"autoload": {
27+
"psr-4": {
28+
"Webklex\\IMAP\\": "src/IMAP"
29+
}
30+
},
31+
"scripts": {
32+
"test": "phpunit"
33+
},
34+
"extra": {
35+
"branch-alias": {
36+
"dev-master": "1.0-dev"
37+
}
38+
},
39+
"minimum-stability": "dev",
40+
"prefer-stable": true
41+
}

‎phpunit.xml.dist‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit bootstrap="vendor/autoload.php"
3+
backupGlobals="false"
4+
backupStaticAttributes="false"
5+
colors="true"
6+
verbose="true"
7+
convertErrorsToExceptions="true"
8+
convertNoticesToExceptions="true"
9+
convertWarningsToExceptions="true"
10+
processIsolation="false"
11+
stopOnFailure="false">
12+
<testsuites>
13+
<testsuite name="Helpers Test Suite">
14+
<directory>tests</directory>
15+
</testsuite>
16+
</testsuites>
17+
<filter>
18+
<whitelist>
19+
<directory suffix=".php">src/</directory>
20+
</whitelist>
21+
</filter>
22+
<logging>
23+
<log type="tap" target="build/report.tap"/>
24+
<log type="junit" target="build/report.junit.xml"/>
25+
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
26+
<log type="coverage-text" target="build/coverage.txt"/>
27+
<log type="coverage-clover" target="build/logs/clover.xml"/>
28+
</logging>
29+
</phpunit>

0 commit comments

Comments
 (0)