eve-esi-client-ts 1.0.1

package/docs/MailApi.md

@@ -0,0 +1,641 @@
+# MailApi
+
+All URIs are relative to *https://esi.evetech.net/latest*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteCharactersCharacterIdMailLabelsLabelId**](#deletecharacterscharacteridmaillabelslabelid) | **DELETE** /characters/{character_id}/mail/labels/{label_id}/ | Delete a mail label|
+|[**deleteCharactersCharacterIdMailMailId**](#deletecharacterscharacteridmailmailid) | **DELETE** /characters/{character_id}/mail/{mail_id}/ | Delete a mail|
+|[**getCharactersCharacterIdMail**](#getcharacterscharacteridmail) | **GET** /characters/{character_id}/mail/ | Return mail headers|
+|[**getCharactersCharacterIdMailLabels**](#getcharacterscharacteridmaillabels) | **GET** /characters/{character_id}/mail/labels/ | Get mail labels and unread counts|
+|[**getCharactersCharacterIdMailLists**](#getcharacterscharacteridmaillists) | **GET** /characters/{character_id}/mail/lists/ | Return mailing list subscriptions|
+|[**getCharactersCharacterIdMailMailId**](#getcharacterscharacteridmailmailid) | **GET** /characters/{character_id}/mail/{mail_id}/ | Return a mail|
+|[**postCharactersCharacterIdMail**](#postcharacterscharacteridmail) | **POST** /characters/{character_id}/mail/ | Send a new mail|
+|[**postCharactersCharacterIdMailLabels**](#postcharacterscharacteridmaillabels) | **POST** /characters/{character_id}/mail/labels/ | Create a mail label|
+|[**putCharactersCharacterIdMailMailId**](#putcharacterscharacteridmailmailid) | **PUT** /characters/{character_id}/mail/{mail_id}/ | Update metadata about a mail|
+
+# **deleteCharactersCharacterIdMailLabelsLabelId**
+> deleteCharactersCharacterIdMailLabelsLabelId()
+
+Delete a mail label  --- Alternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/`  Alternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/`  Alternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/` 
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let labelId: number; //An EVE label id (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteCharactersCharacterIdMailLabelsLabelId(
+    characterId,
+    labelId,
+    datasource,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **labelId** | [**number**] | An EVE label id | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Label deleted |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**422** | Default labels cannot be deleted |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteCharactersCharacterIdMailMailId**
+> deleteCharactersCharacterIdMailMailId()
+
+Delete a mail  --- Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`  Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`  Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` 
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let mailId: number; //An EVE mail ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteCharactersCharacterIdMailMailId(
+    characterId,
+    mailId,
+    datasource,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **mailId** | [**number**] | An EVE mail ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Mail deleted |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCharactersCharacterIdMail**
+> Array<GetCharactersCharacterIdMail200Ok> getCharactersCharacterIdMail()
+
+Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards  --- Alternate route: `/dev/characters/{character_id}/mail/`  Alternate route: `/legacy/characters/{character_id}/mail/`  Alternate route: `/v1/characters/{character_id}/mail/`  --- This route is cached for up to 30 seconds
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let labels: Set<number>; //Fetch only mails that match one or more of the given labels (optional) (default to undefined)
+let lastMailId: number; //List only mail with an ID lower than the given ID, if present (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdMail(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    labels,
+    lastMailId,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **labels** | **Set&lt;number&gt;** | Fetch only mails that match one or more of the given labels | (optional) defaults to undefined|
+| **lastMailId** | [**number**] | List only mail with an ID lower than the given ID, if present | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetCharactersCharacterIdMail200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The requested mail |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCharactersCharacterIdMailLabels**
+> GetCharactersCharacterIdMailLabelsOk getCharactersCharacterIdMailLabels()
+
+Return a list of the users mail labels, unread counts for each label and a total unread count.  --- Alternate route: `/dev/characters/{character_id}/mail/labels/`  Alternate route: `/v3/characters/{character_id}/mail/labels/`  --- This route is cached for up to 30 seconds
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdMailLabels(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetCharactersCharacterIdMailLabelsOk**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of mail labels and unread counts |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCharactersCharacterIdMailLists**
+> Array<GetCharactersCharacterIdMailLists200Ok> getCharactersCharacterIdMailLists()
+
+Return all mailing lists that the character is subscribed to  --- Alternate route: `/dev/characters/{character_id}/mail/lists/`  Alternate route: `/legacy/characters/{character_id}/mail/lists/`  Alternate route: `/v1/characters/{character_id}/mail/lists/`  --- This route is cached for up to 120 seconds
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdMailLists(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<GetCharactersCharacterIdMailLists200Ok>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Mailing lists |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getCharactersCharacterIdMailMailId**
+> GetCharactersCharacterIdMailMailIdOk getCharactersCharacterIdMailMailId()
+
+Return the contents of an EVE mail  --- Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`  Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`  Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/`  --- This route is cached for up to 30 seconds
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let mailId: number; //An EVE mail ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdMailMailId(
+    characterId,
+    mailId,
+    datasource,
+    ifNoneMatch,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **mailId** | [**number**] | An EVE mail ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetCharactersCharacterIdMailMailIdOk**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Contents of a mail |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**404** | Mail not found |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postCharactersCharacterIdMail**
+> number postCharactersCharacterIdMail(mail)
+
+Create and send a new mail  --- Alternate route: `/dev/characters/{character_id}/mail/`  Alternate route: `/legacy/characters/{character_id}/mail/`  Alternate route: `/v1/characters/{character_id}/mail/` 
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration,
+    PostCharactersCharacterIdMailMail
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let mail: PostCharactersCharacterIdMailMail; //The mail to send
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postCharactersCharacterIdMail(
+    characterId,
+    mail,
+    datasource,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mail** | **PostCharactersCharacterIdMailMail**| The mail to send | |
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**number**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Mail created |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+|**520** | Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postCharactersCharacterIdMailLabels**
+> number postCharactersCharacterIdMailLabels(label)
+
+Create a mail label  --- Alternate route: `/dev/characters/{character_id}/mail/labels/`  Alternate route: `/legacy/characters/{character_id}/mail/labels/`  Alternate route: `/v2/characters/{character_id}/mail/labels/` 
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration,
+    PostCharactersCharacterIdMailLabelsLabel
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let label: PostCharactersCharacterIdMailLabelsLabel; //Label to create
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postCharactersCharacterIdMailLabels(
+    characterId,
+    label,
+    datasource,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **label** | **PostCharactersCharacterIdMailLabelsLabel**| Label to create | |
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**number**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Label created |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **putCharactersCharacterIdMailMailId**
+> putCharactersCharacterIdMailMailId(contents)
+
+Update metadata about a mail  --- Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/`  Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/`  Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` 
+
+### Example
+
+```typescript
+import {
+    MailApi,
+    Configuration,
+    PutCharactersCharacterIdMailMailIdContents
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MailApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let mailId: number; //An EVE mail ID (default to undefined)
+let contents: PutCharactersCharacterIdMailMailIdContents; //Data used to update the mail
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.putCharactersCharacterIdMailMailId(
+    characterId,
+    mailId,
+    contents,
+    datasource,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **contents** | **PutCharactersCharacterIdMailMailIdContents**| Data used to update the mail | |
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **mailId** | [**number**] | An EVE mail ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Mail updated |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+