Skip to content

Latest commit

 

History

History
397 lines (276 loc) · 17.1 KB

MailApi.md

File metadata and controls

397 lines (276 loc) · 17.1 KB

\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(ctx, characterId, labelId, optional) Delete a mail label

Delete a mail label ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
labelId int32 An EVE label id
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
labelId int32 An EVE label id
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

(empty response body)

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCharactersCharacterIdMailMailId

DeleteCharactersCharacterIdMailMailId(ctx, characterId, mailId, optional) Delete a mail

Delete a mail ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
mailId int32 An EVE mail ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
mailId int32 An EVE mail ID
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

(empty response body)

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdMail

[]GetCharactersCharacterIdMail200Ok GetCharactersCharacterIdMail(ctx, characterId, optional) 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

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
labels []int32 Fetch only mails that match one or more of the given labels
lastMailId int32 List only mail with an ID lower than the given ID, if present
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetCharactersCharacterIdMail200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdMailLabels

GetCharactersCharacterIdMailLabelsOk GetCharactersCharacterIdMailLabels(ctx, characterId, optional) 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

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

GetCharactersCharacterIdMailLabelsOk

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdMailLists

[]GetCharactersCharacterIdMailLists200Ok GetCharactersCharacterIdMailLists(ctx, characterId, optional) Return mailing list subscriptions

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

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetCharactersCharacterIdMailLists200Ok

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCharactersCharacterIdMailMailId

GetCharactersCharacterIdMailMailIdOk GetCharactersCharacterIdMailMailId(ctx, characterId, mailId, optional) Return a mail

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

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
mailId int32 An EVE mail ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
mailId int32 An EVE mail ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

GetCharactersCharacterIdMailMailIdOk

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCharactersCharacterIdMail

int32 PostCharactersCharacterIdMail(ctx, characterId, mail, optional) Send a new mail

Create and send a new mail ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
mail PostCharactersCharacterIdMailMail The mail to send
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
mail PostCharactersCharacterIdMailMail The mail to send
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

int32

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCharactersCharacterIdMailLabels

int32 PostCharactersCharacterIdMailLabels(ctx, characterId, label, optional) Create a mail label

Create a mail label ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
label PostCharactersCharacterIdMailLabelsLabel Label to create
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
label PostCharactersCharacterIdMailLabelsLabel Label to create
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

int32

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutCharactersCharacterIdMailMailId

PutCharactersCharacterIdMailMailId(ctx, characterId, contents, mailId, optional) Update metadata about a mail

Update metadata about a mail ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
contents PutCharactersCharacterIdMailMailIdContents Data used to update the mail
mailId int32 An EVE mail ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
contents PutCharactersCharacterIdMailMailIdContents Data used to update the mail
mailId int32 An EVE mail ID
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

(empty response body)

Authorization

evesso

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]