README

Pure PHP repository for using Notifea services.

Notifea provides clients very user-friendly way of sending transactional emails and sms to their users.

Install

To install the SDK you need to be using Composer in your project. To install it please see the docs.

After you installed Composer install the SDK

composer require notifea/notifea-php

Minimum requirements

This package will require you to use:

PHP 7.0 or higher
guzzlehttp/guzzle 6.0 or higher
ext-json

Usage

All email and sms endpoints are accessed via NotifeaClient. First start by configuring this client.

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

Your authentication token can be generated in access-tokens section.

Usage - emails

To interact with email endpoints use EmailService. First start by instantiating.

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

$emailService = new EmailService($client);

Send email

Sending an email can be as simple as using this few lines of code:

$email = new Email();
$email->setFrom('newadress@notifea.com', 'New Address')
    ->setRecipient('customer@business.com')
    ->setReplyTo('reply_to@notifea.com')
    ->setSubject('My first email')
    ->setHtmlBody('<p>This is my first email</p>')
    ->setCc('cc@notifea.com')
;

$sentEmail = $emailService->sendEmail($email);

$sentEmail will contain updated Email object with all interesting information.

Get emails

To get emails, use this piece of code:

$emails = $emailService->getEmails();

$emails will be a new Collection containing all returned Email objects

Get single email

To get a single email entity, only email uuid is needed:

$email = $emailService->getEmail('8fc2c850-81c0-4424-823a-aa4727441864');

$email will be an Email object

Delete email

To delete a single email entity from notifea database, usage of this function is sufficient

$result = $emailService->deleteEmail('8fc2c850-81c0-4424-823a-aa4727441864');

$result will be an either true on successful deletion or NotifeaException will be triggered on any failure (such as email not found)

Usage - sms

To interact with sms endpoints use SmsService. First start by instantiating.

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

$smsService = new SmsService($client);

Send sms

Sending an sms can be as simple as using this few lines of code:

$sms = new Sms();
$sms
    ->setRecipient('+421902739429')
    ->setSmsSenderid('59634971-e57f-44af-b530-038e27e7064e')
    ->setContent('My awesome SMS message.')
;

$sentSms = $smsService->sendSms($sms);

$sentSms will contain updated Sms object with all interesting information.

To find out what is your sms_sender_id go into your Management section of your sms senders.

Get sms

To get all sms, use this piece of code:

$smss = $smsService->getSmss();

$smss will be a new Collection containing all returned Sms objects

Get single sms

To get a single sms entity, only sms uuid is needed:

$sms = $smsService->getSms('8fc2c850-81c0-4424-823a-aa4727441864');

$sms will be an Sms object

Delete sms

To delete a single sms entity from notifea database, this function is sufficient

$result = $smsService->deleteSms('8fc2c850-81c0-4424-823a-aa4727441864');

$result will be an either true on successful deletion or NotifeaException will be triggered on any failure (such as sms not found)

Usage - sms senders

Since May our customers may interact with sms senders by using SmsSenderService. This is especially handy if you need to have different Sender Names shown in your SMS

First start by instantiating.

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

$smsSenderService = new SmsSenderService($client);

Create sms sender

Creating an sms sender can be as simple as using this few lines of code:

$smsSender = new SmsSender();
$smsSender
    ->setSenderName('My Sender')
;

$createdSmsSender = $smsSenderService->createSmsSender($smsSender);

$createdSmsSender will contain updated SmsSender object with all interesting information such as your sms_sender_id that you need for sending SMS.

Get sms senders

To get all sms senders, use this piece of code:

$smsSenders = $smsSenderService->getSmsSenders();

$smsSenders will be a new Collection containing all returned SmsSender objects

Get single sms sender

To get a single sms sender entity, only sms sender uuid is needed:

$smsSender = $smsSenderService->getSmsSender('8fc2c850-81c0-4424-823a-aa4727441864');

$smsSender will be an SmsSender object

Update sms sender

To update a single sms sender entity, you may use updateSmsSender() method and pass in an SmsSender object with the updated data

$smsSender = new SmsSender();
$smsSender
    ->setUuid('8fc2c850-81c0-4424-823a-aa4727441864') // required in order to know which sms sender do you wish to update
    ->setSenderName('My New Name')
    ->setLiveTime(25)
;

$result = $smsSenderService->updateSmsSender($smsSender);

Delete sms sender

To delete a single sms sender entity from notifea database, this function is sufficient

$result = $smsSenderService->deleteSmsSender('8fc2c850-81c0-4424-823a-aa4727441864');

$result will be an either true on successful deletion or NotifeaException will be triggered on any failure (such as sms sender not found)

Community

Contributing

Dependencies are managed through composer:

$ composer install

Tests can be run via phpunit:

$ vendor/bin/phpunit

notifea / notifea-php

Maintainers

Details