crunchmail/crunchmail-client-php

Crunchmail is a PHP client to request crunchmail API

v0.6.1 2016-02-18 14:33 UTC

Requires

• php: >=5.5
• guzzlehttp/guzzle: ^6.1

Requires (Dev)

• phpmd/phpmd: ^2.3
• phpunit/phpunit: >=4
• squizlabs/php_codesniffer: ^2

MIT

• Yannick Huerre

README

Crunchmail-client-php 0.6.1

Official PHP wrapper for Crunchmail API

Important Notice

This API is under development. Do not use in production!

Install

Using composer (recommended)

Crunchmail-client uses composer.

First install composer if needed, then install crunchmail-php-client into your project directory:

composer require crunchmail/crunchmail-client-php

After installing, you need to require Composer's autoloader:

    require 'vendor/autoload.php';

Manually

If you wish to install the client manually, you will need to first install guzzle 6 and load the libraries yourself, as composer will not handle the autoload for you in that case.

Getting started

See example script to see how to use the API.

Documentation

• Crunchmail PHP Client documentation
• Developer documentation

Contributing

See CONTRIBUTING.md.