https://github.com/lkaybob/toast-cloud-mail-php

https://github.com/lkaybob/toast-cloud-mail-php

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lkaybob/toast-cloud-mail-php
• Owner: lkaybob
• Created: 2019-10-04T16:36:38.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-04T16:39:27.000Z (about 5 years ago)
• Last Synced: 2024-10-13T13:26:24.699Z (25 days ago)
• Language: PHP
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# toast-cloud-mail-php

Toast Cloud SMS API Specification

This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/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](http://getcomposer.org/), 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`:

```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](#installation--usage) and then run the following:

```php

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**](docs/Api/DefaultApi.md#appkeysendereachmailpost) | **POST** /{appKey}/sender/eachMail | 개별 메일 발송

*DefaultApi* | [**appKeySenderMailsGet**](docs/Api/DefaultApi.md#appkeysendermailsget) | **GET** /{appKey}/sender/mails | 메일 발송 리스트 조회

*DefaultApi* | [**sendMail**](docs/Api/DefaultApi.md#sendmail) | **POST** /{appKey}/sender/mail | 일반 메일 발송

## Documentation For Models

 - [MailBody](docs/Model/MailBody.md)

 - [Receiver](docs/Model/Receiver.md)

 - [ResponseBody](docs/Model/ResponseBody.md)

 - [ResponseBodyItem](docs/Model/ResponseBodyItem.md)

 - [ResponseHeader](docs/Model/ResponseHeader.md)

 - [ResponsePayload](docs/Model/ResponsePayload.md)

 - [ResponsePayloadBody](docs/Model/ResponsePayloadBody.md)

## Documentation For Authorization

 All endpoints do not require authorization.

## Author