added php download of membershipments
This commit is contained in:
Torsten Schulz
167
vendor/webklex/php-imap/README.md
vendored
Executable file
167
vendor/webklex/php-imap/README.md
vendored
Executable file
@@ -0,0 +1,167 @@
|
||||
|
||||
# IMAP Library for PHP
|
||||
|
||||
[![Latest release on Packagist][ico-release]][link-packagist]
|
||||
[![Latest prerelease on Packagist][ico-prerelease]][link-packagist]
|
||||
[![Software License][ico-license]][link-license]
|
||||
[![Build Status][ico-travis]][link-scrutinizer]
|
||||
[![Total Downloads][ico-downloads]][link-downloads]
|
||||
[![Hits][ico-hits]][link-hits]
|
||||
[![Discord][ico-discord]][link-discord]
|
||||
[![Snyk][ico-snyk]][link-snyk]
|
||||
|
||||
|
||||
## Description
|
||||
PHP-IMAP is a wrapper for common IMAP communication without the need to have the php-imap module installed / enabled.
|
||||
The protocol is completely integrated and therefore supports IMAP IDLE operation and the "new" oAuth authentication
|
||||
process as well.
|
||||
You can enable the `php-imap` module in order to handle edge cases, improve message decoding quality and is required if
|
||||
you want to use legacy protocols such as pop3.
|
||||
|
||||
Official documentation: [php-imap.com](https://www.php-imap.com/)
|
||||
|
||||
Laravel wrapper: [webklex/laravel-imap](https://github.com/Webklex/laravel-imap)
|
||||
|
||||
Discord: [discord.gg/rd4cN9h6][link-discord]
|
||||
|
||||
## Table of Contents
|
||||
- [Documentations](#documentations)
|
||||
- [Basic usage example](#basic-usage-example)
|
||||
- [Known issues](#known-issues)
|
||||
- [Support](#support)
|
||||
- [Features & pull requests](#features--pull-requests)
|
||||
- [Security](#security)
|
||||
- [Credits](#credits)
|
||||
- [License](#license)
|
||||
|
||||
|
||||
## Documentations
|
||||
- Legacy (< v2.0.0): [legacy documentation](https://github.com/Webklex/php-imap/tree/1.4.5)
|
||||
- Core documentation: [php-imap.com](https://www.php-imap.com/)
|
||||
|
||||
|
||||
## Basic usage example
|
||||
This is a basic example, which will echo out all Mails within all imap folders
|
||||
and will move every message into INBOX.read. Please be aware that this should not be
|
||||
tested in real life and is only meant to gives an impression on how things work.
|
||||
|
||||
```php
|
||||
use Webklex\PHPIMAP\ClientManager;
|
||||
|
||||
$cm = new ClientManager('path/to/config/imap.php');
|
||||
|
||||
/** @var \Webklex\PHPIMAP\Client $client */
|
||||
$client = $cm->account('account_identifier');
|
||||
|
||||
//Connect to the IMAP Server
|
||||
$client->connect();
|
||||
|
||||
//Get all Mailboxes
|
||||
/** @var \Webklex\PHPIMAP\Support\FolderCollection $folders */
|
||||
$folders = $client->getFolders();
|
||||
|
||||
//Loop through every Mailbox
|
||||
/** @var \Webklex\PHPIMAP\Folder $folder */
|
||||
foreach($folders as $folder){
|
||||
|
||||
//Get all Messages of the current Mailbox $folder
|
||||
/** @var \Webklex\PHPIMAP\Support\MessageCollection $messages */
|
||||
$messages = $folder->messages()->all()->get();
|
||||
|
||||
/** @var \Webklex\PHPIMAP\Message $message */
|
||||
foreach($messages as $message){
|
||||
echo $message->getSubject().'<br />';
|
||||
echo 'Attachments: '.$message->getAttachments()->count().'<br />';
|
||||
echo $message->getHTMLBody();
|
||||
|
||||
//Move the current Message to 'INBOX.read'
|
||||
if($message->move('INBOX.read') == true){
|
||||
echo 'Message has been moved';
|
||||
}else{
|
||||
echo 'Message could not be moved';
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Known issues
|
||||
| Error | Solution |
|
||||
| ------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| Kerberos error: No credentials cache file found (try running kinit) (...) | Uncomment "DISABLE_AUTHENTICATOR" inside your config and use the `legacy-imap` protocol |
|
||||
|
||||
|
||||
## Support
|
||||
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).
|
||||
However please be aware that it might take some time to get an answer.
|
||||
Off topic, rude or abusive issues will be deleted without any notice.
|
||||
|
||||
If you need **commercial** support, feel free to send me a mail at github@webklex.com.
|
||||
|
||||
|
||||
##### A little notice
|
||||
If you write source code in your issue, please consider to format it correctly. This makes it so much nicer to read
|
||||
and people are more likely to comment and help :)
|
||||
|
||||
```php
|
||||
|
||||
echo 'your php code...';
|
||||
|
||||
```
|
||||
|
||||
will turn into:
|
||||
```php
|
||||
echo 'your php code...';
|
||||
```
|
||||
|
||||
|
||||
## Features & pull requests
|
||||
Everyone can contribute to this project. Every pull request will be considered but it can also happen to be declined.
|
||||
To prevent unnecessary work, please consider to create a [feature issue](https://github.com/Webklex/php-imap/issues/new?template=feature_request.md)
|
||||
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)
|
||||
if you're just wishing a feature ;)
|
||||
|
||||
|
||||
## Change log
|
||||
Please see [CHANGELOG][link-changelog] for more information what has changed recently.
|
||||
|
||||
|
||||
## Security
|
||||
If you discover any security related issues, please email github@webklex.com instead of using the issue tracker.
|
||||
|
||||
|
||||
## Credits
|
||||
- [Webklex][link-author]
|
||||
- [All Contributors][link-contributors]
|
||||
|
||||
|
||||
## License
|
||||
The MIT License (MIT). Please see [License File][link-license] for more information.
|
||||
|
||||
|
||||
[ico-release]: https://img.shields.io/packagist/v/Webklex/php-imap.svg?style=flat-square&label=version
|
||||
[ico-prerelease]: https://img.shields.io/github/v/release/webklex/php-imap?include_prereleases&style=flat-square&label=pre-release
|
||||
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
|
||||
[ico-travis]: https://img.shields.io/travis/Webklex/php-imap/master.svg?style=flat-square
|
||||
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/Webklex/php-imap.svg?style=flat-square
|
||||
[ico-code-quality]: https://img.shields.io/scrutinizer/g/Webklex/php-imap.svg?style=flat-square
|
||||
[ico-downloads]: https://img.shields.io/packagist/dt/Webklex/php-imap.svg?style=flat-square
|
||||
[ico-build]: https://img.shields.io/scrutinizer/build/g/Webklex/php-imap/master?style=flat-square
|
||||
[ico-quality]: https://img.shields.io/scrutinizer/quality/g/Webklex/php-imap/master?style=flat-square
|
||||
[ico-hits]: https://hits.webklex.com/svg/webklex/php-imap
|
||||
[ico-snyk]: https://snyk-widget.herokuapp.com/badge/composer/webklex/php-imap/badge.svg
|
||||
[ico-discord]: https://img.shields.io/static/v1?label=discord&message=open&color=5865f2&style=flat-square
|
||||
|
||||
[link-packagist]: https://packagist.org/packages/Webklex/php-imap
|
||||
[link-travis]: https://travis-ci.org/Webklex/php-imap
|
||||
[link-scrutinizer]: https://scrutinizer-ci.com/g/Webklex/php-imap/code-structure
|
||||
[link-code-quality]: https://scrutinizer-ci.com/g/Webklex/php-imap
|
||||
[link-downloads]: https://packagist.org/packages/Webklex/php-imap
|
||||
[link-author]: https://github.com/webklex
|
||||
[link-contributors]: https://github.com/Webklex/php-imap/graphs/contributors
|
||||
[link-license]: https://github.com/Webklex/php-imap/blob/master/LICENSE
|
||||
[link-changelog]: https://github.com/Webklex/php-imap/blob/master/CHANGELOG.md
|
||||
[link-jetbrains]: https://www.jetbrains.com
|
||||
[link-hits]: https://hits.webklex.com
|
||||
[link-snyk]: https://snyk.io/vuln/composer:webklex%2Fphp-imap
|
||||
[link-discord]: https://discord.gg/rd4cN9h6
|
||||
Reference in New Issue
Block a user