mirror of
https://github.com/retailcrm/mailgun-php.git
synced 2024-11-25 06:16:03 +03:00
Updated installation docs
This commit is contained in:
Tobias Nyholm
GitHub
parent
80987a952d
commit
ab826588c6
71
README.md
71
README.md
@ -1,5 +1,4 @@
|
||||
Mailgun-PHP
|
||||
===========
|
||||
# Mailgun PHP client
|
||||
|
||||
This is the Mailgun PHP SDK. This SDK contains methods for easily interacting
|
||||
with the Mailgun API.
|
||||
@ -10,52 +9,43 @@ at http://documentation.mailgun.com
|
||||
[](https://packagist.org/packages/mailgun/mailgun-php)
|
||||
[](https://travis-ci.org/mailgun/mailgun-php)
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
To install the SDK, you will need to be using [Composer](http://getcomposer.org/)
|
||||
in your project.
|
||||
If you aren't using Composer yet, it's really simple! Here's how to install
|
||||
composer and the Mailgun SDK.
|
||||
|
||||
```PHP
|
||||
# Install Composer
|
||||
curl -sS https://getcomposer.org/installer | php
|
||||
|
||||
# Add Mailgun as a dependency
|
||||
php composer.phar require mailgun/mailgun-php:~2.0
|
||||
```
|
||||
|
||||
You do also need to choose what library to use when you are sending http messages. Consult the
|
||||
[php-http/client-implementation](https://packagist.org/providers/php-http/client-implementation) virtual package to
|
||||
find adapters to use. For more information about virtual packages please refer to
|
||||
[Httplug](http://docs.httplug.io/en/latest/virtual-package/). Example:
|
||||
composer:
|
||||
|
||||
```bash
|
||||
php composer.phar require php-http/guzzle6-adapter:^1.0
|
||||
curl -sS https://getcomposer.org/installer | php
|
||||
```
|
||||
|
||||
When creating a new `Mailgun` object you must provide an instance of the `HttpClient`.
|
||||
The Mailgun api client is not hard coupled to Guzzle or any other library that sends HTTP messags. It uses an abstraction
|
||||
called HTTPlug. This will give you the flexibilty to choose what PSR-7 implementaion and HTTP client to use.
|
||||
|
||||
```php
|
||||
$client = new \Http\Adapter\Guzzle6\Client();
|
||||
$mailgun = new \Mailgun\Mailgun('api_key', $client);
|
||||
If you just want to get started quickly you should run the following command:
|
||||
|
||||
```bash
|
||||
php composer.phar require mailgun/mailgun-php php-http/curl-client guzzlehttp/psr7 php-http/message
|
||||
```
|
||||
|
||||
You could also rely on the [auto discovery feature of Httplug](http://docs.php-http.org/en/latest/discovery.html). This
|
||||
means that we will try to find an installed client automatically.
|
||||
|
||||
|
||||
**For shared hosts without SSH access, check out our [Shared Host Instructions](SharedHostInstall.md).**
|
||||
|
||||
Next, require Composer's autoloader, in your application, to automatically
|
||||
load the Mailgun SDK in your project:
|
||||
```PHP
|
||||
### Why requiring so many packages?
|
||||
|
||||
Mailgun has a dependency on the virtual package
|
||||
[php-http/client-implementation](https://packagist.org/providers/php-http/client-implementation) which requires to you install **an** adapter, but we do not care which one. That is an implemnetation detail in your application. We also need **a** PSR-7 implementation and **a** message factory.
|
||||
|
||||
You do not have to use the `php-http/curl-client` if you do not want to. You may use the `php-http/guzzle6-adapter`. Read more about the virtual packages, why this is a good idea and about the flexibility it brings at the [HTTPlug docs](http://docs.php-http.org/en/latest/httplug/users.html).
|
||||
|
||||
## Usage
|
||||
|
||||
You should always use Composer's autoloader in your application to automatically load the your dependencies. All examples below assumes you've already included this in your file:
|
||||
|
||||
```php
|
||||
require 'vendor/autoload.php';
|
||||
use Mailgun\Mailgun;
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
Here's how to send a message using the SDK:
|
||||
|
||||
```php
|
||||
@ -81,8 +71,7 @@ $mg->get("$domain/log", array('limit' => 25,
|
||||
'skip' => 0));
|
||||
```
|
||||
|
||||
Response
|
||||
--------
|
||||
### Response
|
||||
|
||||
The results, provided by the endpoint, are returned as an object, which you
|
||||
can traverse like an array.
|
||||
@ -140,8 +129,7 @@ object(stdClass)#26 (2) {
|
||||
}
|
||||
```
|
||||
|
||||
Debugging
|
||||
---------
|
||||
### Debugging
|
||||
|
||||
Debugging the PHP SDK can be really helpful when things aren't working quite right.
|
||||
To debug the SDK, here are some suggestions:
|
||||
@ -170,8 +158,7 @@ $mg->sendMessage($domain, array('from' => 'bob@example.com',
|
||||
'subject' => 'The PHP SDK is awesome!',
|
||||
'text' => 'It is so simple to send a message.'));
|
||||
```
|
||||
Additional Info
|
||||
---------------
|
||||
### Additional Info
|
||||
|
||||
For usage examples on each API endpoint, head over to our official documentation
|
||||
pages.
|
||||
@ -185,8 +172,7 @@ Batch Message is an extension of Message Builder, and allows you to easily send
|
||||
a batch message job within a few seconds. The complexity of
|
||||
batch messaging is eliminated!
|
||||
|
||||
Framework integration
|
||||
---------------------
|
||||
## Framework integration
|
||||
|
||||
If you are using a framework you might consider these composer packages to make the framework integration easier.
|
||||
|
||||
@ -194,8 +180,7 @@ If you are using a framework you might consider these composer packages to make
|
||||
* [Bogardo/Mailgun](https://github.com/Bogardo/Mailgun) for Laravel 4
|
||||
* [katanyoo/yii2-mailgun-mailer](https://github.com/katanyoo/yii2-mailgun-mailer) for Yii2
|
||||
|
||||
Support and Feedback
|
||||
--------------------
|
||||
## Support and Feedback
|
||||
|
||||
Be sure to visit the Mailgun official
|
||||
[documentation website](http://documentation.mailgun.com/) for additional
|
||||
|
||||
Loading…
Reference in New Issue
Block a user