nextgen-solution/pigeon

This package is abandoned and no longer maintained. No replacement package was suggested.

1.1 2019-08-06 10:02 UTC

Requires

• guzzlehttp/guzzle: ^6.3

MIT

• Tetat Jearuksuwan

README

Pigeon document is here!

Installation

1. Install via composer composer require nextgen-solution/pigeon
2. Publish configuration php artisan vendor:publish
3. Update your env

   PIGEON_HOST=
   PIGEON_KEY=
   

4. Enjoy!

Interface

/**
 * Send an email to recipient via Pigeon's service.
 *
 * @param  string $recipient
 * @param  string $template
 * @param  array $params
 * @return  array
 */
Pigeon::mail($recipient, $template, array $params = [])

/**
 * Send a text to recipient via Pigeon's service.
 *
 * @param  string $recipient
 * @param  string $template
 * @param  array $params
 * @return  array
 */
Pigeon::text($recipient, $template, array $params = [])

/**
 * Request Pigeon to generate an OTP and send it via mail.
 *
 * @param  string $recipient
 * @param  string $template
 * @return  array
 */
Pigeon::otpMail($recipient, $template)

/**
 * Request Pigeon to generate an OTP and send it via text.
 *
 * @param  string $recipient
 * @param  string $template
 * @return  array
 */
Pigeon::otpText($recipient, $template)

/**
 * Verify user's OTP.
 *
 * @param  string $recipient
 * @param  string $otp
 * @param  string $reference
 * @return  array
 */
Pigeon::otpVerify($recipient, $otp, $reference)