MailSlurp | MailSlurp\GroupControllerApi docs php docs Api

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

Method	HTTP request	Description
addContactsToGroup	PUT /groups/{groupId}/contacts	Add contacts to a group
createGroup	POST /groups	Create a group
deleteGroup	DELETE /groups/{groupId}	Delete group
getAllGroups	GET /groups/paginated	Get all Contact Groups in paginated format
getGroup	GET /groups/{groupId}	Get group
getGroupWithContacts	GET /groups/{groupId}/contacts	Get group and contacts belonging to it
getGroupWithContactsPaginated	GET /groups/{groupId}/contacts-paginated
getGroups	GET /groups	Get all groups
removeContactsFromGroup	DELETE /groups/{groupId}/contacts	Remove contacts from a group

addContactsToGroup

MailSlurpModelsGroupContactsDto addContactsToGroup($group_id, $update_group_contacts)

Add contacts to a group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$group_id = 'group_id_example'; // string | 
$update_group_contacts = new MailSlurpModelsUpdateGroupContacts(); // MailSlurpModelsUpdateGroupContacts | 

try {
    $result = $apiInstance->addContactsToGroup($group_id, $update_group_contacts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->addContactsToGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	string
update_group_contacts	MailSlurpModelsUpdateGroupContacts

Return type

MailSlurpModelsGroupContactsDto

Authorization

API_KEY

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

createGroup

MailSlurpModelsGroupDto createGroup($create_group_options)

Create a group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$create_group_options = new MailSlurpModelsCreateGroupOptions(); // MailSlurpModelsCreateGroupOptions | 

try {
    $result = $apiInstance->createGroup($create_group_options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
create_group_options	MailSlurpModelsCreateGroupOptions

Return type

MailSlurpModelsGroupDto

Authorization

API_KEY

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

deleteGroup

deleteGroup($group_id)

Delete group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$group_id = 'group_id_example'; // string | 

try {
    $apiInstance->deleteGroup($group_id);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	string

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getAllGroups

MailSlurpModelsPageGroupProjection getAllGroups($page, $size, $sort, $since, $before)

Get all Contact Groups in paginated format

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$page = 0; // int | Optional page  in list pagination
$size = 20; // int | Optional page size in list pagination
$sort = 'ASC'; // string | Optional createdAt sort direction ASC or DESC
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at after the given timestamp
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at before the given timestamp

try {
    $result = $apiInstance->getAllGroups($page, $size, $sort, $since, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getAllGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page	int	Optional page in list pagination	[optional] [default to 0]
size	int	Optional page size in list pagination	[optional] [default to 20]
sort	string	Optional createdAt sort direction ASC or DESC	[optional] [default to ‘ASC’]
since	DateTime	Filter by created at after the given timestamp	[optional]
before	DateTime	Filter by created at before the given timestamp	[optional]

Return type

MailSlurpModelsPageGroupProjection

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getGroup

MailSlurpModelsGroupDto getGroup($group_id)

Get group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$group_id = 'group_id_example'; // string | 

try {
    $result = $apiInstance->getGroup($group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	string

Return type

MailSlurpModelsGroupDto

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getGroupWithContacts

MailSlurpModelsGroupContactsDto getGroupWithContacts($group_id)

Get group and contacts belonging to it

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$group_id = 'group_id_example'; // string | 

try {
    $result = $apiInstance->getGroupWithContacts($group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getGroupWithContacts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	string

Return type

MailSlurpModelsGroupContactsDto

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getGroupWithContactsPaginated

MailSlurpModelsPageContactProjection getGroupWithContactsPaginated($group_id, $page, $size, $sort, $since, $before)

Get group and paginated contacts belonging to it

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$group_id = 'group_id_example'; // string | 
$page = 0; // int | Optional page  in group contact pagination
$size = 20; // int | Optional page size in group contact pagination
$sort = 'ASC'; // string | Optional createdAt sort direction ASC or DESC
$since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at after the given timestamp
$before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at before the given timestamp

try {
    $result = $apiInstance->getGroupWithContactsPaginated($group_id, $page, $size, $sort, $since, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->getGroupWithContactsPaginated: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	string
page	int	Optional page in group contact pagination	[optional] [default to 0]
size	int	Optional page size in group contact pagination	[optional] [default to 20]
sort	string	Optional createdAt sort direction ASC or DESC	[optional] [default to ‘ASC’]
since	DateTime	Filter by created at after the given timestamp	[optional]
before	DateTime	Filter by created at before the given timestamp	[optional]

Return type

MailSlurpModelsPageContactProjection

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getGroups

MailSlurpModelsGroupProjection[] getGroups()

Get all groups

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

**MailSlurpModelsGroupProjection[]**

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

removeContactsFromGroup

MailSlurpModelsGroupContactsDto removeContactsFromGroup($group_id, $update_group_contacts)

Remove contacts from a group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiGroupControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$group_id = 'group_id_example'; // string | 
$update_group_contacts = new MailSlurpModelsUpdateGroupContacts(); // MailSlurpModelsUpdateGroupContacts | 

try {
    $result = $apiInstance->removeContactsFromGroup($group_id, $update_group_contacts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupControllerApi->removeContactsFromGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group_id	string
update_group_contacts	MailSlurpModelsUpdateGroupContacts

Return type

MailSlurpModelsGroupContactsDto

Authorization

API_KEY

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

What is MailSlurp?

MailSlurp is a free email API service for developers, QA testers and marketing campaigns. You can create disposable test mail accounts using the random email address generator via HTTP, GraphQL, dashboard or official code clients in Javascript, Csharp, Golang, Python, Java, Ruby, PHP and more!

What can MailSlurp do?

MailSlurp offers permanent email addresses using custom domains or random fake emails ending in @mailslurp.com. You can generate as many inboxes as you need for end-to-end email testing, email marketing campaigns and application development.

Getting started

Create a free MailSlurp account to get started using alternatives to MailTrap, Mailinator, Mailosaur and more. MailSlurp is the most advanced email platform with many features including: HTTP webhook push, graphql email APIs, sdks with long-polling (wait for emails), inbox forwarding, complex routing rulesets, and spam filters. See the pricing page for a full overview.

addContactsToGroup

Example

Parameters

Return type

Authorization

HTTP request headers

createGroup

Example

Parameters

Return type

Authorization

HTTP request headers

deleteGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getAllGroups

Example

Parameters

Return type

Authorization

HTTP request headers

getGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getGroupWithContacts

Example

Parameters

Return type

Authorization

HTTP request headers

getGroupWithContactsPaginated

Example

Parameters

Return type

Authorization

HTTP request headers

getGroups

Example

Parameters

Return type

Authorization

HTTP request headers

removeContactsFromGroup

Example

Parameters

Return type

Authorization

HTTP request headers

Email APIs for developer and QA teams

What is MailSlurp?

What can MailSlurp do?

Getting started