lkaybob/toast-cloud-mail-php

dev-master 2019-10-04 16:39 UTC

This package is auto-updated.

Last update: 2024-05-05 02:42:00 UTC


README

Toast Cloud SMS API Specification

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/lkaybob/toast-cloud-mail-php.git"
    }
  ],
  "require": {
    "lkaybob/toast-cloud-mail-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/toast-cloud-mail-php/vendor/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');

$apiInstance = new ToastCloud\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$appKey = "appKey_example"; // string | Project별 고유의 앱키
$body = new \ToastCloud\Model\MailBody(); // \ToastCloud\Model\MailBody | 

try {
    $apiInstance->appKeySenderEachMailPost($appKey, $body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->appKeySenderEachMailPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api-mail.cloud.toast.com/email/v1.5/appKeys/

Class Method HTTP request Description
DefaultApi appKeySenderEachMailPost POST /{appKey}/sender/eachMail 개별 메일 발송
DefaultApi appKeySenderMailsGet GET /{appKey}/sender/mails 메일 발송 리스트 조회
DefaultApi sendMail POST /{appKey}/sender/mail 일반 메일 발송

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author