Class: EsiClient::MailApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/api/mail_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MailApi

Returns a new instance of MailApi.



18
19
20
 
# File 'lib/esi-ruby/api/mail_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/esi-ruby/api/mail_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#delete_characters_character_id_mail_labels_label_id(character_id, label_id, opts = {}) ⇒ nil

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

Parameters:

  • character_id —

    An EVE character ID

  • label_id —

    An EVE label id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/esi-ruby/api/mail_api.rb', line 32

def delete_characters_character_id_mail_labels_label_id(character_id, label_id, opts = {})
  delete_characters_character_id_mail_labels_label_id_with_http_info(character_id, label_id, opts)
  return nil
end

#delete_characters_character_id_mail_labels_label_id_with_http_info(character_id, label_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a mail label Delete a mail label — Alternate route: &#x60;/v1/characters/character_id/mail/labels/label_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/labels/label_id/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/labels/label_id/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • label_id —

    An EVE label id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/esi-ruby/api/mail_api.rb', line 47

def delete_characters_character_id_mail_labels_label_id_with_http_info(character_id, label_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.delete_characters_character_id_mail_labels_label_id ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.delete_characters_character_id_mail_labels_label_id" if character_id.nil?
  # verify the required parameter 'label_id' is set
  fail ArgumentError, "Missing the required parameter 'label_id' when calling MailApi.delete_characters_character_id_mail_labels_label_id" if label_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/labels/{label_id}/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'label_id' + '}', label_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#delete_characters_character_id_mail_labels_label_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_characters_character_id_mail_mail_id(character_id, mail_id, opts = {}) ⇒ nil

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

Parameters:

  • character_id —

    An EVE character ID

  • mail_id —

    An EVE mail ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (nil) 


101
102
103
104
 
# File 'lib/esi-ruby/api/mail_api.rb', line 101

def delete_characters_character_id_mail_mail_id(character_id, mail_id, opts = {})
  delete_characters_character_id_mail_mail_id_with_http_info(character_id, mail_id, opts)
  return nil
end

#delete_characters_character_id_mail_mail_id_with_http_info(character_id, mail_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a mail Delete a mail — Alternate route: &#x60;/v1/characters/character_id/mail/mail_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/mail_id/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/mail_id/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • mail_id —

    An EVE mail ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/esi-ruby/api/mail_api.rb', line 116

def delete_characters_character_id_mail_mail_id_with_http_info(character_id, mail_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.delete_characters_character_id_mail_mail_id ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.delete_characters_character_id_mail_mail_id" if character_id.nil?
  # verify the required parameter 'mail_id' is set
  fail ArgumentError, "Missing the required parameter 'mail_id' when calling MailApi.delete_characters_character_id_mail_mail_id" if mail_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/{mail_id}/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'mail_id' + '}', mail_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#delete_characters_character_id_mail_mail_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_mail(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdMail200Ok>

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

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :labels (Array<Integer>) —

    Fetch only mails that match one or more of the given labels

  • :last_mail_id (Integer) —

    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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



171
172
173
174
 
# File 'lib/esi-ruby/api/mail_api.rb', line 171

def get_characters_character_id_mail(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_mail_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_mail_labels(character_id, opts = {}) ⇒ GetCharactersCharacterIdMailLabelsOk

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

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



249
250
251
252
 
# File 'lib/esi-ruby/api/mail_api.rb', line 249

def get_characters_character_id_mail_labels(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_mail_labels_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_mail_labels_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdMailLabelsOk, Fixnum, Hash)>

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: &#x60;/v3/characters/character_id/mail/labels/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/labels/&#x60; — This route is cached for up to 30 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/esi-ruby/api/mail_api.rb', line 263

def get_characters_character_id_mail_labels_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.get_characters_character_id_mail_labels ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.get_characters_character_id_mail_labels" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/labels/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetCharactersCharacterIdMailLabelsOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#get_characters_character_id_mail_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_mail_lists(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdMailLists200Ok>

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

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



315
316
317
318
 
# File 'lib/esi-ruby/api/mail_api.rb', line 315

def get_characters_character_id_mail_lists(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_mail_lists_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_mail_lists_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdMailLists200Ok>, Fixnum, Hash)>

Return mailing list subscriptions Return all mailing lists that the character is subscribed to — Alternate route: &#x60;/v1/characters/character_id/mail/lists/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/lists/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/lists/&#x60; — This route is cached for up to 120 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/esi-ruby/api/mail_api.rb', line 329

def get_characters_character_id_mail_lists_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.get_characters_character_id_mail_lists ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.get_characters_character_id_mail_lists" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/lists/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdMailLists200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#get_characters_character_id_mail_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_mail_mail_id(character_id, mail_id, opts = {}) ⇒ GetCharactersCharacterIdMailMailIdOk

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

Parameters:

  • character_id —

    An EVE character ID

  • mail_id —

    An EVE mail ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



382
383
384
385
 
# File 'lib/esi-ruby/api/mail_api.rb', line 382

def get_characters_character_id_mail_mail_id(character_id, mail_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_mail_mail_id_with_http_info(character_id, mail_id, opts)
  return data
end

#get_characters_character_id_mail_mail_id_with_http_info(character_id, mail_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdMailMailIdOk, Fixnum, Hash)>

Return a mail Return the contents of an EVE mail — Alternate route: &#x60;/v1/characters/character_id/mail/mail_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/mail_id/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/mail_id/&#x60; — This route is cached for up to 30 seconds

Parameters:

  • character_id —

    An EVE character ID

  • mail_id —

    An EVE mail ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/esi-ruby/api/mail_api.rb', line 397

def get_characters_character_id_mail_mail_id_with_http_info(character_id, mail_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.get_characters_character_id_mail_mail_id ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.get_characters_character_id_mail_mail_id" if character_id.nil?
  # verify the required parameter 'mail_id' is set
  fail ArgumentError, "Missing the required parameter 'mail_id' when calling MailApi.get_characters_character_id_mail_mail_id" if mail_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/{mail_id}/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'mail_id' + '}', mail_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetCharactersCharacterIdMailMailIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#get_characters_character_id_mail_mail_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_mail_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdMail200Ok>, Fixnum, Hash)>

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: &#x60;/v1/characters/character_id/mail/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/&#x60; — This route is cached for up to 30 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :labels (Array<Integer>) —

    Fetch only mails that match one or more of the given labels

  • :last_mail_id (Integer) —

    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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/esi-ruby/api/mail_api.rb', line 187

def get_characters_character_id_mail_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.get_characters_character_id_mail ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.get_characters_character_id_mail" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if !opts[:'labels'].nil? && opts[:'labels'].length > 25
    fail ArgumentError, 'invalid value for "opts[:"labels"]" when calling MailApi.get_characters_character_id_mail, number of items must be less than or equal to 25.'
  end

  if !opts[:'labels'].nil? && opts[:'labels'].length < 1
    fail ArgumentError, 'invalid value for "opts[:"labels"]" when calling MailApi.get_characters_character_id_mail, number of items must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/characters/{character_id}/mail/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'labels'] = @api_client.build_collection_param(opts[:'labels'], :csv) if !opts[:'labels'].nil?
  query_params[:'last_mail_id'] = opts[:'last_mail_id'] if !opts[:'last_mail_id'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdMail200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#get_characters_character_id_mail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_characters_character_id_mail(character_id, mail, opts = {}) ⇒ Integer

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

Parameters:

  • character_id —

    An EVE character ID

  • mail —

    The mail to send

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Integer) 


452
453
454
455
 
# File 'lib/esi-ruby/api/mail_api.rb', line 452

def post_characters_character_id_mail(character_id, mail, opts = {})
  data, _status_code, _headers = post_characters_character_id_mail_with_http_info(character_id, mail, opts)
  return data
end

#post_characters_character_id_mail_labels(character_id, opts = {}) ⇒ Integer

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

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :label (PostCharactersCharacterIdMailLabelsLabel) —

    Label to create

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Integer) 


522
523
524
525
 
# File 'lib/esi-ruby/api/mail_api.rb', line 522

def post_characters_character_id_mail_labels(character_id, opts = {})
  data, _status_code, _headers = post_characters_character_id_mail_labels_with_http_info(character_id, opts)
  return data
end

#post_characters_character_id_mail_labels_with_http_info(character_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Create a mail label Create a mail label — Alternate route: &#x60;/v2/characters/character_id/mail/labels/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/labels/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/labels/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :label (PostCharactersCharacterIdMailLabelsLabel) —

    Label to create

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Integer, Fixnum, Hash)>) —

    Integer data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/esi-ruby/api/mail_api.rb', line 537

def post_characters_character_id_mail_labels_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.post_characters_character_id_mail_labels ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.post_characters_character_id_mail_labels" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/labels/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'label'])
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#post_characters_character_id_mail_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_characters_character_id_mail_with_http_info(character_id, mail, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Send a new mail Create and send a new mail — Alternate route: &#x60;/v1/characters/character_id/mail/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • mail —

    The mail to send

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Integer, Fixnum, Hash)>) —

    Integer data, response status code and response headers



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/esi-ruby/api/mail_api.rb', line 467

def post_characters_character_id_mail_with_http_info(character_id, mail, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.post_characters_character_id_mail ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.post_characters_character_id_mail" if character_id.nil?
  # verify the required parameter 'mail' is set
  fail ArgumentError, "Missing the required parameter 'mail' when calling MailApi.post_characters_character_id_mail" if mail.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(mail)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#post_characters_character_id_mail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_characters_character_id_mail_mail_id(character_id, contents, mail_id, opts = {}) ⇒ nil

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

Parameters:

  • character_id —

    An EVE character ID

  • contents —

    Data used to update the mail

  • mail_id —

    An EVE mail ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (nil) 


591
592
593
594
 
# File 'lib/esi-ruby/api/mail_api.rb', line 591

def put_characters_character_id_mail_mail_id(character_id, contents, mail_id, opts = {})
  put_characters_character_id_mail_mail_id_with_http_info(character_id, contents, mail_id, opts)
  return nil
end

#put_characters_character_id_mail_mail_id_with_http_info(character_id, contents, mail_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update metadata about a mail Update metadata about a mail — Alternate route: &#x60;/v1/characters/character_id/mail/mail_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/mail/mail_id/&#x60; Alternate route: &#x60;/dev/characters/character_id/mail/mail_id/&#x60;

Parameters:

  • character_id —

    An EVE character ID

  • contents —

    Data used to update the mail

  • mail_id —

    An EVE mail ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/esi-ruby/api/mail_api.rb', line 607

def put_characters_character_id_mail_mail_id_with_http_info(character_id, contents, mail_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MailApi.put_characters_character_id_mail_mail_id ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MailApi.put_characters_character_id_mail_mail_id" if character_id.nil?
  # verify the required parameter 'contents' is set
  fail ArgumentError, "Missing the required parameter 'contents' when calling MailApi.put_characters_character_id_mail_mail_id" if contents.nil?
  # verify the required parameter 'mail_id' is set
  fail ArgumentError, "Missing the required parameter 'mail_id' when calling MailApi.put_characters_character_id_mail_mail_id" if mail_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/mail/{mail_id}/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'mail_id' + '}', mail_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(contents)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MailApi#put_characters_character_id_mail_mail_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end