Skip to content

MailSlurp\BulkActionsControllerApi

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

Method HTTP request Description
bulkCreateInboxes POST /bulk/inboxes Bulk create Inboxes (email addresses)
bulkDeleteInboxes DELETE /bulk/inboxes Bulk Delete Inboxes
bulkSendEmails POST /bulk/send Bulk Send Emails

bulkCreateInboxes

MailSlurpModelsInboxDto[] bulkCreateInboxes($count)

Bulk create Inboxes (email addresses)

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 MailSlurpApiBulkActionsControllerApi(
    // 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
);
$count = 56; // int | Number of inboxes to be created in bulk

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

Parameters

Name Type Description Notes
count int Number of inboxes to be created in bulk

Return type

MailSlurpModelsInboxDto[]

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

bulkDeleteInboxes

bulkDeleteInboxes($request_body)

Bulk Delete Inboxes

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 MailSlurpApiBulkActionsControllerApi(
    // 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
);
$request_body = array('request_body_example'); // string[] | 

try {
    $apiInstance->bulkDeleteInboxes($request_body);
} catch (Exception $e) {
    echo 'Exception when calling BulkActionsControllerApi->bulkDeleteInboxes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
request_body string[]

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

bulkSendEmails

bulkSendEmails($bulk_send_email_options)

Bulk Send Emails

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 MailSlurpApiBulkActionsControllerApi(
    // 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
);
$bulk_send_email_options = new MailSlurpModelsBulkSendEmailOptions(); // MailSlurpModelsBulkSendEmailOptions | 

try {
    $apiInstance->bulkSendEmails($bulk_send_email_options);
} catch (Exception $e) {
    echo 'Exception when calling BulkActionsControllerApi->bulkSendEmails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
bulk_send_email_options MailSlurpModelsBulkSendEmailOptions

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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