MailApi

All URIs are relative to https://esi.evetech.net

Method	HTTP request	Description
deleteCharactersCharacterIdMailLabelsLabelId	DELETE /v1/characters/{character_id}/mail/labels/{label_id}/	Delete a mail label
deleteCharactersCharacterIdMailMailId	DELETE /v1/characters/{character_id}/mail/{mail_id}/	Delete a mail
getCharactersCharacterIdMail	GET /v1/characters/{character_id}/mail/	Return mail headers
getCharactersCharacterIdMailLabels	GET /v3/characters/{character_id}/mail/labels/	Get mail labels and unread counts
getCharactersCharacterIdMailLists	GET /v1/characters/{character_id}/mail/lists/	Return mailing list subscriptions
getCharactersCharacterIdMailMailId	GET /v1/characters/{character_id}/mail/{mail_id}/	Return a mail
postCharactersCharacterIdMail	POST /v1/characters/{character_id}/mail/	Send a new mail
postCharactersCharacterIdMailLabels	POST /v2/characters/{character_id}/mail/labels/	Create a mail label
putCharactersCharacterIdMailMailId	PUT /v1/characters/{character_id}/mail/{mail_id}/	Update metadata about a mail

deleteCharactersCharacterIdMailLabelsLabelId

deleteCharactersCharacterIdMailLabelsLabelId(characterId, labelId, datasource, token)

Delete a mail label

Delete a mail label ---

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
Integer labelId = 56; // Integer | An EVE label id
String datasource = "tranquility"; // String | The server name you would like data from
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    apiInstance.deleteCharactersCharacterIdMailLabelsLabelId(characterId, labelId, datasource, token);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#deleteCharactersCharacterIdMailLabelsLabelId");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
labelId	Integer	An EVE label id
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
token	String	Access token to use if unable to set a header	[optional]

Return type

null (empty response body)

Authorization

evesso

HTTP request headers

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

deleteCharactersCharacterIdMailMailId

deleteCharactersCharacterIdMailMailId(characterId, mailId, datasource, token)

Delete a mail

Delete a mail ---

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
Integer mailId = 56; // Integer | An EVE mail ID
String datasource = "tranquility"; // String | The server name you would like data from
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    apiInstance.deleteCharactersCharacterIdMailMailId(characterId, mailId, datasource, token);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#deleteCharactersCharacterIdMailMailId");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
mailId	Integer	An EVE mail ID
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
token	String	Access token to use if unable to set a header	[optional]

Return type

null (empty response body)

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdMail

List<GetCharactersCharacterIdMail200Ok> getCharactersCharacterIdMail(characterId, datasource, ifNoneMatch, labels, lastMailId, token)

Return mail headers

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 --- This route is cached for up to 30 seconds

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
List<Integer> labels = Arrays.asList(56); // List<Integer> | Fetch only mails that match one or more of the given labels
Integer lastMailId = 56; // Integer | List only mail with an ID lower than the given ID, if present
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    List<GetCharactersCharacterIdMail200Ok> result = apiInstance.getCharactersCharacterIdMail(characterId, datasource, ifNoneMatch, labels, lastMailId, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#getCharactersCharacterIdMail");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
labels	List<Integer>	Fetch only mails that match one or more of the given labels	[optional]
lastMailId	Integer	List only mail with an ID lower than the given ID, if present	[optional]
token	String	Access token to use if unable to set a header	[optional]

Return type

List<GetCharactersCharacterIdMail200Ok>

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdMailLabels

GetCharactersCharacterIdMailLabelsOk getCharactersCharacterIdMailLabels(characterId, datasource, ifNoneMatch, token)

Get mail labels and unread counts

Return a list of the users mail labels, unread counts for each label and a total unread count. --- This route is cached for up to 30 seconds

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    GetCharactersCharacterIdMailLabelsOk result = apiInstance.getCharactersCharacterIdMailLabels(characterId, datasource, ifNoneMatch, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#getCharactersCharacterIdMailLabels");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
token	String	Access token to use if unable to set a header	[optional]

Return type

GetCharactersCharacterIdMailLabelsOk

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdMailLists

List<GetCharactersCharacterIdMailLists200Ok> getCharactersCharacterIdMailLists(characterId, datasource, ifNoneMatch, token)

Return mailing list subscriptions

Return all mailing lists that the character is subscribed to --- This route is cached for up to 120 seconds

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    List<GetCharactersCharacterIdMailLists200Ok> result = apiInstance.getCharactersCharacterIdMailLists(characterId, datasource, ifNoneMatch, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#getCharactersCharacterIdMailLists");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
token	String	Access token to use if unable to set a header	[optional]

Return type

List<GetCharactersCharacterIdMailLists200Ok>

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdMailMailId

GetCharactersCharacterIdMailMailIdOk getCharactersCharacterIdMailMailId(characterId, mailId, datasource, ifNoneMatch, token)

Return a mail

Return the contents of an EVE mail --- This route is cached for up to 30 seconds

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
Integer mailId = 56; // Integer | An EVE mail ID
String datasource = "tranquility"; // String | The server name you would like data from
String ifNoneMatch = "ifNoneMatch_example"; // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    GetCharactersCharacterIdMailMailIdOk result = apiInstance.getCharactersCharacterIdMailMailId(characterId, mailId, datasource, ifNoneMatch, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#getCharactersCharacterIdMailMailId");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
mailId	Integer	An EVE mail ID
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
token	String	Access token to use if unable to set a header	[optional]

Return type

GetCharactersCharacterIdMailMailIdOk

Authorization

evesso

HTTP request headers

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

postCharactersCharacterIdMail

Integer postCharactersCharacterIdMail(characterId, mail, datasource, token)

Send a new mail

Create and send a new mail ---

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
PostCharactersCharacterIdMailMail mail = new PostCharactersCharacterIdMailMail(); // PostCharactersCharacterIdMailMail | The mail to send
String datasource = "tranquility"; // String | The server name you would like data from
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    Integer result = apiInstance.postCharactersCharacterIdMail(characterId, mail, datasource, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#postCharactersCharacterIdMail");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
mail	PostCharactersCharacterIdMailMail	The mail to send
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
token	String	Access token to use if unable to set a header	[optional]

Return type

Integer

Authorization

evesso

HTTP request headers

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

postCharactersCharacterIdMailLabels

Integer postCharactersCharacterIdMailLabels(characterId, label, datasource, token)

Create a mail label

Create a mail label ---

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
PostCharactersCharacterIdMailLabelsLabel label = new PostCharactersCharacterIdMailLabelsLabel(); // PostCharactersCharacterIdMailLabelsLabel | Label to create
String datasource = "tranquility"; // String | The server name you would like data from
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    Integer result = apiInstance.postCharactersCharacterIdMailLabels(characterId, label, datasource, token);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#postCharactersCharacterIdMailLabels");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
label	PostCharactersCharacterIdMailLabelsLabel	Label to create
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
token	String	Access token to use if unable to set a header	[optional]

Return type

Integer

Authorization

evesso

HTTP request headers

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

putCharactersCharacterIdMailMailId

putCharactersCharacterIdMailMailId(characterId, contents, mailId, datasource, token)

Update metadata about a mail

Update metadata about a mail ---

Example

// Import classes:
//import enterprises.orbital.eve.esi.client.invoker.ApiClient;
//import enterprises.orbital.eve.esi.client.invoker.ApiException;
//import enterprises.orbital.eve.esi.client.invoker.Configuration;
//import enterprises.orbital.eve.esi.client.invoker.auth.*;
//import enterprises.orbital.eve.esi.client.api.MailApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: evesso
OAuth evesso = (OAuth) defaultClient.getAuthentication("evesso");
evesso.setAccessToken("YOUR ACCESS TOKEN");

MailApi apiInstance = new MailApi();
Integer characterId = 56; // Integer | An EVE character ID
PutCharactersCharacterIdMailMailIdContents contents = new PutCharactersCharacterIdMailMailIdContents(); // PutCharactersCharacterIdMailMailIdContents | Data used to update the mail
Integer mailId = 56; // Integer | An EVE mail ID
String datasource = "tranquility"; // String | The server name you would like data from
String token = "token_example"; // String | Access token to use if unable to set a header
try {
    apiInstance.putCharactersCharacterIdMailMailId(characterId, contents, mailId, datasource, token);
} catch (ApiException e) {
    System.err.println("Exception when calling MailApi#putCharactersCharacterIdMailMailId");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
characterId	Integer	An EVE character ID
contents	PutCharactersCharacterIdMailMailIdContents	Data used to update the mail
mailId	Integer	An EVE mail ID
datasource	String	The server name you would like data from	[optional] [default to tranquility] [enum: tranquility, singularity]
token	String	Access token to use if unable to set a header	[optional]

Return type

null (empty response body)

Authorization

evesso

HTTP request headers

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

Files

MailApi.md

Latest commit

History

MailApi.md

File metadata and controls

MailApi

deleteCharactersCharacterIdMailLabelsLabelId

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCharactersCharacterIdMailMailId

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMail

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMailLabels

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMailLists

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMailMailId

Example

Parameters

Return type

Authorization

HTTP request headers

postCharactersCharacterIdMail

Example

Parameters

Return type

Authorization

HTTP request headers

postCharactersCharacterIdMailLabels

Example

Parameters

Return type

Authorization

HTTP request headers

putCharactersCharacterIdMailMailId

Example

Parameters

Return type

Authorization

HTTP request headers