EveSwaggerInterface.MailApi

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

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

deleteCharactersCharacterIdMailLabelsLabelId

deleteCharactersCharacterIdMailLabelsLabelId(characterIdlabelId, opts)

Delete a mail label

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var labelId = 56; // Number | An EVE label id

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteCharactersCharacterIdMailLabelsLabelId(characterIdlabelId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
labelId	Number	An EVE label id
datasource	String	The server name you would like data from	[optional] [default to tranquility]
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(characterIdmailId, opts)

Delete a mail

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var mailId = 56; // Number | An EVE mail ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteCharactersCharacterIdMailMailId(characterIdmailId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
mailId	Number	An EVE mail ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
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

[GetCharactersCharacterIdMail200Ok] getCharactersCharacterIdMail(characterId, opts)

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 --- 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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'labels': [3.4], // [Number] | Fetch only mails that match one or more of the given labels
  'lastMailId': 56, // Number | List only mail with an ID lower than the given ID, if present
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdMail(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
ifNoneMatch	String	ETag from a previous request. A 304 will be returned if this matches the current ETag	[optional]
labels	[Number]	Fetch only mails that match one or more of the given labels	[optional]
lastMailId	Number	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

[GetCharactersCharacterIdMail200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdMailLabels

GetCharactersCharacterIdMailLabelsOk getCharactersCharacterIdMailLabels(characterId, opts)

Get mail labels and unread counts

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdMailLabels(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
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

[GetCharactersCharacterIdMailLists200Ok] getCharactersCharacterIdMailLists(characterId, opts)

Return mailing list subscriptions

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdMailLists(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
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

[GetCharactersCharacterIdMailLists200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdMailMailId

GetCharactersCharacterIdMailMailIdOk getCharactersCharacterIdMailMailId(characterIdmailId, opts)

Return a mail

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var mailId = 56; // Number | An EVE mail ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdMailMailId(characterIdmailId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
mailId	Number	An EVE mail ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
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

'Number' postCharactersCharacterIdMail(characterIdmail, opts)

Send a new 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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var mail = new EveSwaggerInterface.PostCharactersCharacterIdMailMail(); // PostCharactersCharacterIdMailMail | The mail to send

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postCharactersCharacterIdMail(characterIdmail, opts, callback);

Parameters

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

Return type

'Number'

Authorization

evesso

HTTP request headers

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

postCharactersCharacterIdMailLabels

'Number' postCharactersCharacterIdMailLabels(characterIdlabel, opts)

Create a mail 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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var label = new EveSwaggerInterface.PostCharactersCharacterIdMailLabelsLabel(); // PostCharactersCharacterIdMailLabelsLabel | Label to create

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postCharactersCharacterIdMailLabels(characterIdlabel, opts, callback);

Parameters

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

Return type

'Number'

Authorization

evesso

HTTP request headers

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

putCharactersCharacterIdMailMailId

putCharactersCharacterIdMailMailId(characterIdcontents, mailId, opts)

Update metadata about a mail

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

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.MailApi();

var characterId = 56; // Number | An EVE character ID

var contents = new EveSwaggerInterface.PutCharactersCharacterIdMailMailIdContents(); // PutCharactersCharacterIdMailMailIdContents | Data used to update the mail

var mailId = 56; // Number | An EVE mail ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.putCharactersCharacterIdMailMailId(characterIdcontents, mailId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
contents	PutCharactersCharacterIdMailMailIdContents	Data used to update the mail
mailId	Number	An EVE mail ID
datasource	String	The server name you would like data from	[optional] [default to tranquility]
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

FilesExpand file tree

MailApi.md

Latest commit

History

MailApi.md

File metadata and controls

EveSwaggerInterface.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