net.troja.eve.esi.api

Class MailApi

java.lang.Object

net.troja.eve.esi.api.MailApi

public class MailApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MailApi()
MailApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCharactersCharacterIdMailLabelsLabelId(Integer characterId, Integer labelId, String datasource, String token) Delete a mail label Delete a mail label --- SSO Scope: esi-mail.organize_mail.v1
void	deleteCharactersCharacterIdMailMailId(Integer characterId, Integer mailId, String datasource, String token) Delete a mail Delete a mail --- SSO Scope: esi-mail.organize_mail.v1
ApiClient	getApiClient()
List<MailHeadersResponse>	getCharactersCharacterIdMail(Integer characterId, String datasource, String ifNoneMatch, List<Integer> labels, Integer lastMailId, String token) Return mail headers Return the 50 most recent mail headers belonging to the character that match the query criteria.
MailLabelsResponse	getCharactersCharacterIdMailLabels(Integer characterId, String datasource, String ifNoneMatch, String 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 SSO Scope: esi-mail.read_mail.v1
List<CharacterMailinglistsResponse>	getCharactersCharacterIdMailLists(Integer characterId, String datasource, String ifNoneMatch, String token) Return mailing list subscriptions Return all mailing lists that the character is subscribed to --- This route is cached for up to 120 seconds SSO Scope: esi-mail.read_mail.v1
MailResponse	getCharactersCharacterIdMailMailId(Integer characterId, Integer mailId, String datasource, String ifNoneMatch, String token) Return a mail Return the contents of an EVE mail --- This route is cached for up to 30 seconds SSO Scope: esi-mail.read_mail.v1
Integer	postCharactersCharacterIdMail(Integer characterId, Mail mail, String datasource, String token) Send a new mail Create and send a new mail --- SSO Scope: esi-mail.send_mail.v1
Integer	postCharactersCharacterIdMailLabels(Integer characterId, MailLabelSimple label, String datasource, String token) Create a mail label Create a mail label --- SSO Scope: esi-mail.organize_mail.v1
void	putCharactersCharacterIdMailMailId(Integer characterId, MailMetaData contents, Integer mailId, String datasource, String token) Update metadata about a mail Update metadata about a mail --- SSO Scope: esi-mail.organize_mail.v1
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailApi

public MailApi()

MailApi

public MailApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCharactersCharacterIdMailLabelsLabelId

public void deleteCharactersCharacterIdMailLabelsLabelId(Integer characterId,
                                                         Integer labelId,
                                                         String datasource,
                                                         String token)
                                                  throws ApiException

Delete a mail label Delete a mail label --- SSO Scope: esi-mail.organize_mail.v1

Parameters:

characterId - An EVE character ID (required)

labelId - An EVE label id (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Throws:

ApiException - if fails to make API call

deleteCharactersCharacterIdMailMailId

public void deleteCharactersCharacterIdMailMailId(Integer characterId,
                                                  Integer mailId,
                                                  String datasource,
                                                  String token)
                                           throws ApiException

Delete a mail Delete a mail --- SSO Scope: esi-mail.organize_mail.v1

Parameters:

characterId - An EVE character ID (required)

mailId - An EVE mail ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMail

public List<MailHeadersResponse> getCharactersCharacterIdMail(Integer characterId,
                                                              String datasource,
                                                              String ifNoneMatch,
                                                              List<Integer> labels,
                                                              Integer lastMailId,
                                                              String token)
                                                       throws ApiException

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 SSO Scope: esi-mail.read_mail.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

labels - Fetch only mails that match one or more of the given labels (optional)

lastMailId - List only mail with an ID lower than the given ID, if present (optional)

token - Access token to use if unable to set a header (optional)

Returns:

List<MailHeadersResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMailLabels

public MailLabelsResponse getCharactersCharacterIdMailLabels(Integer characterId,
                                                             String datasource,
                                                             String ifNoneMatch,
                                                             String token)
                                                      throws ApiException

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 SSO Scope: esi-mail.read_mail.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

MailLabelsResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMailLists

public List<CharacterMailinglistsResponse> getCharactersCharacterIdMailLists(Integer characterId,
                                                                             String datasource,
                                                                             String ifNoneMatch,
                                                                             String token)
                                                                      throws ApiException

Return mailing list subscriptions Return all mailing lists that the character is subscribed to --- This route is cached for up to 120 seconds SSO Scope: esi-mail.read_mail.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

List<CharacterMailinglistsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMailMailId

public MailResponse getCharactersCharacterIdMailMailId(Integer characterId,
                                                       Integer mailId,
                                                       String datasource,
                                                       String ifNoneMatch,
                                                       String token)
                                                throws ApiException

Return a mail Return the contents of an EVE mail --- This route is cached for up to 30 seconds SSO Scope: esi-mail.read_mail.v1

Parameters:

characterId - An EVE character ID (required)

mailId - An EVE mail ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

MailResponse

Throws:

ApiException - if fails to make API call

postCharactersCharacterIdMail

public Integer postCharactersCharacterIdMail(Integer characterId,
                                             Mail mail,
                                             String datasource,
                                             String token)
                                      throws ApiException

Send a new mail Create and send a new mail --- SSO Scope: esi-mail.send_mail.v1

Parameters:

characterId - An EVE character ID (required)

mail - The mail to send (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Returns:

Integer

Throws:

ApiException - if fails to make API call

postCharactersCharacterIdMailLabels

public Integer postCharactersCharacterIdMailLabels(Integer characterId,
                                                   MailLabelSimple label,
                                                   String datasource,
                                                   String token)
                                            throws ApiException

Create a mail label Create a mail label --- SSO Scope: esi-mail.organize_mail.v1

Parameters:

characterId - An EVE character ID (required)

label - Label to create (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Returns:

Integer

Throws:

ApiException - if fails to make API call

putCharactersCharacterIdMailMailId

public void putCharactersCharacterIdMailMailId(Integer characterId,
                                               MailMetaData contents,
                                               Integer mailId,
                                               String datasource,
                                               String token)
                                        throws ApiException

Update metadata about a mail Update metadata about a mail --- SSO Scope: esi-mail.organize_mail.v1

Parameters:

characterId - An EVE character ID (required)

contents - Data used to update the mail (required)

mailId - An EVE mail ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use if unable to set a header (optional)

Throws:

ApiException - if fails to make API call