Files
board-mate/api-customer/api-resources/mail-components/docs/MailApi.md
2026-01-05 22:16:39 +01:00

74 lines
1.7 KiB
Markdown

# board_mate.mail.MailApi
All URIs are relative to *https://boardmate_api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**send**](MailApi.md#send) | **POST** /mail/send | POST mail/send
# **send**
> str send(body)
POST mail/send
### Example
```python
import time
import os
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 Exception as e:
print("Exception when calling MailApi->send: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **str**| |
### Return type
**str**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)