RetailCRM-Mirror/mailgun-php
1
0
Fork 0
mirror of https://github.com/retailcrm/mailgun-php.git synced 2024-11-29 08:26:06 +03:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source 
Added several new samples.
This commit is contained in:
travis06 2013-07-24 23:53:16 -07:00
parent 8fba40a2ee
commit 8b7fb1494a
1 changed files with 60 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -26,10 +26,10 @@ Here's an example for sending a message:
```php ```php
# First, instantiate the client with your API credentials and domain. # First, instantiate the client with your API credentials and domain.
$client = new MailgunClient("key-3ax6xnjp29jd6fds4gc373sgvjxteol0", "samples.mailgun.org"); $mgClient = new MailgunClient("key-3ax6xnjp29jd6fds4gc373sgvjxteol0", "samples.mailgun.org");
# Next, create a message object. # Next, instantiate a Message object on the messages API endpoint.
$message = $client->Messages(); $message = $mgClient->Messages();
# Now, compose your message. # Now, compose your message.
$message->setMessage(array('from' => 'me@samples.mailgun.org', $message->setMessage(array('from' => 'me@samples.mailgun.org',
@ -40,3 +40,60 @@ $message->setMessage(array('from' => 'me@samples.mailgun.org',
# Finally, send the message. # Finally, send the message.
$message->sendMessage(); $message->sendMessage();
``` ```
Advanced Usage
--------------
You've sent your first message, awesome! Let's move on to more advanced scenarios.
#### 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!
```php
# First, instantiate the client with your API credentials and domain.
$mgClient = new MailgunClient("key-3ax6xnjp29jd6fds4gc373sgvjxteol0", "samples.mailgun.org");
# Next, instantiate a Message Builder object on the Messages API endpoint.
$message = $mgClient->Messages()->MessageBuilder();
# Define the from address.
$message->setFromAddress("me@samples.mailgun.org", array("first"=>"PHP", "last" => "SDK"));
# Define a to recipient.
$message->addToRecipient("john.doe@samples.mailgun.org", array("first" => "John", "last" => "Doe"));
# Define a cc recipient.
$message->addCcRecipient("sally.doe@samples.mailgun.org", array("first" => "Sally", "last" => "Doe"));
# Define the subject.
$message->setSubject("A message from the PHP SDK using Message Builder!");
# Define the body of the message.
$message->setTextBody("This is the text body of the message!");
# Finally, send the message.
$message->sendMessage();
```
#### 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.
```php
# First, instantiate the client with your API credentials and domain.
$mgClient = new MailgunClient("key-3ax6xnjp29jd6fds4gc373sgvjxteol0", "samples.mailgun.org");
# 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();
# Define the from address.
$batchMessage->setFromAddress("me@samples.mailgun.org", array("first"=>"PHP", "last" => "SDK"));
# Define the subject.
$batchMessage->setSubject("A Batch Message from the PHP SDK!");
# Define the body of the message.
$batchMessage->setTextBody("This is the text body of the message!");
# Next, let's add a few recipients to the batch job.
$batchMessage->addBatchRecipient("john.doe@samples.mailgun.org", array("first" => "John", "last" => "Doe"));
$batchMessage->addBatchRecipient("sally.doe@samples.mailgun.org", array("first" => "Sally", "last" => "Doe"));
$batchMessage->addBatchRecipient("mike.jones@samples.mailgun.org", array("first" => "Mike", "last" => "Jones"));
# Finally, submit the batch job.
$batchMessage->sendMessage();
```