Download the PHP package craftcodery/clicksend without Composer
On this page you can find all versions of the php package craftcodery/clicksend. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download craftcodery/clicksend
More information about craftcodery/clicksend
Files in craftcodery/clicksend
Package clicksend
Short Description ClickSend integration for Laravel
License MIT
Homepage https://github.com/craftcodery/clicksend
Informations about the package clicksend
Simple ClickSend mailers for Laravel
This package makes it easy to send letters and postcards via ClickSend for your Laravel app.
Installation
You can install the package via composer:
Preparing the database
You must publish and run migrations:
Publishing the config file
You can publish the config file with:
Publishing the config allows you to customize the environment variables used for setting your ClickSend username and API key.
Configuring for usage
Start by setting environment variables for your ClickSend username and API Key. By default the package looks for CLICKSEND_USERNAME
and CLICKSEND_KEY
.
Any models that you want to be able to receive mailers need to use CraftCodery\ClickSend\Traits\CanReceiveMailers
. This trait only requires one method, mailerRecipientAddress
, which returns an array of formatted address information. An example of the required array structure is below.
Similarly, any models that you want to be able to send mailers need to use CraftCodery\ClickSend\Traits\CanSendMailers
. This trait only requires the method mailerReturnAddress
, which returns an array of formatted return address information. An example of the required array structure is below.
Sending items
The sendLetterTo
and sentPostcardTo
methods are available to any models using the CanSendMailers
trait.
Each method requires a recipient model (that uses the CanReceiveMailers
trait) as the first parameter. Letters require the content as the second parameter, while postcards require a PDF URL for the second parameter, and the content for the third parameter.
The PDF used as the second parameter in the postcard method will be sent on the front of the postcard. The content will be sent on the rear.
License
The MIT License (MIT). Please see License File for more information.
All versions of clicksend with dependencies
ext-json Version *
barryvdh/laravel-dompdf Version ^2.0
guzzlehttp/guzzle Version ^7.0.1
illuminate/http Version ^10.0
illuminate/support Version ^10.0