IONOS\MailConfigurationAPI\Client\MailConfigurationAPIApi

All URIs are relative to https://API_HOST/nextcloud, except if the operation defines another base path.

Method	HTTP request	Description
createMailbox()	POST /addons/{brand}/{extRef}/mail	Creates a mailbox on IONOS plattform that is used for nextcloud user
deleteAppPassword()	DELETE /addons/{brand}/{extRef}/mail/{nextcloudUserId}/apppwd/{appname}	Deletes the app credentials for the given appname
deleteMailbox()	DELETE /addons/{brand}/{extRef}/mail/{nextcloudUserId}	Deletes mailbox for given nextcloud user
getAllFunctionalAccounts()	GET /addons/{brand}/{extRef}/mail	Returns all functional mailboxes for the given brand and extRef
getFunctionalAccount()	GET /addons/{brand}/{extRef}/mail/{nextcloudUserId}	Returns all functional mailboxes for the given brand and extRef and nextcloudUserId
patchMailbox()	PATCH /addons/{brand}/{extRef}/mail/{nextcloudUserId}	update maildata
setAppPassword()	POST /addons/{brand}/{extRef}/mail/{nextcloudUserId}/apppwd/{appname}	A new password for provided appname will be set and returned

`createMailbox()`

createMailbox($brand, $extRef, $mailCreateData): \IONOS\MailConfigurationAPI\Client\Model\MailAccountCreatedResponse

Creates a mailbox on IONOS plattform that is used for nextcloud user

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string
$mailCreateData = new \IONOS\MailConfigurationAPI\Client\Model\MailCreateData(); // \IONOS\MailConfigurationAPI\Client\Model\MailCreateData

try {
    $result = $apiInstance->createMailbox($brand, $extRef, $mailCreateData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->createMailbox: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
brand	string
extRef	string
mailCreateData	\IONOS\MailConfigurationAPI\Client\Model\MailCreateData

Return type

\IONOS\MailConfigurationAPI\Client\Model\MailAccountCreatedResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`deleteAppPassword()`

deleteAppPassword($brand, $extRef, $nextcloudUserId, $appname)

Deletes the app credentials for the given appname

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string
$nextcloudUserId = 'nextcloudUserId_example'; // string
$appname = 'appname_example'; // string

try {
    $apiInstance->deleteAppPassword($brand, $extRef, $nextcloudUserId, $appname);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->deleteAppPassword: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
brand	string
extRef	string
nextcloudUserId	string
appname	string

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`deleteMailbox()`

deleteMailbox($brand, $extRef, $nextcloudUserId)

Deletes mailbox for given nextcloud user

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string
$nextcloudUserId = 'nextcloudUserId_example'; // string

try {
    $apiInstance->deleteMailbox($brand, $extRef, $nextcloudUserId);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->deleteMailbox: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
brand	string
extRef	string
nextcloudUserId	string

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getAllFunctionalAccounts()`

getAllFunctionalAccounts($brand, $extRef): \IONOS\MailConfigurationAPI\Client\Model\MailAccountResponse[]

Returns all functional mailboxes for the given brand and extRef

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string

try {
    $result = $apiInstance->getAllFunctionalAccounts($brand, $extRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->getAllFunctionalAccounts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
brand	string
extRef	string

Return type

\IONOS\MailConfigurationAPI\Client\Model\MailAccountResponse[]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getFunctionalAccount()`

getFunctionalAccount($brand, $extRef, $nextcloudUserId): \IONOS\MailConfigurationAPI\Client\Model\MailAccountResponse

Returns all functional mailboxes for the given brand and extRef and nextcloudUserId

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string
$nextcloudUserId = 'nextcloudUserId_example'; // string

try {
    $result = $apiInstance->getFunctionalAccount($brand, $extRef, $nextcloudUserId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->getFunctionalAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
brand	string
extRef	string
nextcloudUserId	string

Return type

\IONOS\MailConfigurationAPI\Client\Model\MailAccountResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`patchMailbox()`

patchMailbox($brand, $extRef, $nextcloudUserId, $patchMailRequest)

update maildata

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string
$nextcloudUserId = 'nextcloudUserId_example'; // string
$patchMailRequest = new \IONOS\MailConfigurationAPI\Client\Model\PatchMailRequest(); // \IONOS\MailConfigurationAPI\Client\Model\PatchMailRequest

try {
    $apiInstance->patchMailbox($brand, $extRef, $nextcloudUserId, $patchMailRequest);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->patchMailbox: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
brand	string
extRef	string
nextcloudUserId	string
patchMailRequest	\IONOS\MailConfigurationAPI\Client\Model\PatchMailRequest

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`setAppPassword()`

setAppPassword($brand, $extRef, $nextcloudUserId, $appname): string

A new password for provided appname will be set and returned

Example

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


// Configure HTTP basic authorization: basicAuth
$config = IONOS\MailConfigurationAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');



$apiInstance = new IONOS\MailConfigurationAPI\Client\Api\MailConfigurationAPIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$brand = 'brand_example'; // string
$extRef = 'extRef_example'; // string
$nextcloudUserId = 'nextcloudUserId_example'; // string
$appname = 'appname_example'; // string | app passwords are created for a specific app label  * for nextcloud we'll support two different app passwords that can be created for the mail account:  * - 'nextcloud_workspace' for the nextcloud workspace app  * - 'nextcloud_workspace_user' for additonal user credentials that can be used to connect to the mail account from any other mail client

try {
    $result = $apiInstance->setAppPassword($brand, $extRef, $nextcloudUserId, $appname);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailConfigurationAPIApi->setAppPassword: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
brand	string
extRef	string
nextcloudUserId	string
appname	string	app passwords are created for a specific app label * for nextcloud we'll support two different app passwords that can be created for the mail account: * - 'nextcloud_workspace' for the nextcloud workspace app * - 'nextcloud_workspace_user' for additonal user credentials that can be used to connect to the mail account from any other mail client

Return type

string

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json

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

Uh oh!

FilesExpand file tree

MailConfigurationAPIApi.md

Latest commit

History

MailConfigurationAPIApi.md

File metadata and controls

IONOS\MailConfigurationAPI\Client\MailConfigurationAPIApi

createMailbox()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAppPassword()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteMailbox()

Example

Parameters

Return type

Authorization

HTTP request headers

getAllFunctionalAccounts()

Example

Parameters

Return type

Authorization

HTTP request headers

getFunctionalAccount()

Example

Parameters

Return type

Authorization

HTTP request headers

patchMailbox()

Example

Parameters

Return type

Authorization

HTTP request headers

setAppPassword()

Example

Parameters

Return type

Authorization

HTTP request headers

`createMailbox()`

`deleteAppPassword()`

`deleteMailbox()`

`getAllFunctionalAccounts()`

`getFunctionalAccount()`

`patchMailbox()`

`setAppPassword()`