RetailCRM-Mirror/mailgun-php
1
0
Fork 0
mirror of https://github.com/retailcrm/mailgun-php.git synced 2025-02-18 05:43:15 +03:00
Code Issues Projects Releases Wiki Activity

Remove build status badge

Browse Source
This commit is contained in:
Nyholm 2021-01-30 08:35:17 +01:00 committed by David Garcia
parent 970440d2ee
commit d8ae00d23c
1 changed files with 33 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -5,7 +5,6 @@ with the Mailgun API. Below are examples to get you started. For additional
examples, please see our official documentation at http://documentation.mailgun.com
[![Latest Version](https://img.shields.io/github/release/mailgun/mailgun-php.svg?style=flat-square)](https://github.com/mailgun/mailgun-php/releases)
[![Build Status](https://img.shields.io/travis/mailgun/mailgun-php/master.svg?style=flat-square)](https://travis-ci.org/mailgun/mailgun-php)
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/mailgun/mailgun-php.svg?style=flat-square)](https://scrutinizer-ci.com/g/mailgun/mailgun-php)
[![Quality Score](https://img.shields.io/scrutinizer/g/mailgun/mailgun-php.svg?style=flat-square)](https://scrutinizer-ci.com/g/mailgun/mailgun-php)
[![Total Downloads](https://img.shields.io/packagist/dt/mailgun/mailgun-php.svg?style=flat-square)](https://packagist.org/packages/mailgun/mailgun-php)
@ -13,9 +12,9 @@ examples, please see our official documentation at http://documentation.mailgun.
## 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
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:
```bash
@ -26,9 +25,9 @@ The Mailgun API Client is not hard coupled to Guzzle, Buzz or any other library
HTTP messages. Instead, it uses the [PSR-18](https://www.php-fig.org/psr/psr-18/) client abstraction.
This will give you the flexibility to choose what
[PSR-7 implementation and HTTP client](https://packagist.org/providers/php-http/client-implementation)
you want to use.
you want to use.
If you just want to get started quickly you should run the following command:
If you just want to get started quickly you should run the following command:
```bash
composer require mailgun/mailgun-php kriswallsmith/buzz nyholm/psr7
@ -66,7 +65,7 @@ Attention: `$domain` must match to the domain you have configured on [app.mailgu
### All usage examples
You will find more detailed documentation at [/doc](doc/index.md) and on
You will find more detailed documentation at [/doc](doc/index.md) and on
[https://documentation.mailgun.com](https://documentation.mailgun.com/en/latest/api_reference.html).
### Response
@ -74,7 +73,7 @@ You will find more detailed documentation at [/doc](doc/index.md) and on
The result of an API call is, by default, a domain object. This will make it easy
to understand the response without reading the documentation. One can just read the
doc blocks on the response classes. This provides an excellent IDE integration.
```php
$mg = Mailgun::create('key-example');
$dns = $mg->domains()->show('example.com')->getInboundDNSRecords();
@ -85,7 +84,7 @@ foreach ($dns as $record) {
```
If you'd rather work with an array than an object you can inject the `ArrayHydrator`
to the Mailgun class.
to the Mailgun class.
```php
use Mailgun\Hydrator\ArrayHydrator;
@ -101,26 +100,26 @@ foreach ($data['receiving_dns_records'] as $record) {
}
```
You can also use the `NoopHydrator` to get a PSR7 Response returned from
the API calls.
You can also use the `NoopHydrator` to get a PSR7 Response returned from
the API calls.
**Warning: When using `NoopHydrator` there will be no exceptions on a non-200 response.**
### Debugging
Debugging the PHP SDK can be helpful when things aren't working quite right.
To debug the SDK, here are some suggestions:
Debugging the PHP SDK can be helpful when things aren't working quite right.
To debug the SDK, here are some suggestions:
Set the endpoint to Mailgun's Postbin. A Postbin is a web service that allows you to
post data, which then you can display it through a browser. Using Postbin is an easy way
to quickly determine what data you're transmitting to Mailgun's API.
**Step 1 - Create a new Postbin.**
Go to http://bin.mailgun.net. The Postbin will generate a special URL. Save that URL.
**Step 1 - Create a new Postbin.**
Go to http://bin.mailgun.net. The Postbin will generate a special URL. Save that URL.
**Step 2 - Instantiate the Mailgun client using Postbin.**
**Step 2 - Instantiate the Mailgun client using Postbin.**
*Tip: The bin id will be the URL part after bin.mailgun.net. It will be random generated letters and numbers.
*Tip: The bin id will be the URL part after bin.mailgun.net. It will be random generated letters and numbers.
For example, the bin id in this URL (http://bin.mailgun.net/aecf68de) is `aecf68de`.*
```php
@ -136,29 +135,29 @@ $mg = new Mailgun($configurator, new NoopHydrator());
# Now, compose and send your message.
$mg->messages()->send('example.com', [
'from' => 'bob@example.com',
'to' => 'sally@example.com',
'subject' => 'The PHP SDK is awesome!',
'from' => 'bob@example.com',
'to' => 'sally@example.com',
'subject' => 'The PHP SDK is awesome!',
'text' => 'It is so simple to send a message.'
]);
```
### Additional Info
For usage examples on each API endpoint, head over to our official documentation
pages.
For usage examples on each API endpoint, head over to our official documentation
pages.
This SDK includes a [Message Builder](src/Mailgun/Messages/README.md),
This SDK includes a [Message Builder](src/Mailgun/Messages/README.md),
[Batch Message](src/Mailgun/Messages/README.md) and [Opt-In Handler](src/Mailgun/Lists/README.md) component.
Message Builder allows you to quickly create the array of parameters, required
Message Builder allows you to quickly create the array of parameters, required
to send a message, by calling a methods for each parameter.
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!
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
If you are using a framework you might consider these composer packages to make the framework integration easier.
If you are using a framework you might consider these composer packages to make the framework integration easier.
* [tehplague/swiftmailer-mailgun-bundle](https://github.com/tehplague/swiftmailer-mailgun-bundle) for Symfony
* [katanyoo/yii2-mailgun-mailer](https://github.com/katanyoo/yii2-mailgun-mailer) for Yii2
@ -169,7 +168,7 @@ If you are using a framework you might consider these composer packages to make
This SDK is an Open Source under the MIT license. It is, thus, maintained by collaborators and contributors.
Feel free to contribute in any way. As an example you may:
Feel free to contribute in any way. As an example you may:
* Trying out the `dev-master` code
* Create issues if you find problems
* Reply to other people's issues
@ -177,7 +176,7 @@ Feel free to contribute in any way. As an example you may:
### Running the test code
If you want to run the tests you should run the following commands:
If you want to run the tests you should run the following commands:
```terminal
git clone git@github.com:mailgun/mailgun-php.git
@ -188,11 +187,11 @@ composer test
## Support and Feedback
Be sure to visit the Mailgun official
[documentation website](http://documentation.mailgun.com/) for additional
information about our API.
Be sure to visit the Mailgun official
[documentation website](http://documentation.mailgun.com/) for additional
information about our API.
If you find a bug, please submit the issue in Github directly.
If you find a bug, please submit the issue in Github directly.
[Mailgun-PHP Issues](https://github.com/mailgun/mailgun-php/issues)
As always, if you need additional assistance, drop us a note through your account at