mirror of
https://github.com/retailcrm/Fetch.git
synced 2024-11-21 18:56:02 +03:00
68 lines
2.2 KiB
Markdown
68 lines
2.2 KiB
Markdown
# Fetch [](https://travis-ci.org/tedious/Fetch)
|
|
|
|
[](https://github.com/tedious/fetch/blob/master/LICENSE)
|
|
[](https://packagist.org/packages/tedivm/fetch)
|
|
[](https://coveralls.io/r/tedious/Fetch?branch=master)
|
|
[](https://packagist.org/packages/tedivm/fetch)
|
|
|
|
Fetch is a library for reading email and attachments, primarily using the POP
|
|
and IMAP protocols.
|
|
|
|
|
|
## Installing
|
|
> N.b. A note on Ubuntu 14.04 (probably other Debian-based / Apt managed systems), the install of php5-imap does not enable the extension for CLI (possibly others as well), which can cause composer to report fetch requires ext-imap
|
|
```
|
|
sudo ln -s /etc/php5/mods-available/imap.ini /etc/php5/cli/conf.d/30-imap.ini
|
|
```
|
|
|
|
### Composer
|
|
|
|
Installing Fetch can be done through a variety of methods, although Composer is
|
|
recommended.
|
|
|
|
Until Fetch reaches a stable API with version 1.0 it is recommended that you
|
|
review changes before even Minor updates, although bug fixes will always be
|
|
backwards compatible.
|
|
|
|
```
|
|
"require": {
|
|
"tedivm/fetch": "0.6.*"
|
|
}
|
|
```
|
|
|
|
### Pear
|
|
|
|
Fetch is also available through Pear.
|
|
|
|
```
|
|
$ pear channel-discover pear.tedivm.com
|
|
$ pear install tedivm/Fetch
|
|
```
|
|
|
|
### Github
|
|
|
|
Releases of Fetch are available on [Github](https://github.com/tedious/Fetch/releases).
|
|
|
|
|
|
## Sample Usage
|
|
|
|
This is just a simple code to show how to access messages by using Fetch. It uses Fetch
|
|
own autoload, but it can (and should be, if applicable) replaced with the one generated
|
|
by composer.
|
|
|
|
|
|
$server = new \Fetch\Server('imap.example.com', 993);
|
|
$server->setAuthentication('dummy', 'dummy');
|
|
|
|
|
|
$messages = $server->getMessages();
|
|
/** @var $message \Fetch\Message */
|
|
foreach ($messages as $message) {
|
|
echo "Subject: {$message->getSubject()}\nBody: {$message->getMessageBody()}\n";
|
|
}
|
|
|
|
|
|
## License
|
|
|
|
Fetch is licensed under the BSD License. See the LICENSE file for details.
|