# mailslurp.api.ContactControllerApi
# Load the API package
import 'package:mailslurp/api.dart';
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createContact | POST /contacts | Create a contact |
deleteContact | DELETE /contacts/{contactId} | Delete contact |
getAllContacts | GET /contacts/paginated | Get all contacts |
getContact | GET /contacts/{contactId} | Get contact |
getContacts | GET /contacts | Get all contacts |
# createContact
ContactDto createContact(createContactOptions)
Create a contact
# Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
var api_instance = ContactControllerApi();
var createContactOptions = CreateContactOptions(); // CreateContactOptions | createContactOptions
try {
var result = api_instance.createContact(createContactOptions);
print(result);
} catch (e) {
print("Exception when calling ContactControllerApi->createContact: $e\n");
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
createContactOptions | CreateContactOptions | createContactOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# deleteContact
deleteContact(contactId)
Delete contact
# Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
var api_instance = ContactControllerApi();
var contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | contactId
try {
api_instance.deleteContact(contactId);
} catch (e) {
print("Exception when calling ContactControllerApi->deleteContact: $e\n");
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
contactId | String | contactId | [default to null] |
# Return type
void (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getAllContacts
PageContactProjection getAllContacts(page, size, sort)
Get all contacts
# Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
var api_instance = ContactControllerApi();
var page = 56; // int | Optional page index in inbox list pagination
var size = 56; // int | Optional page size in inbox list pagination
var sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
try {
var result = api_instance.getAllContacts(page, size, sort);
print(result);
} catch (e) {
print("Exception when calling ContactControllerApi->getAllContacts: $e\n");
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page index in inbox list pagination | [optional] [default to 0] |
size | int | Optional page size in inbox list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getContact
ContactDto getContact(contactId)
Get contact
# Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
var api_instance = ContactControllerApi();
var contactId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | contactId
try {
var result = api_instance.getContact(contactId);
print(result);
} catch (e) {
print("Exception when calling ContactControllerApi->getContact: $e\n");
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
contactId | String | contactId | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getContacts
List
getContacts()
Get all contacts
# Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
var api_instance = ContactControllerApi();
try {
var result = api_instance.getContacts();
print(result);
} catch (e) {
print("Exception when calling ContactControllerApi->getContacts: $e\n");
}
# Parameters
This endpoint does not need any parameter.
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]