module ESI::Client::Mail

ESI mail operations.

Public Instance Methods

delete_character_mail(character_id:, mail_id:, headers: {}, params: {}) click to toggle source

Delete a mail.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.organize_mail.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param mail_id [Integer] An EVE mail ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_mail_id

# File lib/esi/client/mail.rb, line 31
def delete_character_mail(character_id:, mail_id:, headers: {}, params: {})
  delete("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
end
delete_character_mail_label(character_id:, label_id:, headers: {}, params: {}) click to toggle source

Delete a mail label.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.organize_mail.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param label_id [Integer] An EVE label id @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::UnprocessableEntityError] Default labels cannot be deleted @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/delete_characters_character_id_mail_labels_label_id

# File lib/esi/client/mail.rb, line 61
def delete_character_mail_label(character_id:, label_id:, headers: {}, params: {})
  delete("/characters/#{character_id}/mail/labels/#{label_id}/", headers: headers, params: params)
end
delete_characters_character_id_mail_labels_label_id(character_id:, label_id:, headers: {}, params: {})
delete_characters_character_id_mail_mail_id(character_id:, mail_id:, headers: {}, params: {})
get_character_mail(character_id:, mail_id:, headers: {}, params: {}) click to toggle source

Return the contents of an EVE mail.

This endpoint is cached for up to 30 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.read_mail.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param mail_id [Integer] An EVE mail ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::NotFoundError] Mail not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_mail_id

# File lib/esi/client/mail.rb, line 93
def get_character_mail(character_id:, mail_id:, headers: {}, params: {})
  get("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params)
end
get_character_mail_labels(character_id:, headers: {}, params: {}) click to toggle source

Return a list of the users mail labels, unread counts for each label and a total unread count.

This endpoint is cached for up to 30 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.read_mail.v1

@esi_version dev @esi_version v3

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_labels

# File lib/esi/client/mail.rb, line 122
def get_character_mail_labels(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/mail/labels/", headers: headers, params: params)
end
get_character_mail_lists(character_id:, headers: {}, params: {}) click to toggle source

Return all mailing lists that the character is subscribed to.

This endpoint is cached for up to 120 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.read_mail.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/get_characters_character_id_mail_lists

# File lib/esi/client/mail.rb, line 152
def get_character_mail_lists(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/mail/lists/", headers: headers, params: params)
end
get_characters_character_id_mail_labels(character_id:, headers: {}, params: {})
get_characters_character_id_mail_lists(character_id:, headers: {}, params: {})
get_characters_character_id_mail_mail_id(character_id:, mail_id:, headers: {}, params: {})
Alias for: get_character_mail
post_character_mail(character_id:, mail:, headers: {}, params: {}) click to toggle source

Create and send a new mail.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.send_mail.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param mail [Hash] The mail to send @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit

@see esi.evetech.net/ui/#/Mail/post_characters_character_id_mail

# File lib/esi/client/mail.rb, line 182
def post_character_mail(character_id:, mail:, headers: {}, params: {})
  post("/characters/#{character_id}/mail/", headers: headers, params: params, payload: mail)
end
post_character_mail_labels(character_id:, label:, headers: {}, params: {}) click to toggle source

Create a mail label.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.organize_mail.v1

@esi_version dev @esi_version legacy @esi_version v2

@param character_id [Integer] An EVE character ID @param label [Hash] Label to create @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/post_characters_character_id_mail_labels

# File lib/esi/client/mail.rb, line 211
def post_character_mail_labels(character_id:, label:, headers: {}, params: {})
  post("/characters/#{character_id}/mail/labels/", headers: headers, params: params, payload: label)
end
post_characters_character_id_mail(character_id:, mail:, headers: {}, params: {})
Alias for: post_character_mail
post_characters_character_id_mail_labels(character_id:, label:, headers: {}, params: {})
put_character_mail(character_id:, mail_id:, contents:, headers: {}, params: {}) click to toggle source

Update metadata about a mail.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-mail.organize_mail.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param mail_id [Integer] An EVE mail ID @param contents [Hash] Data used to update the mail @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Mail/put_characters_character_id_mail_mail_id

# File lib/esi/client/mail.rb, line 241
def put_character_mail(character_id:, mail_id:, contents:, headers: {}, params: {})
  put("/characters/#{character_id}/mail/#{mail_id}/", headers: headers, params: params, payload: contents)
end
put_characters_character_id_mail_mail_id(character_id:, mail_id:, contents:, headers: {}, params: {})
Alias for: put_character_mail