revenuewire / email-sdk-php
v1.3
2017-04-19 20:52 UTC
Requires
- php: >=5.4
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ~4.8
- satooshi/php-coveralls: ~1.0
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-11-12 05:46:08 UTC
README
An email service
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Build package: io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.4.0 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/revenuewire/email-sdk-php.git"
}
],
"require": {
"revenuewire/email-sdk-php": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: APIKeyHeader Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer'); // Configure API key authorization: JWTHeader Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Authorization-JWT', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Authorization-JWT', 'Bearer'); $api_instance = new Swagger\Client\Api\EmailsApi(); try { $result = $api_instance->getEmailTypes(); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailsApi->getEmailTypes: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://localhost/v1
Documentation For Models
- EmailType
- EmailTypeTemplate
- EmailTypeTemplateTo
- EmailTypeVariable
- Error
- InlineResponse200
- Mailer
- Message
- NewResource
- NewTemplate
- NewTemplateContent
- PreviewContent
- PreviewResult
- PreviewResultHtml
- Resource
- Response
- Template
- TemplateContent
- TemplateContents
- UpdateResource
- UpdateTemplate
- UpdateTemplateContent
Documentation For Authorization
APIKeyHeader
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
JWTHeader
- Type: API key
- API key parameter name: X-Authorization-JWT
- Location: HTTP header