RetailCRM-Mirror/mailgun-php
1
0
Fork 0
mirror of https://github.com/retailcrm/mailgun-php.git synced 2025-02-06 08:19:25 +03:00
Code Issues Projects Releases Wiki Activity

"Updated README"

Browse Source
This commit is contained in:
Travis Swientek 2013-07-25 00:16:49 -07:00
parent 5a10d782a0
commit d775e5ceb0
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,10 +1,10 @@
Mailgun-PHP-SDK Mailgun-PHP-SDK
=========== ===========
This is the Mailgun PHP SDK. This SDK contains methods for easily interacting with the Mailgun API. Below are examples for utilizing the SDK! This is the Mailgun PHP SDK. This SDK contains methods for easily interacting with the Mailgun API. Below are examples to get you started.
Installation Installation
----- -----
To install the SDK, you need to be using Composer in your project. If you aren't using Composer yet, it's really simple! Here's how to install composer and the Mailgun SDK. To install the SDK, you will need to be using Composer 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 ```PHP
# Install Composer # Install Composer
@ -13,14 +13,14 @@ curl -sS https://getcomposer.org/installer | php
# Add Mailgun as a dependency # Add Mailgun as a dependency
php composer.phar require mailgun/mailgun-php-sdk:~1.0 php composer.phar require mailgun/mailgun-php-sdk:~1.0
``` ```
Next, require Composer's autoloader to automatically load the Mailgun SDK: Next, require Composer's autoloader to automatically load the Mailgun SDK in your project:
```PHP ```PHP
require 'vendor/autoload.php'; require 'vendor/autoload.php';
``` ```
Usage Usage
----- -----
Using the SDK is rather simple, if you're already familiar with our API. If not, no problem... Just know that the classes follow the API endpoints. So when you're reviewing our documentation, the endpoints are expressed as a class. Using the SDK should feel simple, if you're already familiar with our API endpoints. If not, no problem... When you're reviewing our documentation, the endpoints are expressed as a class in the SDK to make things easier.
Here's an example for sending a message: Here's an example for sending a message:
@ -43,7 +43,7 @@ $message->sendMessage();
Advanced Usage Advanced Usage
-------------- --------------
You've sent your first message, awesome! Let's move on to more advanced scenarios. You've sent your first message, awesome! Let's move on to more advanced use cases.
#### Message Builder #### Message Builder
Message Builder makes creating your messages really intuitive. If you despise arrays, or your workflow is better off defining each part of the MIME separately, use this! Message Builder makes creating your messages really intuitive. If you despise arrays, or your workflow is better off defining each part of the MIME separately, use this!
@ -66,20 +66,26 @@ $message->setSubject("A message from the PHP SDK using Message Builder!");
# Define the body of the message. # Define the body of the message.
$message->setTextBody("This is the text body of the message!"); $message->setTextBody("This is the text body of the message!");
# Other Optional Parameters.
$message->addCampaignId("My-Awesome-Campaign");
$message->addCustomHeader("Customer-Id", "12345");
$message->addAttachment("@/tron.jpg");
$message->setDeliveryTime("tomorrow 8:00AM", "PST");
$message->setClickTracking(true);
# Finally, send the message. # Finally, send the message.
$message->sendMessage(); $message->sendMessage();
``` ```
#### Batch Sending #### Batch Sending
Batch sending allows you to submit up to 1,000 messages per API call. This is the best way to send a large amount of messages as quickly as possible. In the example below, we'll use the MessageBuilder object to create a message. Batch sending allows you to submit up to 1,000 messages per API call. This is the best way to send a large amount of messages as quickly as possible. In the example below, we'll use the Message Builder object to create a message. While Message Builder is the preferred method, you can also run "setMessage()" and pass a fully formed array of data.
```php ```php
# First, instantiate the client with your API credentials and domain. # First, instantiate the client with your API credentials and domain.
$mgClient = new MailgunClient("key-3ax6xnjp29jd6fds4gc373sgvjxteol0", "samples.mailgun.org"); $mgClient = new MailgunClient("key-3ax6xnjp29jd6fds4gc373sgvjxteol0", "samples.mailgun.org");
# Next, instantiate a Batch Message object on the Messages API endpoint. # Next, instantiate a Batch Message object on the Messages API endpoint.
# (note: The Batch Message object automatically includes a Message Builder object)
$batchMessage = $mgClient->Messages()->BatchMessage(); $batchMessage = $mgClient->Messages()->BatchMessage();
# Define the from address. # Define the from address.