board-mate.mail

boardmate_api API

This Python package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import board_mate.mail

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import board_mate.mail

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import time
import board_mate.mail
from board_mate.mail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://boardmate_api
# See configuration.py for a list of all supported configuration parameters.
configuration = board_mate.mail.Configuration(
    host = "https://boardmate_api"
)



# Enter a context with an instance of the API client
with board_mate.mail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = board_mate.mail.MailApi(api_client)
    body = 'body_example' # str | 

    try:
        # POST mail/send
        api_response = api_instance.send(body)
        print("The response of MailApi->send:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MailApi->send: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://boardmate_api

Class	Method	HTTP request	Description
MailApi	send	POST /mail/send	POST mail/send

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

2.4 KiB Raw Permalink Blame History