Giter Club home page Giter Club logo

mailslurp-swagger's Introduction

MailSlurp is an end-to-end email testing service. It has a web-app for managing your account and a REST API for sending and receiving emails from randomly generated email addresses. ## Why? MailSlurp was built to test the integration of email services within an app. If your application relies on the sending or receiving of emails, then MailSlurp will let you test that functionality. This is a more common need than you might think: if your app has a sign up process that requires email verification, how do you currently test that? ## Getting started - API Docs - Code Examples - Swagger Definition Every API request requires a valid API Key appended as a query parameter. To obtain an API Key visit your account dashboard. The general flow is as follows: - Create a new inbox during a test. The email address will be returned in the response. - Send an email to that address or trigger an action in your test that does so. - Fetch the email for your new inbox and check if its content is what you expected, or use the content in another action. ## SDK - There is an official Javascript SDK available on npm. - You can also use the swagger JSON definition and swagger-codegen to generate a swagger client in a language of your choice. ## Legal The Mailslurp API code is owned by PettmanUG and uses a proprietary software licence. The SDKs are free to use in any project and have an ISC licence. ## Bugs, features, support To report bugs or request features please see the contact page. For help see support.

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

  • API version: 0.0.1
  • Package version: 0.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/quartzy/mailslurp-swagger.git"
    }
  ],
  "require": {
    "quartzy/mailslurp-swagger": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to//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 MailSlurp\Swagger\Api\InboxControllerApi(
    // 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()
);
$apiKey = "test"; // string | Your API Key. Sign up and find it in your dashboard.

try {
    $result = $apiInstance->createRandomInboxUsingPOST($apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InboxControllerApi->createRandomInboxUsingPOST: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.mailslurp.com

Class Method HTTP request Description
InboxControllerApi createRandomInboxUsingPOST POST /inboxes Create an inbox
InboxControllerApi deleteInboxUsingDELETE DELETE /inboxes/{uuid} Delete an inbox
InboxControllerApi getEmailsForInboxUsingGET GET /inboxes/{uuid} Fetch emails for a given inbox
InboxControllerApi getListOfInboxesUsingGET GET /inboxes List your inboxes
InboxControllerApi sendEmailFromUserUsingPOST POST /inboxes/{uuid} Send an email
UserControllerApi getUserUsingGET GET /user Fetch a user

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

mailslurp-swagger's People

Contributors

camuthig avatar

Watchers

James Cloos avatar

mailslurp-swagger's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.