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, String userAgent, String xUserAgent) Delete a mail label Delete a mail label --- Alternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/` Alternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/` Alternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/` SSO Scope: esi-mail.organize_mail.v1
void	deleteCharactersCharacterIdMailMailId(Integer characterId, Integer mailId, String datasource, String token, String userAgent, String xUserAgent) Delete a mail Delete a mail --- Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` SSO Scope: esi-mail.organize_mail.v1
ApiClient	getApiClient()
List<MailHeadersResponse>	getCharactersCharacterIdMail(Integer characterId, String datasource, List<Long> labels, Integer lastMailId, String token, String userAgent, String xUserAgent) 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 token, String userAgent, String xUserAgent) 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: `/v3/characters/{character_id}/mail/labels/` Alternate route: `/dev/characters/{character_id}/mail/labels/` --- This route is cached for up to 30 seconds SSO Scope: esi-mail.read_mail.v1
List<CharacterMailinglistsResponse>	getCharactersCharacterIdMailLists(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Return mailing list subscriptions Return all mailing lists that the character is subscribed to --- Alternate route: `/v1/characters/{character_id}/mail/lists/` Alternate route: `/legacy/characters/{character_id}/mail/lists/` Alternate route: `/dev/characters/{character_id}/mail/lists/` --- 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 token, String userAgent, String xUserAgent) Return a mail Return the contents of an EVE mail --- Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` --- 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, String userAgent, String xUserAgent) Send a new mail Create and send a new mail --- Alternate route: `/v1/characters/{character_id}/mail/` Alternate route: `/legacy/characters/{character_id}/mail/` Alternate route: `/dev/characters/{character_id}/mail/` SSO Scope: esi-mail.send_mail.v1
Long	postCharactersCharacterIdMailLabels(Integer characterId, String datasource, MailLabelSimple label, String token, String userAgent, String xUserAgent) Create a mail label Create a mail label --- Alternate route: `/v2/characters/{character_id}/mail/labels/` Alternate route: `/legacy/characters/{character_id}/mail/labels/` Alternate route: `/dev/characters/{character_id}/mail/labels/` SSO Scope: esi-mail.organize_mail.v1
void	putCharactersCharacterIdMailMailId(Integer characterId, MailMetaData contents, Integer mailId, String datasource, String token, String userAgent, String xUserAgent) Update metadata about a mail Update metadata about a mail --- Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` 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,
                                                         String userAgent,
                                                         String xUserAgent)
                                                  throws ApiException

Delete a mail label Delete a mail label --- Alternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/` Alternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/` Alternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/` 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 preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Throws:

ApiException - if fails to make API call

deleteCharactersCharacterIdMailMailId

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

Delete a mail Delete a mail --- Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` 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 preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMail

public List<MailHeadersResponse> getCharactersCharacterIdMail(Integer characterId,
                                                              String datasource,
                                                              List<Long> labels,
                                                              Integer lastMailId,
                                                              String token,
                                                              String userAgent,
                                                              String xUserAgent)
                                                       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. --- Alternate route: `/v1/characters/{character_id}/mail/` Alternate route: `/legacy/characters/{character_id}/mail/` Alternate route: `/dev/characters/{character_id}/mail/` --- 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)

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 preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

List

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMailLabels

public MailLabelsResponse getCharactersCharacterIdMailLabels(Integer characterId,
                                                             String datasource,
                                                             String token,
                                                             String userAgent,
                                                             String xUserAgent)
                                                      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. --- Alternate route: `/v3/characters/{character_id}/mail/labels/` Alternate route: `/dev/characters/{character_id}/mail/labels/` --- 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)

token - Access token to use, if preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

MailLabelsResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMailLists

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

Return mailing list subscriptions Return all mailing lists that the character is subscribed to --- Alternate route: `/v1/characters/{character_id}/mail/lists/` Alternate route: `/legacy/characters/{character_id}/mail/lists/` Alternate route: `/dev/characters/{character_id}/mail/lists/` --- 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)

token - Access token to use, if preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

List

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdMailMailId

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

Return a mail Return the contents of an EVE mail --- Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` --- 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)

token - Access token to use, if preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

MailResponse

Throws:

ApiException - if fails to make API call

postCharactersCharacterIdMail

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

Send a new mail Create and send a new mail --- Alternate route: `/v1/characters/{character_id}/mail/` Alternate route: `/legacy/characters/{character_id}/mail/` Alternate route: `/dev/characters/{character_id}/mail/` SSO Scope: esi-mail.send_mail.v1

Parameters:

characterId - The sender's 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 preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

Integer

Throws:

ApiException - if fails to make API call

postCharactersCharacterIdMailLabels

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

Create a mail label Create a mail label --- Alternate route: `/v2/characters/{character_id}/mail/labels/` Alternate route: `/legacy/characters/{character_id}/mail/labels/` Alternate route: `/dev/characters/{character_id}/mail/labels/` SSO Scope: esi-mail.organize_mail.v1

Parameters:

characterId - An EVE character ID (required)

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

label - Label to create (optional)

token - Access token to use, if preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

Long

Throws:

ApiException - if fails to make API call

putCharactersCharacterIdMailMailId

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

Update metadata about a mail Update metadata about a mail --- Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` 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 preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Throws:

ApiException - if fails to make API call