https://github.com/symfony/click-send-notifier

Symfony ClickSend Notifier Bridge
https://github.com/symfony/click-send-notifier

click-send component notifier php symfony symfony-component

Last synced: about 1 month ago
JSON representation

Symfony ClickSend Notifier Bridge

• Host: GitHub
• URL: https://github.com/symfony/click-send-notifier
• Owner: symfony
• License: mit
• Created: 2023-05-12T13:58:59.000Z (over 1 year ago)
• Default Branch: 7.1
• Last Pushed: 2024-09-27T08:42:36.000Z (about 2 months ago)
• Last Synced: 2024-09-30T16:03:17.247Z (about 2 months ago)
• Topics: click-send, component, notifier, php, symfony, symfony-component
• Language: PHP
• Homepage: https://symfony.com/notifier
• Size: 43.9 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ClickSend Notifier

==================

Provides [ClickSend](https://www.clicksend.com/) integration for Symfony Notifier.

DSN example

-----------

```

CLICKSEND_DSN=clicksend://API_USERNAME:API_KEY@default?from=FROM&source=SOURCE&list_id=LIST_ID&from_email=FROM_EMAIL

```

where:

 - `API_USERNAME` is your ClickSend API username

 - `API_KEY` is your ClickSend API key

 - `FROM` is your sender (optional)

 - `SOURCE` is your source method of sending (optional)

 - `LIST_ID` is your recipient list ID (optional)

 - `FROM_EMAIL` is your from email where replies must be emailed (optional)

Adding Options to a Message

---------------------------

With a ClickSend Message, you can use the `ClickSendOptions` class to add

[message options](https://developers.clicksend.com/docs/rest/v3/#send-sms/).

```php

use Symfony\Component\Notifier\Message\SmsMessage;

use Symfony\Component\Notifier\Bridge\ClickSend\ClickSendOptions;

$sms = new SmsMessage('+1411111111', 'My message');

$options = (new ClickSendOptions())

    ->country('country')

    ->customString('custom_string')

    ->fromEmail('from_email')

    ->listId('list_id')

    ->schedule(999)

    ->source('source')

    // ...

    ;

// Add the custom options to the sms message and send the message

$sms->options($options);

$texter->send($sms);

```

Resources

---------

 * [Contributing](https://symfony.com/doc/current/contributing/index.html)

 * [Report issues](https://github.com/symfony/symfony/issues) and

   [send Pull Requests](https://github.com/symfony/symfony/pulls)

   in the [main Symfony repository](https://github.com/symfony/symfony)