Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
language: php

php:
- 5.3
- 5.4
- 5.5
- 5.6
- hhvm
- hhvm-nightly
Expand All @@ -21,4 +18,4 @@ matrix:
fast_finish: true
allow_failures:
- php: hhvm
- php: hhvm-nightly
- php: hhvm-nightly
45 changes: 28 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,28 @@ 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
```

> 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`

```sh
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.
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.*"
"tedivm/fetch": "0.7.*"
}
```

Expand All @@ -41,27 +46,33 @@ $ pear install tedivm/Fetch

### Github

Releases of Fetch are available on [Github](https://github.com/tedious/Fetch/releases).
Releases of Fetch are available on [Github][: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.

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');
```php
use Fetch\Server;
use Fetch\Message;

$server = new Server('imap.example.com', 993);
$server->setAuthentication('username', 'password');

$messages = $server->getMessages();
/** @var $message \Fetch\Message */
foreach ($messages as $message) {
echo "Subject: {$message->getSubject()}\nBody: {$message->getMessageBody()}\n";
}
/** @var Message[] $message */
$messages = $server->getMessages();

foreach ($messages as $message) {
echo "Subject: {$message->getSubject()}", PHP_EOL;
echo "Body: {$message->getMessageBody()}", PHP_EOL;
}
```

## License

Fetch is licensed under the BSD License. See the LICENSE file for details.

[:releases:]: https://github.com/tedious/Fetch/releases
2 changes: 1 addition & 1 deletion phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
>
<testsuites>
<testsuite name="Fetch Test Suite">
<directory>./tests</directory>
<directory>./tests/Fetch</directory>
</testsuite>
</testsuites>
<filter>
Expand Down
5 changes: 3 additions & 2 deletions tests/runTests.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#/usr/bin/env/sh
#!/usr/bin/env bash

set -e

if [ ! -n "$TRAVIS" ]; then
Expand All @@ -14,4 +15,4 @@ echo ''
echo ''
echo 'Testing for Coding Styling Compliance.'
echo 'All code should follow PSR standards.'
./vendor/bin/php-cs-fixer fix ./ --level="all" -vv --dry-run
./vendor/bin/php-cs-fixer fix ./ --level="all" -vv --dry-run