openapi: 3.0.0 info: description: An OpenAPI for EVE Online title: EVE Swagger Interface Alliance Mail API version: '1.36' servers: - url: https://esi.evetech.net/latest tags: - name: Mail paths: /characters/{character_id}/mail/: get: description: '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: `/dev/characters/{character_id}/mail/` Alternate route: `/legacy/characters/{character_id}/mail/` Alternate route: `/v1/characters/{character_id}/mail/` --- This route is cached for up to 30 seconds' operationId: get_characters_character_id_mail parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - $ref: '#/components/parameters/If-None-Match' - description: Fetch only mails that match one or more of the given labels in: query name: labels required: false style: form explode: false schema: type: array items: format: int32 minimum: 0 type: integer minItems: 1 maxItems: 25 uniqueItems: true example: - 1 - description: List only mail with an ID lower than the given ID, if present in: query name: last_mail_id schema: type: integer format: int32 example: 1001 - $ref: '#/components/parameters/token' responses: '200': description: The requested mail headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string content: application/json: schema: description: 200 ok array items: description: 200 ok object properties: from: description: From whom the mail was sent format: int32 title: get_characters_character_id_mail_from type: integer is_read: description: is_read boolean title: get_characters_character_id_mail_is_read type: boolean labels: description: labels array items: description: label integer format: int32 title: get_characters_character_id_mail_label type: integer maxItems: 25 minimum: 0 title: get_characters_character_id_mail_labels type: array uniqueItems: true mail_id: description: mail_id integer format: int32 title: get_characters_character_id_mail_mail_id type: integer recipients: description: Recipients of the mail items: description: recipient object properties: recipient_id: description: recipient_id integer format: int32 title: get_characters_character_id_mail_recipient_id type: integer recipient_type: description: recipient_type string enum: - alliance - character - corporation - mailing_list title: get_characters_character_id_mail_recipient_type type: string required: - recipient_type - recipient_id title: get_characters_character_id_mail_recipient type: object maxItems: 52 minItems: 0 title: get_characters_character_id_mail_recipients type: array uniqueItems: true subject: description: Mail subject title: get_characters_character_id_mail_subject type: string timestamp: description: When the mail was sent format: date-time title: get_characters_character_id_mail_timestamp type: string title: get_characters_character_id_mail_200_ok type: object maxItems: 50 title: get_characters_character_id_mail_ok type: array examples: response: value: - from: 90000001 is_read: true labels: - 3 mail_id: 7 recipients: - recipient_id: 90000002 recipient_type: character subject: Title for EVE Mail timestamp: 2015-09-30 16:07:00+00:00 '304': description: Not modified headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.read_mail.v1 summary: EVE Online Return Mail Headers tags: - Mail x-alternate-versions: - dev - legacy - v1 x-cached-seconds: 30 x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'Create and send a new mail --- Alternate route: `/dev/characters/{character_id}/mail/` Alternate route: `/legacy/characters/{character_id}/mail/` Alternate route: `/v1/characters/{character_id}/mail/` ' operationId: post_characters_character_id_mail parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - $ref: '#/components/parameters/token' requestBody: content: application/json: schema: description: mail object properties: approved_cost: default: 0 description: approved_cost integer format: int64 title: post_characters_character_id_mail_approved_cost type: integer body: description: body string maxLength: 10000 title: post_characters_character_id_mail_body type: string recipients: description: recipients array items: description: recipient object properties: recipient_id: description: recipient_id integer format: int32 title: post_characters_character_id_mail_recipient_id type: integer recipient_type: description: recipient_type string enum: - alliance - character - corporation - mailing_list title: post_characters_character_id_mail_recipient_type type: string required: - recipient_type - recipient_id title: post_characters_character_id_mail_recipient type: object maxItems: 50 minItems: 1 title: post_characters_character_id_mail_recipients type: array subject: description: subject string maxLength: 1000 title: post_characters_character_id_mail_subject type: string required: - recipients - subject - body title: post_characters_character_id_mail_mail type: object examples: PostCharactersCharacterIdMailRequestExample: summary: Default post_characters_character_id_mail request x-microcks-default: true value: approved_cost: 1 body: example recipients: - recipient_id: 1001 recipient_type: alliance subject: example description: The mail to send required: true responses: '201': description: Mail created content: application/json: schema: description: Mail ID format: int32 title: post_characters_character_id_mail_created type: integer examples: response: value: 13 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message '520': description: Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit content: application/json: schema: description: Error 520 properties: error: description: Error 520 message title: post_characters_character_id_mail_520_error_520 type: string title: post_characters_character_id_mail_error_520 type: object examples: response: value: error: Error 520 message security: - evesso: - esi-mail.send_mail.v1 summary: EVE Online Send a New Mail tags: - Mail x-alternate-versions: - dev - legacy - v1 x-microcks-operation: delay: 0 dispatcher: FALLBACK /characters/{character_id}/mail/labels/: get: description: 'Return a list of the users mail labels, unread counts for each label and a total unread count. --- Alternate route: `/dev/characters/{character_id}/mail/labels/` Alternate route: `/v3/characters/{character_id}/mail/labels/` --- This route is cached for up to 30 seconds' operationId: get_characters_character_id_mail_labels parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - $ref: '#/components/parameters/If-None-Match' - $ref: '#/components/parameters/token' responses: '200': description: A list of mail labels and unread counts headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string content: application/json: schema: description: 200 ok object properties: labels: description: labels array items: description: label object properties: color: default: '#ffffff' description: color string enum: - '#0000fe' - '#006634' - '#0099ff' - '#00ff33' - '#01ffff' - '#349800' - '#660066' - '#666666' - '#999999' - '#99ffff' - '#9a0000' - '#ccff9a' - '#e6e6e6' - '#fe0000' - '#ff6600' - '#ffff01' - '#ffffcd' - '#ffffff' title: get_characters_character_id_mail_labels_color type: string label_id: description: label_id integer format: int32 minimum: 0 title: get_characters_character_id_mail_labels_label_id type: integer name: description: name string maxLength: 40 title: get_characters_character_id_mail_labels_name type: string unread_count: description: unread_count integer format: int32 minimum: 0 title: get_characters_character_id_mail_labels_unread_count type: integer title: get_characters_character_id_mail_labels_label type: object maxItems: 30 title: get_characters_character_id_mail_labels_labels type: array total_unread_count: description: total_unread_count integer format: int32 minimum: 0 title: get_characters_character_id_mail_labels_total_unread_count type: integer title: get_characters_character_id_mail_labels_ok type: object examples: response: value: labels: - color: '#660066' label_id: 16 name: PINK unread_count: 4 - color: '#ffffff' label_id: 17 name: WHITE unread_count: 1 total_unread_count: 5 '304': description: Not modified headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.read_mail.v1 summary: EVE Online Get Mail Labels and Unread Counts tags: - Mail x-alternate-versions: - dev - v3 x-cached-seconds: 30 x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'Create a mail label --- Alternate route: `/dev/characters/{character_id}/mail/labels/` Alternate route: `/legacy/characters/{character_id}/mail/labels/` Alternate route: `/v2/characters/{character_id}/mail/labels/` ' operationId: post_characters_character_id_mail_labels parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - $ref: '#/components/parameters/token' requestBody: content: application/json: schema: description: label object properties: color: default: '#ffffff' description: Hexadecimal string representing label color, in RGB format enum: - '#0000fe' - '#006634' - '#0099ff' - '#00ff33' - '#01ffff' - '#349800' - '#660066' - '#666666' - '#999999' - '#99ffff' - '#9a0000' - '#ccff9a' - '#e6e6e6' - '#fe0000' - '#ff6600' - '#ffff01' - '#ffffcd' - '#ffffff' title: post_characters_character_id_mail_labels_color type: string name: description: name string maxLength: 40 minLength: 1 title: post_characters_character_id_mail_labels_name type: string required: - name title: post_characters_character_id_mail_labels_label type: object examples: PostCharactersCharacterIdMailLabelsRequestExample: summary: Default post_characters_character_id_mail_labels request x-microcks-default: true value: color: '#0000fe' name: Example Name description: Label to create required: true responses: '201': description: Label created content: application/json: schema: description: Label ID format: int32 title: post_characters_character_id_mail_labels_created type: integer examples: response: value: 128 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.organize_mail.v1 summary: EVE Online Create a Mail Label tags: - Mail x-alternate-versions: - dev - legacy - v2 x-microcks-operation: delay: 0 dispatcher: FALLBACK /characters/{character_id}/mail/labels/{label_id}/: delete: description: 'Delete a mail label --- Alternate route: `/dev/characters/{character_id}/mail/labels/{label_id}/` Alternate route: `/legacy/characters/{character_id}/mail/labels/{label_id}/` Alternate route: `/v1/characters/{character_id}/mail/labels/{label_id}/` ' operationId: delete_characters_character_id_mail_labels_label_id parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - description: An EVE label id in: path name: label_id required: true schema: type: integer format: int32 example: 1001 - $ref: '#/components/parameters/token' responses: '204': description: Label deleted '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '422': description: Default labels cannot be deleted content: application/json: schema: description: Unprocessable entity properties: error: description: Unprocessable entity message title: delete_characters_character_id_mail_labels_label_id_422_unprocessable_entity type: string title: delete_characters_character_id_mail_labels_label_id_unprocessable_entity type: object examples: response: value: error: Unprocessable entity message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.organize_mail.v1 summary: EVE Online Delete a Mail Label tags: - Mail x-alternate-versions: - dev - legacy - v1 x-microcks-operation: delay: 0 dispatcher: FALLBACK /characters/{character_id}/mail/lists/: get: description: 'Return all mailing lists that the character is subscribed to --- Alternate route: `/dev/characters/{character_id}/mail/lists/` Alternate route: `/legacy/characters/{character_id}/mail/lists/` Alternate route: `/v1/characters/{character_id}/mail/lists/` --- This route is cached for up to 120 seconds' operationId: get_characters_character_id_mail_lists parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - $ref: '#/components/parameters/If-None-Match' - $ref: '#/components/parameters/token' responses: '200': description: Mailing lists headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string content: application/json: schema: description: 200 ok array items: description: 200 ok object properties: mailing_list_id: description: Mailing list ID format: int32 title: get_characters_character_id_mail_lists_mailing_list_id type: integer name: description: name string title: get_characters_character_id_mail_lists_name type: string required: - mailing_list_id - name title: get_characters_character_id_mail_lists_200_ok type: object maxItems: 1000 title: get_characters_character_id_mail_lists_ok type: array examples: response: value: - mailing_list_id: 1 name: test_mailing_list '304': description: Not modified headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.read_mail.v1 summary: EVE Online Return Mailing List Subscriptions tags: - Mail x-alternate-versions: - dev - legacy - v1 x-cached-seconds: 120 x-microcks-operation: delay: 0 dispatcher: FALLBACK /characters/{character_id}/mail/{mail_id}/: delete: description: 'Delete a mail --- Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` ' operationId: delete_characters_character_id_mail_mail_id parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - description: An EVE mail ID in: path name: mail_id required: true schema: type: integer format: int32 example: 1001 - $ref: '#/components/parameters/token' responses: '204': description: Mail deleted '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.organize_mail.v1 summary: EVE Online Delete a Mail tags: - Mail x-alternate-versions: - dev - legacy - v1 x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'Return the contents of an EVE mail --- Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` --- This route is cached for up to 30 seconds' operationId: get_characters_character_id_mail_mail_id parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - $ref: '#/components/parameters/If-None-Match' - description: An EVE mail ID in: path name: mail_id required: true schema: type: integer format: int32 example: 1001 - $ref: '#/components/parameters/token' responses: '200': description: Contents of a mail headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string content: application/json: schema: description: 200 ok object properties: body: description: Mail's body title: get_characters_character_id_mail_mail_id_body type: string from: description: From whom the mail was sent format: int32 title: get_characters_character_id_mail_mail_id_from type: integer labels: description: Labels attached to the mail items: description: label integer format: int32 minimum: 0 title: get_characters_character_id_mail_mail_id_label type: integer uniqueItems: true maxItems: 25 title: get_characters_character_id_mail_mail_id_labels type: array read: description: Whether the mail is flagged as read title: get_characters_character_id_mail_mail_id_read type: boolean recipients: description: Recipients of the mail items: description: recipient object properties: recipient_id: description: recipient_id integer format: int32 title: get_characters_character_id_mail_mail_id_recipient_id type: integer recipient_type: description: recipient_type string enum: - alliance - character - corporation - mailing_list title: get_characters_character_id_mail_mail_id_recipient_type type: string required: - recipient_type - recipient_id title: get_characters_character_id_mail_mail_id_recipient type: object maxItems: 52 minItems: 0 title: get_characters_character_id_mail_mail_id_recipients type: array uniqueItems: true subject: description: Mail subject title: get_characters_character_id_mail_mail_id_subject type: string timestamp: description: When the mail was sent format: date-time title: get_characters_character_id_mail_mail_id_timestamp type: string title: get_characters_character_id_mail_mail_id_ok type: object examples: response: value: body: blah blah blah from: 90000001 labels: - 2 - 32 read: true subject: test timestamp: 2015-09-30 16:07:00+00:00 '304': description: Not modified headers: Cache-Control: description: The caching mechanism used schema: type: string ETag: description: RFC7232 compliant entity tag schema: type: string Expires: description: RFC7231 formatted datetime string schema: type: string Last-Modified: description: RFC7231 formatted datetime string schema: type: string '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '404': description: Mail not found content: application/json: schema: description: Not found properties: error: description: Not found message title: get_characters_character_id_mail_mail_id_404_not_found type: string title: get_characters_character_id_mail_mail_id_not_found type: object examples: response: value: error: Not found message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.read_mail.v1 summary: EVE Online Return a Mail tags: - Mail x-alternate-versions: - dev - legacy - v1 x-cached-seconds: 30 x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'Update metadata about a mail --- Alternate route: `/dev/characters/{character_id}/mail/{mail_id}/` Alternate route: `/legacy/characters/{character_id}/mail/{mail_id}/` Alternate route: `/v1/characters/{character_id}/mail/{mail_id}/` ' operationId: put_characters_character_id_mail_mail_id parameters: - $ref: '#/components/parameters/character_id' - $ref: '#/components/parameters/datasource' - description: An EVE mail ID in: path name: mail_id required: true schema: type: integer format: int32 example: 1001 - $ref: '#/components/parameters/token' requestBody: content: application/json: schema: description: contents object properties: labels: description: Labels to assign to the mail. Pre-existing labels are unassigned. items: description: label integer format: int32 minimum: 0 title: put_characters_character_id_mail_mail_id_label type: integer uniqueItems: true maxItems: 25 title: put_characters_character_id_mail_mail_id_labels type: array read: description: Whether the mail is flagged as read title: put_characters_character_id_mail_mail_id_read type: boolean title: put_characters_character_id_mail_mail_id_contents type: object examples: PutCharactersCharacterIdMailMailIdRequestExample: summary: Default put_characters_character_id_mail_mail_id request x-microcks-default: true value: labels: - 1 read: false description: Data used to update the mail required: true responses: '204': description: Mail updated '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/bad_request' examples: response: value: error: Bad request message '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/unauthorized' examples: response: value: error: Unauthorized message '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/forbidden' examples: response: value: error: Forbidden message '420': description: Error limited content: application/json: schema: $ref: '#/components/schemas/error_limited' examples: response: value: error: Error limited message '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/internal_server_error' examples: response: value: error: Internal server error message '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/service_unavailable' examples: response: value: error: Service unavailable message '504': description: Gateway timeout content: application/json: schema: $ref: '#/components/schemas/gateway_timeout' examples: response: value: error: Gateway timeout message security: - evesso: - esi-mail.organize_mail.v1 summary: EVE Online Update Metadata About a Mail tags: - Mail x-alternate-versions: - dev - legacy - v1 x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/characters/{character_id}/mail/: get: description: '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' operationId: get_characters_character_id_mail parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - $ref: '#/parameters/If-None-Match' - description: Fetch only mails that match one or more of the given labels in: query items: format: int32 minimum: 0 type: integer maxItems: 25 minItems: 1 name: labels required: false type: array uniqueItems: true - description: List only mail with an ID lower than the given ID, if present format: int32 in: query name: last_mail_id type: integer - $ref: '#/parameters/token' responses: '200': description: The requested mail examples: application/json: - from: 90000001 is_read: true labels: - 3 mail_id: 7 recipients: - recipient_id: 90000002 recipient_type: character subject: Title for EVE Mail timestamp: '2015-09-30T16:07:00Z' headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string schema: description: 200 ok array items: description: 200 ok object properties: from: description: From whom the mail was sent format: int32 title: get_characters_character_id_mail_from type: integer is_read: description: is_read boolean title: get_characters_character_id_mail_is_read type: boolean labels: description: labels array items: description: label integer format: int32 title: get_characters_character_id_mail_label type: integer maxItems: 25 minimum: 0 title: get_characters_character_id_mail_labels type: array uniqueItems: true mail_id: description: mail_id integer format: int32 title: get_characters_character_id_mail_mail_id type: integer recipients: description: Recipients of the mail items: description: recipient object properties: recipient_id: description: recipient_id integer format: int32 title: get_characters_character_id_mail_recipient_id type: integer recipient_type: description: recipient_type string enum: - alliance - character - corporation - mailing_list title: get_characters_character_id_mail_recipient_type type: string required: - recipient_type - recipient_id title: get_characters_character_id_mail_recipient type: object maxItems: 52 minItems: 0 title: get_characters_character_id_mail_recipients type: array uniqueItems: true subject: description: Mail subject title: get_characters_character_id_mail_subject type: string timestamp: description: When the mail was sent format: date-time title: get_characters_character_id_mail_timestamp type: string title: get_characters_character_id_mail_200_ok type: object maxItems: 50 title: get_characters_character_id_mail_ok type: array '304': description: Not modified headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.read_mail.v1 summary: Return mail headers tags: - Mail x-alternate-versions: - latest - legacy - v1 x-cached-seconds: 30 post: description: 'Create and send a new mail --- ' operationId: post_characters_character_id_mail parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - description: The mail to send in: body name: mail required: true schema: description: mail object properties: approved_cost: default: 0 description: approved_cost integer format: int64 title: post_characters_character_id_mail_approved_cost type: integer body: description: body string maxLength: 10000 title: post_characters_character_id_mail_body type: string recipients: description: recipients array items: description: recipient object properties: recipient_id: description: recipient_id integer format: int32 title: post_characters_character_id_mail_recipient_id type: integer recipient_type: description: recipient_type string enum: - alliance - character - corporation - mailing_list title: post_characters_character_id_mail_recipient_type type: string required: - recipient_type - recipient_id title: post_characters_character_id_mail_recipient type: object maxItems: 50 minItems: 1 title: post_characters_character_id_mail_recipients type: array subject: description: subject string maxLength: 1000 title: post_characters_character_id_mail_subject type: string required: - recipients - subject - body title: post_characters_character_id_mail_mail type: object - $ref: '#/parameters/token' responses: '201': description: Mail created examples: application/json: 13 schema: description: Mail ID format: int32 title: post_characters_character_id_mail_created type: integer '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' '520': description: Internal error thrown from the EVE server. Most of the time this means you have hit an EVE server rate limit examples: application/json: error: Error 520 message schema: description: Error 520 properties: error: description: Error 520 message title: post_characters_character_id_mail_520_error_520 type: string title: post_characters_character_id_mail_error_520 type: object security: - evesso: - esi-mail.send_mail.v1 summary: Send a new mail tags: - Mail x-alternate-versions: - latest - legacy - v1 /v1/characters/{character_id}/mail/labels/{label_id}/: delete: description: 'Delete a mail label --- ' operationId: delete_characters_character_id_mail_labels_label_id parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - description: An EVE label id format: int32 in: path name: label_id required: true type: integer - $ref: '#/parameters/token' responses: '204': description: Label deleted '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '422': description: Default labels cannot be deleted examples: application/json: error: Unprocessable entity message schema: description: Unprocessable entity properties: error: description: Unprocessable entity message title: delete_characters_character_id_mail_labels_label_id_422_unprocessable_entity type: string title: delete_characters_character_id_mail_labels_label_id_unprocessable_entity type: object '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.organize_mail.v1 summary: Delete a mail label tags: - Mail x-alternate-versions: - latest - legacy - v1 /v1/characters/{character_id}/mail/lists/: get: description: 'Return all mailing lists that the character is subscribed to --- This route is cached for up to 120 seconds' operationId: get_characters_character_id_mail_lists parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - $ref: '#/parameters/If-None-Match' - $ref: '#/parameters/token' responses: '200': description: Mailing lists examples: application/json: - mailing_list_id: 1 name: test_mailing_list headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string schema: description: 200 ok array items: description: 200 ok object properties: mailing_list_id: description: Mailing list ID format: int32 title: get_characters_character_id_mail_lists_mailing_list_id type: integer name: description: name string title: get_characters_character_id_mail_lists_name type: string required: - mailing_list_id - name title: get_characters_character_id_mail_lists_200_ok type: object maxItems: 1000 title: get_characters_character_id_mail_lists_ok type: array '304': description: Not modified headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.read_mail.v1 summary: Return mailing list subscriptions tags: - Mail x-alternate-versions: - latest - legacy - v1 x-cached-seconds: 120 /v1/characters/{character_id}/mail/{mail_id}/: delete: description: 'Delete a mail --- ' operationId: delete_characters_character_id_mail_mail_id parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - description: An EVE mail ID format: int32 in: path name: mail_id required: true type: integer - $ref: '#/parameters/token' responses: '204': description: Mail deleted '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.organize_mail.v1 summary: Delete a mail tags: - Mail x-alternate-versions: - latest - legacy - v1 get: description: 'Return the contents of an EVE mail --- This route is cached for up to 30 seconds' operationId: get_characters_character_id_mail_mail_id parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - $ref: '#/parameters/If-None-Match' - description: An EVE mail ID format: int32 in: path name: mail_id required: true type: integer - $ref: '#/parameters/token' responses: '200': description: Contents of a mail examples: application/json: body: blah blah blah from: 90000001 labels: - 2 - 32 read: true subject: test timestamp: '2015-09-30T16:07:00Z' headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string schema: description: 200 ok object properties: body: description: Mail's body title: get_characters_character_id_mail_mail_id_body type: string from: description: From whom the mail was sent format: int32 title: get_characters_character_id_mail_mail_id_from type: integer labels: description: Labels attached to the mail items: description: label integer format: int32 minimum: 0 title: get_characters_character_id_mail_mail_id_label type: integer uniqueItems: true maxItems: 25 title: get_characters_character_id_mail_mail_id_labels type: array read: description: Whether the mail is flagged as read title: get_characters_character_id_mail_mail_id_read type: boolean recipients: description: Recipients of the mail items: description: recipient object properties: recipient_id: description: recipient_id integer format: int32 title: get_characters_character_id_mail_mail_id_recipient_id type: integer recipient_type: description: recipient_type string enum: - alliance - character - corporation - mailing_list title: get_characters_character_id_mail_mail_id_recipient_type type: string required: - recipient_type - recipient_id title: get_characters_character_id_mail_mail_id_recipient type: object maxItems: 52 minItems: 0 title: get_characters_character_id_mail_mail_id_recipients type: array uniqueItems: true subject: description: Mail subject title: get_characters_character_id_mail_mail_id_subject type: string timestamp: description: When the mail was sent format: date-time title: get_characters_character_id_mail_mail_id_timestamp type: string title: get_characters_character_id_mail_mail_id_ok type: object '304': description: Not modified headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '404': description: Mail not found examples: application/json: error: Not found message schema: description: Not found properties: error: description: Not found message title: get_characters_character_id_mail_mail_id_404_not_found type: string title: get_characters_character_id_mail_mail_id_not_found type: object '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.read_mail.v1 summary: Return a mail tags: - Mail x-alternate-versions: - latest - legacy - v1 x-cached-seconds: 30 put: description: 'Update metadata about a mail --- ' operationId: put_characters_character_id_mail_mail_id parameters: - $ref: '#/parameters/character_id' - description: Data used to update the mail in: body name: contents required: true schema: description: contents object properties: labels: description: Labels to assign to the mail. Pre-existing labels are unassigned. items: description: label integer format: int32 minimum: 0 title: put_characters_character_id_mail_mail_id_label type: integer uniqueItems: true maxItems: 25 title: put_characters_character_id_mail_mail_id_labels type: array read: description: Whether the mail is flagged as read title: put_characters_character_id_mail_mail_id_read type: boolean title: put_characters_character_id_mail_mail_id_contents type: object - $ref: '#/parameters/datasource' - description: An EVE mail ID format: int32 in: path name: mail_id required: true type: integer - $ref: '#/parameters/token' responses: '204': description: Mail updated '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.organize_mail.v1 summary: Update metadata about a mail tags: - Mail x-alternate-versions: - latest - legacy - v1 /v2/characters/{character_id}/mail/labels/: post: description: 'Create a mail label --- ' operationId: post_characters_character_id_mail_labels parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - description: Label to create in: body name: label required: true schema: description: label object properties: color: default: '#ffffff' description: Hexadecimal string representing label color, in RGB format enum: - '#0000fe' - '#006634' - '#0099ff' - '#00ff33' - '#01ffff' - '#349800' - '#660066' - '#666666' - '#999999' - '#99ffff' - '#9a0000' - '#ccff9a' - '#e6e6e6' - '#fe0000' - '#ff6600' - '#ffff01' - '#ffffcd' - '#ffffff' title: post_characters_character_id_mail_labels_color type: string name: description: name string maxLength: 40 minLength: 1 title: post_characters_character_id_mail_labels_name type: string required: - name title: post_characters_character_id_mail_labels_label type: object - $ref: '#/parameters/token' responses: '201': description: Label created examples: application/json: 128 schema: description: Label ID format: int32 title: post_characters_character_id_mail_labels_created type: integer '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.organize_mail.v1 summary: Create a mail label tags: - Mail x-alternate-versions: - latest - legacy - v2 /v3/characters/{character_id}/mail/labels/: get: description: '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' operationId: get_characters_character_id_mail_labels parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - $ref: '#/parameters/If-None-Match' - $ref: '#/parameters/token' responses: '200': description: A list of mail labels and unread counts examples: application/json: labels: - color: '#660066' label_id: 16 name: PINK unread_count: 4 - color: '#ffffff' label_id: 17 name: WHITE unread_count: 1 total_unread_count: 5 headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string schema: description: 200 ok object properties: labels: description: labels array items: description: label object properties: color: default: '#ffffff' description: color string enum: - '#0000fe' - '#006634' - '#0099ff' - '#00ff33' - '#01ffff' - '#349800' - '#660066' - '#666666' - '#999999' - '#99ffff' - '#9a0000' - '#ccff9a' - '#e6e6e6' - '#fe0000' - '#ff6600' - '#ffff01' - '#ffffcd' - '#ffffff' title: get_characters_character_id_mail_labels_color type: string label_id: description: label_id integer format: int32 minimum: 0 title: get_characters_character_id_mail_labels_label_id type: integer name: description: name string maxLength: 40 title: get_characters_character_id_mail_labels_name type: string unread_count: description: unread_count integer format: int32 minimum: 0 title: get_characters_character_id_mail_labels_unread_count type: integer title: get_characters_character_id_mail_labels_label type: object maxItems: 30 title: get_characters_character_id_mail_labels_labels type: array total_unread_count: description: total_unread_count integer format: int32 minimum: 0 title: get_characters_character_id_mail_labels_total_unread_count type: integer title: get_characters_character_id_mail_labels_ok type: object '304': description: Not modified headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.read_mail.v1 summary: Get mail labels and unread counts tags: - Mail x-alternate-versions: - latest - v3 x-cached-seconds: 30 /characters/{character_id}/mail/unread/: get: deprecated: true description: 'Return the number of unread mails for the character --- Alternate route: `/v1/characters/{character_id}/mail/unread/` --- This route is cached for up to 5 seconds --- Warning: This route is deprecated as of 2016-10-10 --- [Diff of the upcoming changes](https://esi.evetech.net/diff/legacy/latest/#GET-/characters/{character_id}/mail/unread/)' operationId: get_characters_character_id_mail_unread parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - $ref: '#/parameters/If-None-Match' - $ref: '#/parameters/token' responses: '200': description: Unread mail count examples: application/json: 5 headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string schema: description: 200 ok integer format: int32 minimum: 0 title: get_characters_character_id_mail_unread_ok type: integer '304': description: Not modified headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.read_mail.v1 summary: Return the number of unread mails tags: - Mail x-alternate-versions: - v1 x-cached-seconds: 5 /v1/characters/{character_id}/mail/unread/: get: deprecated: true description: 'Return the number of unread mails for the character --- This route is cached for up to 5 seconds --- Warning: This route is deprecated as of 2016-10-10 --- [Diff of the upcoming changes](https://esi.evetech.net/diff/legacy/latest/#GET-/characters/{character_id}/mail/unread/)' operationId: get_characters_character_id_mail_unread parameters: - $ref: '#/parameters/character_id' - $ref: '#/parameters/datasource' - $ref: '#/parameters/If-None-Match' - $ref: '#/parameters/token' responses: '200': description: Unread mail count examples: application/json: 5 headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string schema: description: 200 ok integer format: int32 minimum: 0 title: get_characters_character_id_mail_unread_ok type: integer '304': description: Not modified headers: Cache-Control: description: The caching mechanism used type: string ETag: description: RFC7232 compliant entity tag type: string Expires: description: RFC7231 formatted datetime string type: string Last-Modified: description: RFC7231 formatted datetime string type: string '400': description: Bad request examples: application/json: error: Bad request message schema: $ref: '#/definitions/bad_request' '401': description: Unauthorized examples: application/json: error: Unauthorized message schema: $ref: '#/definitions/unauthorized' '403': description: Forbidden examples: application/json: error: Forbidden message schema: $ref: '#/definitions/forbidden' '420': description: Error limited examples: application/json: error: Error limited message schema: $ref: '#/definitions/error_limited' '500': description: Internal server error examples: application/json: error: Internal server error message schema: $ref: '#/definitions/internal_server_error' '503': description: Service unavailable examples: application/json: error: Service unavailable message schema: $ref: '#/definitions/service_unavailable' '504': description: Gateway timeout examples: application/json: error: Gateway timeout message schema: $ref: '#/definitions/gateway_timeout' security: - evesso: - esi-mail.read_mail.v1 summary: Return the number of unread mails tags: - Mail x-alternate-versions: - v1 x-cached-seconds: 5 components: schemas: internal_server_error: description: Internal server error model properties: error: description: Internal server error message type: string example: example required: - error title: Internal server error type: object forbidden: description: Forbidden model properties: error: description: Forbidden message type: string example: example sso_status: description: status code received from SSO type: integer example: 1 required: - error title: Forbidden type: object service_unavailable: description: Service unavailable model properties: error: description: Service unavailable message type: string example: example required: - error title: Service unavailable type: object bad_request: description: Bad request model properties: error: description: Bad request message type: string example: example required: - error title: Bad request type: object unauthorized: description: Unauthorized model properties: error: description: Unauthorized message type: string example: example required: - error title: Unauthorized type: object gateway_timeout: description: Gateway timeout model properties: error: description: Gateway timeout message type: string example: example timeout: description: number of seconds the request was given type: integer example: 1 required: - error title: Gateway timeout type: object error_limited: description: Error limited model properties: error: description: Error limited message type: string example: example required: - error title: Error limited type: object parameters: datasource: description: The server name you would like data from in: query name: datasource schema: type: string enum: - tranquility default: tranquility character_id: description: An EVE character ID in: path name: character_id required: true schema: type: integer format: int32 minimum: 1 token: description: Access token to use if unable to set a header in: query name: token schema: type: string If-None-Match: description: ETag from a previous request. A 304 will be returned if this matches the current ETag in: header name: If-None-Match schema: type: string securitySchemes: evesso: type: oauth2 flows: implicit: authorizationUrl: https://login.eveonline.com/v2/oauth/authorize scopes: esi-alliances.read_contacts.v1: EVE SSO scope esi-alliances.read_contacts.v1 esi-assets.read_assets.v1: EVE SSO scope esi-assets.read_assets.v1 esi-assets.read_corporation_assets.v1: EVE SSO scope esi-assets.read_corporation_assets.v1 esi-calendar.read_calendar_events.v1: EVE SSO scope esi-calendar.read_calendar_events.v1 esi-calendar.respond_calendar_events.v1: EVE SSO scope esi-calendar.respond_calendar_events.v1 esi-characters.read_agents_research.v1: EVE SSO scope esi-characters.read_agents_research.v1 esi-characters.read_blueprints.v1: EVE SSO scope esi-characters.read_blueprints.v1 esi-characters.read_contacts.v1: EVE SSO scope esi-characters.read_contacts.v1 esi-characters.read_corporation_roles.v1: EVE SSO scope esi-characters.read_corporation_roles.v1 esi-characters.read_fatigue.v1: EVE SSO scope esi-characters.read_fatigue.v1 esi-characters.read_fw_stats.v1: EVE SSO scope esi-characters.read_fw_stats.v1 esi-characters.read_loyalty.v1: EVE SSO scope esi-characters.read_loyalty.v1 esi-characters.read_medals.v1: EVE SSO scope esi-characters.read_medals.v1 esi-characters.read_notifications.v1: EVE SSO scope esi-characters.read_notifications.v1 esi-characters.read_standings.v1: EVE SSO scope esi-characters.read_standings.v1 esi-characters.read_titles.v1: EVE SSO scope esi-characters.read_titles.v1 esi-characters.write_contacts.v1: EVE SSO scope esi-characters.write_contacts.v1 esi-clones.read_clones.v1: EVE SSO scope esi-clones.read_clones.v1 esi-clones.read_implants.v1: EVE SSO scope esi-clones.read_implants.v1 esi-contracts.read_character_contracts.v1: EVE SSO scope esi-contracts.read_character_contracts.v1 esi-contracts.read_corporation_contracts.v1: EVE SSO scope esi-contracts.read_corporation_contracts.v1 esi-corporations.read_blueprints.v1: EVE SSO scope esi-corporations.read_blueprints.v1 esi-corporations.read_contacts.v1: EVE SSO scope esi-corporations.read_contacts.v1 esi-corporations.read_container_logs.v1: EVE SSO scope esi-corporations.read_container_logs.v1 esi-corporations.read_corporation_membership.v1: EVE SSO scope esi-corporations.read_corporation_membership.v1 esi-corporations.read_divisions.v1: EVE SSO scope esi-corporations.read_divisions.v1 esi-corporations.read_facilities.v1: EVE SSO scope esi-corporations.read_facilities.v1 esi-corporations.read_fw_stats.v1: EVE SSO scope esi-corporations.read_fw_stats.v1 esi-corporations.read_medals.v1: EVE SSO scope esi-corporations.read_medals.v1 esi-corporations.read_standings.v1: EVE SSO scope esi-corporations.read_standings.v1 esi-corporations.read_starbases.v1: EVE SSO scope esi-corporations.read_starbases.v1 esi-corporations.read_structures.v1: EVE SSO scope esi-corporations.read_structures.v1 esi-corporations.read_titles.v1: EVE SSO scope esi-corporations.read_titles.v1 esi-corporations.track_members.v1: EVE SSO scope esi-corporations.track_members.v1 esi-fittings.read_fittings.v1: EVE SSO scope esi-fittings.read_fittings.v1 esi-fittings.write_fittings.v1: EVE SSO scope esi-fittings.write_fittings.v1 esi-fleets.read_fleet.v1: EVE SSO scope esi-fleets.read_fleet.v1 esi-fleets.write_fleet.v1: EVE SSO scope esi-fleets.write_fleet.v1 esi-industry.read_character_jobs.v1: EVE SSO scope esi-industry.read_character_jobs.v1 esi-industry.read_character_mining.v1: EVE SSO scope esi-industry.read_character_mining.v1 esi-industry.read_corporation_jobs.v1: EVE SSO scope esi-industry.read_corporation_jobs.v1 esi-industry.read_corporation_mining.v1: EVE SSO scope esi-industry.read_corporation_mining.v1 esi-killmails.read_corporation_killmails.v1: EVE SSO scope esi-killmails.read_corporation_killmails.v1 esi-killmails.read_killmails.v1: EVE SSO scope esi-killmails.read_killmails.v1 esi-location.read_location.v1: EVE SSO scope esi-location.read_location.v1 esi-location.read_online.v1: EVE SSO scope esi-location.read_online.v1 esi-location.read_ship_type.v1: EVE SSO scope esi-location.read_ship_type.v1 esi-mail.organize_mail.v1: EVE SSO scope esi-mail.organize_mail.v1 esi-mail.read_mail.v1: EVE SSO scope esi-mail.read_mail.v1 esi-mail.send_mail.v1: EVE SSO scope esi-mail.send_mail.v1 esi-markets.read_character_orders.v1: EVE SSO scope esi-markets.read_character_orders.v1 esi-markets.read_corporation_orders.v1: EVE SSO scope esi-markets.read_corporation_orders.v1 esi-markets.structure_markets.v1: EVE SSO scope esi-markets.structure_markets.v1 esi-planets.manage_planets.v1: EVE SSO scope esi-planets.manage_planets.v1 esi-planets.read_customs_offices.v1: EVE SSO scope esi-planets.read_customs_offices.v1 esi-search.search_structures.v1: EVE SSO scope esi-search.search_structures.v1 esi-skills.read_skillqueue.v1: EVE SSO scope esi-skills.read_skillqueue.v1 esi-skills.read_skills.v1: EVE SSO scope esi-skills.read_skills.v1 esi-ui.open_window.v1: EVE SSO scope esi-ui.open_window.v1 esi-ui.write_waypoint.v1: EVE SSO scope esi-ui.write_waypoint.v1 esi-universe.read_structures.v1: EVE SSO scope esi-universe.read_structures.v1 esi-wallet.read_character_wallet.v1: EVE SSO scope esi-wallet.read_character_wallet.v1 esi-wallet.read_corporation_wallets.v1: EVE SSO scope esi-wallet.read_corporation_wallets.v1 definitions: internal_server_error: description: Internal server error model properties: error: description: Internal server error message type: string required: - error title: Internal server error type: object error_limited: description: Error limited model properties: error: description: Error limited message type: string required: - error title: Error limited type: object unauthorized: description: Unauthorized model properties: error: description: Unauthorized message type: string required: - error title: Unauthorized type: object service_unavailable: description: Service unavailable model properties: error: description: Service unavailable message type: string required: - error title: Service unavailable type: object forbidden: description: Forbidden model properties: error: description: Forbidden message type: string sso_status: description: status code received from SSO type: integer required: - error title: Forbidden type: object bad_request: description: Bad request model properties: error: description: Bad request message type: string required: - error title: Bad request type: object gateway_timeout: description: Gateway timeout model properties: error: description: Gateway timeout message type: string timeout: description: number of seconds the request was given type: integer required: - error title: Gateway timeout type: object parameters: token: description: Access token to use if unable to set a header in: query name: token type: string If-None-Match: description: ETag from a previous request. A 304 will be returned if this matches the current ETag in: header name: If-None-Match type: string datasource: default: tranquility description: The server name you would like data from enum: - tranquility in: query name: datasource type: string character_id: description: An EVE character ID format: int32 in: path minimum: 1 name: character_id required: true type: integer