ruudk/postmark-bundle

This bundle lets you send messages via Postmark. It can offload the sending of messages to a Resque worker for speed and reliability.

RuudkPostmarkBundle

, _(*1)

This bundle lets you send messages via Postmark. It can offload the sending of messages to a Resque worker for speed and reliability., _(*2)

Installation

Step1: Require the package with Composer

php composer.phar require ruudk/postmark-bundle, _(*3)

Step2: Enable the bundles

Enable the bundles in the kernel:, _(*4)

``` php <?php // app/AppKernel.php, <sub>(*5)</sub>

public function registerBundles() { $bundles = array( // ... new BCC\ResqueBundle\BCCResqueBundle(), new Ruudk\PostmarkBundle\RuudkPostmarkBundle(), ); }, <sub>(*6)</sub>

### Step3: Configure

Configure the bundle.

``` yaml
# app/config/config_prod.yml
ruudk_postmark:
    token: API KEY

Optionally, you can specify extra options, <sub>(*7)</sub>

``` yaml ruudk_postmark: delayed: true # Offload everything to a Resque worker by default disable_delivery: false # Set true for test environment from: email: info@my-app.com # Default from email name: My App, Inc # Default from name resque: queue: my-queue-name # Resque queue name to use, default is 'postmark' curl: timeout: 10 # Default Buzz\Curl timeout is 5 connect_timeout: 2, <sub>(*8)</sub>

If you want to configure the BCCResqueBundle, check the [docs](https://github.com/michelsalib/BCCResqueBundle#optional-set-configuration).

Congratulations! You're ready.

## Usage

### Composing messages

````php
/**
 * @var \Ruudk\PostmarkBundle\Postmark\Postmark $postmark
 */
$postmark = $this->container->get('ruudk_postmark.postmark');

$message = $postmark->compose();
$message->addTo('test@gmail.com');
$message->setSubject('Subject');
$message->setTextBody('Body');
$message->setHtmlBody('Body');

Sending messages

If you want to send the message directly:, <sub>(*9)</sub>

$postmark->send($message);

To send the message to a Resque worker, add an extra delayed() method:, <sub>(*10)</sub>

$postmark->delayed()->send($message);

Batches

To send multiple messages in a batch (one API call):, <sub>(*11)</sub>

$postmark->enqueue($message1);
$postmark->enqueue($anotherMessage);

$postmark->send();

Twig templates

This bundle supports Twig so that you can send a new message using a Twig template as a base., <sub>(*12)</sub>

Create a Twig template with a couple of blocks. It's not necessary to have them all., <sub>(*13)</sub>

{# AppBundle:Mail:email.html.twig #}
{% block subject %}
The subject of the message
{% endblock %}

{% block text %}
Hi {{ name }},

How are you today?
{% endblock text %}

{% block html %}


Hi {{ name }},, (*14)


    <p>How are you today?</p>
{% endblock html %}

And compose the message:, <sub>(*15)</sub>

$message = $postmark->compose('AppBundle:Mail:email.html.twig', array(
    'name' => 'Ruud'
));
$message->addTo('test@gmail.com');

$postmark->send($message);

Resque

If you want to use a Resque worker to send the messages you'll have to start the worker first: php app/console bcc:resque:worker-start -f postmark, <sub>(*16)</sub>

Now when you send a message with the delayed() method the worker will pick it up and send it., <sub>(*17)</sub>

Author

Ruud Kamphuis, <sub>(*18)</sub>