silinternational/email-service-php-client

PHP client to interact with our Email Service API: https://github.com/silinternational/email-service

Maintainers

Details

github.com/silinternational/email-service-php-client

Source

Issues

Installs: 16 670

Dependents: 1

Suggesters: 1

Security: 0

Stars: 0

Watchers: 6

Forks: 1

Open Issues: 1

2.4.3 2024-10-30 14:25 UTC

Requires

Requires (Dev)

MIT 3c9513824e89b10b8a851282a98eee49c86f16fe

  • SIL GTIS <gtis_itse_support+idp.woop@sil.org>

apiemailphp client

This package is auto-updated.

Last update: 2024-10-30 14:28:28 UTC

README

PHP client to interact with our Email Service's API.

This client is built on top of Guzzle, the PHP HTTP Client. Guzzle has a simple way to create API clients by describing the API in a Swagger-like format without the need to implement every method yourself. So adding support for more APIs is relatively simple.

Install

Installation is simple with Composer:

$ composer require silinternational/email-service-php-client

Usage

Example:

<?php

use Sil\EmailService\Client\EmailServiceClient;

$emailServiceClient = new EmailServiceClient(
    'https://api.example.com/', // The base URI for the API.
    'DummyAccessToken', // Your HTTP header authorization bearer token.
    [
        'http_client_options' => [
            'timeout' => 10, // An (optional) custom HTTP timeout, in seconds.
        ],
    ]
);

$email = $emailServiceClient->email([
    "to_address" => "test@domain.com",
    "cc_address" => "other@domain.com",   // optional
    "bcc_address" => "bcc@domain.com",    // optional
    "subject" => "Test Subject",
    "text_body" => "this is text",        // either text_body or html_body is required, but both can be provided
    "html_body" => "<b>this is html</b>",
]);

To send an email with a delay of a fixed amount of time:`

$email = $emailServiceClient->email([
    "to_address" => "test@domain.com",
    "subject" => "Test Subject",
    "html_body" => "<b>this is html</b>",
    "delay_seconds" => "3600",
]);

Or to schedule an email, use send_after with a Unix timestamp:

$email = $emailServiceClient->email([
    "to_address" => "test@domain.com",
    "subject" => "Test Subject",
    "html_body" => "<b>this is html</b>",
    "send_after" => "1556825944",
]);

Tests

To run the unit tests for this, run make test.

Guzzle Service Client Notes