Skip to content
This repository was archived by the owner on Dec 22, 2019. It is now read-only.

Commit ce885b4

Browse files
committedJul 12, 2014
Updated Readme to include docs for newly added features and the installation difference for Laravel 4.2
1 parent cabb5e1 commit ce885b4

File tree

1 file changed

+74
-1
lines changed

1 file changed

+74
-1
lines changed
 

‎README.md

+74-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ It's main advantage is that the syntax is the same as the Laravel Mail component
2424
- [Embedding Inline Images](#embedding-inline-images)
2525
- [Scheduling](#scheduling)
2626
- [Tagging](#tagging)
27+
- [Campaigns](#campaigns)
28+
- [Tracking](#tracking)
29+
- [Dkim](#dkim)
2730
- [Testmode](#testmode)
2831
- [Catch all](#catch-all)
2932
- [Custom Data](#custom-data)
@@ -33,8 +36,16 @@ It's main advantage is that the syntax is the same as the Laravel Mail component
3336

3437
Open your `composer.json` file and add the following to the `require` key:
3538

39+
### Laravel 4.2 ###
40+
41+
"bogardo/mailgun": "v3.0.*"
42+
43+
### Laravel 4.1/4.0 ###
44+
3645
"bogardo/mailgun": "v2.*"
3746

47+
---
48+
3849
After adding the key, run composer update from the command line to install the package
3950

4051
```bash
@@ -358,6 +369,66 @@ Mailgun::send('emails.welcome', $data, function($message)
358369

359370
>If you pass more than 3 tags to the `tag` method it will only use the first 3, the others will be ignored.
360371
372+
### Campaigns ###
373+
If you want your emails to be part of a campaign you created in Mailgun, you can add the campaign to a message with the `campaign` method.
374+
This method accepts a single ID `string` or an `array` of ID's (with a maximum of 3)
375+
376+
```php
377+
Mailgun::send('emails.welcome', $data, function($message)
378+
{
379+
$message->campaign('my_campaign_id');
380+
//or
381+
$message->campaign(array('campaign_1', 'campaign_2', 'campaign_3'));
382+
});
383+
```
384+
385+
### Tracking ###
386+
You can toggle tracking on a per message basis.
387+
388+
```php
389+
Mailgun::send('emails.welcome', $data, function($message)
390+
{
391+
$message->tracking(true);
392+
//or
393+
$message->tracking(false);
394+
});
395+
```
396+
397+
#### Tracking Clicks ####
398+
Toggle clicks tracking on a per-message basis. Has higher priority than domain-level setting.
399+
400+
```php
401+
Mailgun::send('emails.welcome', $data, function($message)
402+
{
403+
$message->trackClicks(true);
404+
//or
405+
$message->trackClicks(false);
406+
});
407+
```
408+
409+
#### Tracking Opens ####
410+
Toggle opens tracking on a per-message basis. Has higher priority than domain-level setting.
411+
412+
```php
413+
Mailgun::send('emails.welcome', $data, function($message)
414+
{
415+
$message->trackOpens(true);
416+
//or
417+
$message->trackOpens(false);
418+
});
419+
```
420+
421+
### DKIM ###
422+
Enable/disable DKIM signatures on per-message basis. ([see Mailgun Docs](http://documentation.mailgun.com/user_manual.html#verifying-your-domain))
423+
```php
424+
Mailgun::send('emails.welcome', $data, function($message)
425+
{
426+
$message->dkim(true);
427+
//or
428+
$message->dkim(false);
429+
});
430+
```
431+
361432
### Testmode ###
362433
You can send messages in test mode. When you do this, Mailgun will accept the message but will not send it. This is useful for testing purposes.
363434

@@ -395,7 +466,9 @@ Mailgun::send('emails.welcome', $data, function($message)
395466
});
396467
```
397468

398-
### Email Validation ###
469+
---
470+
471+
## Email Validation ##
399472
Mailgun offers an email validation service which checks an email address on the following:
400473
* Syntax checks (RFC defined grammar)
401474
* DNS validation

0 commit comments

Comments
 (0)
This repository has been archived.