|
| 1 | +# Hostinger\MailAliasesApi |
| 2 | + |
| 3 | +All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path. |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------------- | ------------- | ------------- | |
| 7 | +| [**createAliasV1()**](MailAliasesApi.md#createAliasV1) | **POST** /api/mail/v1/mailboxes/{mailboxId}/aliases | Create alias | |
| 8 | +| [**deleteAliasV1()**](MailAliasesApi.md#deleteAliasV1) | **DELETE** /api/mail/v1/aliases/{aliasId} | Delete alias | |
| 9 | +| [**listAliasesV1()**](MailAliasesApi.md#listAliasesV1) | **GET** /api/mail/v1/orders/{orderId}/aliases | List aliases | |
| 10 | + |
| 11 | + |
| 12 | +## `createAliasV1()` |
| 13 | + |
| 14 | +```php |
| 15 | +createAliasV1($mailboxId, $mailV1SchemaCreateAliasRequestSchema): \Hostinger\Model\MailV1AliasesAliasResource |
| 16 | +``` |
| 17 | + |
| 18 | +Create alias |
| 19 | + |
| 20 | +Create an alias for the given mailbox. The alias address is formed from the given local part and the domain of the mailbox. Messages sent to the alias are delivered to the mailbox. |
| 21 | + |
| 22 | +### Example |
| 23 | + |
| 24 | +```php |
| 25 | +<?php |
| 26 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 27 | + |
| 28 | + |
| 29 | +// Configure Bearer authorization: apiToken |
| 30 | +$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 31 | + |
| 32 | + |
| 33 | +$apiInstance = new Hostinger\Api\MailAliasesApi(config: $config); |
| 34 | +$mailboxId = AC1a2b3c4d5e6f7g; // string | Mailbox resource ID |
| 35 | +$mailV1SchemaCreateAliasRequestSchema = new \Hostinger\Model\MailV1SchemaCreateAliasRequestSchema(); // \Hostinger\Model\MailV1SchemaCreateAliasRequestSchema |
| 36 | + |
| 37 | +try { |
| 38 | + $result = $apiInstance->createAliasV1($mailboxId, $mailV1SchemaCreateAliasRequestSchema); |
| 39 | + print_r($result); |
| 40 | +} catch (Exception $e) { |
| 41 | + echo 'Exception when calling MailAliasesApi->createAliasV1: ', $e->getMessage(), PHP_EOL; |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +### Parameters |
| 46 | + |
| 47 | +| Name | Type | Description | Notes | |
| 48 | +| ------------- | ------------- | ------------- | ------------- | |
| 49 | +| **mailboxId** | **string**| Mailbox resource ID | | |
| 50 | +| **mailV1SchemaCreateAliasRequestSchema** | [**\Hostinger\Model\MailV1SchemaCreateAliasRequestSchema**](../Model/MailV1SchemaCreateAliasRequestSchema.md)| | | |
| 51 | + |
| 52 | +### Return type |
| 53 | + |
| 54 | +[**\Hostinger\Model\MailV1AliasesAliasResource**](../Model/MailV1AliasesAliasResource.md) |
| 55 | + |
| 56 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 57 | +[[Back to Model list]](../../README.md#models) |
| 58 | +[[Back to README]](../../README.md) |
| 59 | + |
| 60 | +## `deleteAliasV1()` |
| 61 | + |
| 62 | +```php |
| 63 | +deleteAliasV1($aliasId): \Hostinger\Model\CommonSuccessEmptyResource |
| 64 | +``` |
| 65 | + |
| 66 | +Delete alias |
| 67 | + |
| 68 | +Delete an alias. Messages sent to the alias address are no longer delivered to the mailbox. |
| 69 | + |
| 70 | +### Example |
| 71 | + |
| 72 | +```php |
| 73 | +<?php |
| 74 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 75 | + |
| 76 | + |
| 77 | +// Configure Bearer authorization: apiToken |
| 78 | +$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 79 | + |
| 80 | + |
| 81 | +$apiInstance = new Hostinger\Api\MailAliasesApi(config: $config); |
| 82 | +$aliasId = AA1a2b3c4d5e6f7g; // string | Alias resource ID |
| 83 | + |
| 84 | +try { |
| 85 | + $result = $apiInstance->deleteAliasV1($aliasId); |
| 86 | + print_r($result); |
| 87 | +} catch (Exception $e) { |
| 88 | + echo 'Exception when calling MailAliasesApi->deleteAliasV1: ', $e->getMessage(), PHP_EOL; |
| 89 | +} |
| 90 | +``` |
| 91 | + |
| 92 | +### Parameters |
| 93 | + |
| 94 | +| Name | Type | Description | Notes | |
| 95 | +| ------------- | ------------- | ------------- | ------------- | |
| 96 | +| **aliasId** | **string**| Alias resource ID | | |
| 97 | + |
| 98 | +### Return type |
| 99 | + |
| 100 | +[**\Hostinger\Model\CommonSuccessEmptyResource**](../Model/CommonSuccessEmptyResource.md) |
| 101 | + |
| 102 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 103 | +[[Back to Model list]](../../README.md#models) |
| 104 | +[[Back to README]](../../README.md) |
| 105 | + |
| 106 | +## `listAliasesV1()` |
| 107 | + |
| 108 | +```php |
| 109 | +listAliasesV1($orderId, $page, $perPage): \Hostinger\Model\MailListAliasesV1200Response |
| 110 | +``` |
| 111 | + |
| 112 | +List aliases |
| 113 | + |
| 114 | +Retrieve a paginated list of aliases across all mailboxes of a mail order. |
| 115 | + |
| 116 | +### Example |
| 117 | + |
| 118 | +```php |
| 119 | +<?php |
| 120 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 121 | + |
| 122 | + |
| 123 | +// Configure Bearer authorization: apiToken |
| 124 | +$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 125 | + |
| 126 | + |
| 127 | +$apiInstance = new Hostinger\Api\MailAliasesApi(config: $config); |
| 128 | +$orderId = OR1a2b3c4d5e6f7g; // string | Order resource ID |
| 129 | +$page = 1; // int | Page number |
| 130 | +$perPage = 25; // int | Number of items per page |
| 131 | + |
| 132 | +try { |
| 133 | + $result = $apiInstance->listAliasesV1($orderId, $page, $perPage); |
| 134 | + print_r($result); |
| 135 | +} catch (Exception $e) { |
| 136 | + echo 'Exception when calling MailAliasesApi->listAliasesV1: ', $e->getMessage(), PHP_EOL; |
| 137 | +} |
| 138 | +``` |
| 139 | + |
| 140 | +### Parameters |
| 141 | + |
| 142 | +| Name | Type | Description | Notes | |
| 143 | +| ------------- | ------------- | ------------- | ------------- | |
| 144 | +| **orderId** | **string**| Order resource ID | | |
| 145 | +| **page** | **int**| Page number | [optional] | |
| 146 | +| **perPage** | **int**| Number of items per page | [optional] [default to 25] | |
| 147 | + |
| 148 | +### Return type |
| 149 | + |
| 150 | +[**\Hostinger\Model\MailListAliasesV1200Response**](../Model/MailListAliasesV1200Response.md) |
| 151 | + |
| 152 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 153 | +[[Back to Model list]](../../README.md#models) |
| 154 | +[[Back to README]](../../README.md) |
![hostingerbot[bot]](https://avatars.githubusercontent.com/in/1033565?v=4&size=40){kind=avatar}
0 commit comments