zestic/communication-component

Communication component for Laminas using Symfony Messenger and Notifier

v1.6.3 2024-11-07 02:30 UTC

Requires

• php: ^8.0
• iampersistent/config-value-component: ^1.2
• laminas/laminas-servicemanager: ^4.0.0-rc1
• mezzio/mezzio-twigrenderer: ^2.6
• netglue/laminas-messenger: ^2.0
• psr/container: ^1.0 || ^2.0
• symfony/dependency-injection: ^5.3 || ^6.0 || ^7.0
• symfony/event-dispatcher: ^5.3 || ^6.0 || ^7.0
• symfony/mailer: ^5.3 || ^6.0 || ^7.0
• symfony/messenger: ^5.3 || ^6.0 || ^7.0
• symfony/notifier: ^5.3 || ^6.0 || ^7.0
• symfony/property-access: ^5.3 || ^6.0 || ^7.0
• symfony/serializer: ^5.3 || ^6.0 || ^7.0
• symfony/twig-bridge: ^5.3 || ^6.0 || ^7.0
• twig/inky-extra: ^3.1
• twig/twig: ^3.0

Requires (Dev)

• symfony/amazon-mailer: ^5.3

MIT

README

This component sends communications of any variety, email, sms, chat based on the user's preferences. Under the hood, it is using Symfony Notifier and Symfony Messenger.

Getting started

The simplest setup is to have an email sent to an SMTP channel. To set up the configuration, add the following to config\config.php

$aggregator = new ConfigAggregator([
    ...
    \Communication\ConfigProvider::class,
    ...

Next, create communication.global.php and set up a simple route.

return [
    'communication' => [
        'routes' => [
            'email' => 'channel'
        ],
    ],
];

If you don't set the from address globally, you can also set it on a communication level.

In your .env file set the configuration for the email communication channel

COMMUNICATION_TRANSPORT_EMAIL_TYPE=smtp
COMMUNICATION_TRANSPORT_EMAIL_AUTH_MODE=login
COMMUNICATION_TRANSPORT_EMAIL_ENCRYPTION=ssl
COMMUNICATION_TRANSPORT_EMAIL_USERNAME=********
COMMUNICATION_TRANSPORT_EMAIL_PASSWORD=********
COMMUNICATION_TRANSPORT_EMAIL_URI=smtp.mailtrap.io
COMMUNICATION_TRANSPORT_EMAIL_PORT=2525

// todo: set up a generic template

Now from the root of your project

vendor/bin/laminas communication:send-test-email [e-mail] --from=[e-mail]

The email should be delivered to you.

Using Messenger

To use Messenger to help handle the delivery of the emails simply update the communication.global.php file.

return [
    'communication' => [
        'routes' => [
            'email' => 'bus'
        ],
    ],
];

This will default to using the Doctrine transport. If you want to change the transort, in your .env file add the transport.

COMMUNICATION_MESSENGER_TRANSPORT_DNS=redis://localhost:6379/messages

Refer to the Symfony Messenger Transport Configuration documentation for more information on available transport configurations.

Once again run

vendor/bin/laminas communication:send-test-email [e-mail] --from=[e-mail]

The command will complete, however, if you check, you will not see the email in your inbox. That's because you need to start the message consumer. That is a pretty straight forward process.

vendor/bin/laminas messenger:consume communication.bus.transport.email

This will start the consumer. Your test email will now be in your inbox.

See more information on how to set up your consumers in the Symfony Messenger documentation

Handling Failures

To get a list of the failed messages, run this command

vendor/bin/laminas messenger:failed:show -vv

You can see details about a specific failure

vendor/bin/laminas messenger:failed:show {id} -vv

You can view and retry messages one-by-one

vendor/bin/laminas messenger:failed:retry -vv

You can retry specific messages

vendor/bin/laminas messenger:failed:retry {id1} {id2} --force

You can retry all messages at once

vendor/bin/laminas messenger:failed:retry --force

You can also remove a message without retrying it

vendor/bin/laminas messenger:failed:remove {id}

Future plans

• Some refactoring to decrease complexity
• Allow part of context to be overridden by the Recipient