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

Rename README to README.md

Browse Source
This commit is contained in:
Travis Swientek 2013-08-16 12:51:18 -07:00 committed by Travis Swientek
parent 4ff1184b0b
commit 143414f174
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
src/Mailgun/Lists/README → src/Mailgun/Lists/README.md
View File

@ -10,13 +10,13 @@ There is currently one utility provided.
OptInHandler: Provides methods for authenticating an OptInRequest. OptInHandler: Provides methods for authenticating an OptInRequest.
The typical flow for using this utility would be as follow: The typical flow for using this utility would be as follow:
(Customer Requests Subscribe) -> [Generate Opt In Link] -> [Email Customer Opt In Link] (Recipient Requests Subscribe) -> [Generate Opt In Link] -> [Email Recipient Opt In Link]
(Customer Clicks Opt In Link) -> [Validate Opt In Link] -> [Subscribe User] -> [Send final confirmation] (Recipient Clicks Opt In Link) -> [Validate Opt In Link] -> [Subscribe User] -> [Send final confirmation]
The above flow is modeled below. The above flow is modeled below.
Usage - Opt-In Handler (Customer Requests Subscribe) Usage - Opt-In Handler (Recipient Requests Subscribe)
---------------------------------------------------- -----------------------------------------------------
Here's how to use Opt-In Handler to validate Opt-In requests. Here's how to use Opt-In Handler to validate Opt-In requests.
```php ```php
@ -27,29 +27,29 @@ $domain = "example.com";
# Next, instantiate an OptInHandler object from the SDK. # Next, instantiate an OptInHandler object from the SDK.
$optInHandler = $mg->OptInHandler(); $optInHandler = $mg->OptInHandler();
$ Next, generate a hash. # Next, define necessary variables and generate a hash.
$mailingList = 'youlist@example.com'; $mailingList = 'youlist@example.com';
$secretPassphrase = 'a_secret_passphrase'; $secretPassphrase = 'a_secret_passphrase';
$recipientAddress = 'recipient@example.com' $recipientAddress = 'recipient@example.com'
$generatedHash = $optInHandler->generateHash($mailingList, $secretPassphrase, $recipientAddress); $generatedHash = $optInHandler->generateHash($mailingList, $secretPassphrase, $recipientAddress);
# Now, let's send a confirmation to the recipient. # Now, let's send a confirmation to the recipient with our link.
$mg->sendMessage($domain, array('from' => 'bob@example.com', $mg->sendMessage($domain, array('from' => 'bob@example.com',
'to' => 'sally@example.com', 'to' => 'sally@example.com',
'subject' => 'Please Confirm!', 'subject' => 'Please Confirm!',
'html' => '<html><body>Hello,<br><br>You have requested to be subscribed to the mailing list {$mailingList}. 'html' => '<html><body>Hello,<br><br>You have requested to be subscribed
Please <a href="http://yourdomain.com/subscribe.php?hash=$generatedHash">confirm</a> your subscription. to the mailing list {$mailingList}. Please <a
<br><br>Thank you!</body></html>')); href="http://yourdomain.com/subscribe.php?hash=$generatedHash">confirm
</a> your subscription.<br><br>Thank you!</body></html>'));
$ Finally, let's add the subscriber to a Mailing List, as unsubscribed, so we can track non-conversions. # Finally, let's add the subscriber to a Mailing List, as unsubscribed, so we can track non-conversions.
$mg->post('{$domain}/lists/{$mailingList}', array('address' => $recipientAddress, $mg->post('{$domain}/lists/{$mailingList}', array('address' => $recipientAddress,
'subscribed' => 'no', 'subscribed' => 'no',
'upsert' => 'yes'); 'upsert' => 'yes');
``` ```
Usage - Opt-In Handler (Customer Clicks Opt In Link) Usage - Opt-In Handler (Recipient Clicks Opt In Link)
---------------------------------------------------- -----------------------------------------------------
Here's how to use Opt-In Handler to validate an Opt-In Hash. Here's how to use Opt-In Handler to validate an Opt-In Hash.
```php ```php
@ -60,7 +60,7 @@ $domain = "example.com";
# Next, instantiate an OptInHandler object from the SDK. # Next, instantiate an OptInHandler object from the SDK.
$optInHandler = $mg->OptInHandler(); $optInHandler = $mg->OptInHandler();
$ Next, grab the hash. # Next, grab the hash.
$inboundHash = $_GET['hash']; $inboundHash = $_GET['hash'];
$secretPassphrase = 'a_secret_passphrase'; $secretPassphrase = 'a_secret_passphrase';
@ -77,13 +77,20 @@ if($hashValidation){
'subscribed' => 'yes'); 'subscribed' => 'yes');
$mg->sendMessage($domain, array('from' => 'bob@example.com', $mg->sendMessage($domain, array('from' => 'bob@example.com',
'to' => 'sally@example.com', 'to' => 'sally@example.com',
'subject' => 'Please Confirm!', 'subject' => 'Please Confirm!',
'html' => '<html><body>Hello,<br><br>We've successfully subscribed you to the list, {$mailingList}! 'html' => '<html><body>Hello,<br><br>We\'ve successfully subscribed
<br><br>Thank you!</body></html>')); you to the list, {$mailingList}!<br><br>Thank you!
</body></html>'));
} }
``` ```
A few notes:
1. 'a_secret_passphrase' can be anything. It's used as the *key* in hashing, since your email address will vary.
2. validateHash() will return an array containing the recipient address and list address.
3. You should *always* send an email confirmation before and after the subscription request.
4. WARNING: On $_GET['hash'], you need to sanitize this value to prevent malicious attempts to inject code.
Available Functions Available Functions
----------------------------------------------------- -----------------------------------------------------
@ -93,4 +100,4 @@ Available Functions
More Documentation More Documentation
------------------ ------------------
See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html) for more information. See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html) for more information.