/characters/{character_id}/mail/

12 сентября 2021, 03:36 UTC - Методы - API игры EVE Online

Эта статья пока что переведена не полностью, и могут встречаться обширные участки текста на английском языке.

(Текущая версия ESI: 1.21)

Return mail headers; Send a new mail

`GET` /characters/{character_id}/mail/

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

Этот метод кэшируется. Время жизни кэша: 30 секунд.

Требуемые разрешения

esi-mail.read_mail.v1

Адреса URL

Главный и версионированные адреса.

https://esi.evetech.net/latest/characters/{character_id}/mail/
https://esi.evetech.net/dev/characters/{character_id}/mail/
https://esi.evetech.net/legacy/characters/{character_id}/mail/
https://esi.evetech.net/v1/characters/{character_id}/mail/

Параметры

Название	Тип	Позиция	Описание
character_id (Обязательный)	integer	URL	Идентификатор (ID) персонажа Минимальное значение: 1
datasource	string	GET-параметр	Название сервера, для которого вы хотите получать данные Допустимые значения: tranquility Значение по-умолчанию: `tranquility`
If-None-Match	string	HTTP-заголовок	ETag из предыдущего запроса. Если он совпадает с предполагаемым ETag ответа сервера, возвращается ответ с кодом 304
labels	array of integers	GET-параметр	Fetch only mails that match one or more of the given labels Количество элементов: от 1 до 25 Все элементы должны иметь уникальное значение
last_mail_id	integer	GET-параметр	List only mail with an ID lower than the given ID, if present
token	string	GET-параметр	Токен доступа, если нет возможности установить его в хэдерах HTTP-запроса

Ответы сервера

ESI задаёт тип ответа сервера с помощью кодов HTTP. Например, для большинства запросов возвращается ответ с кодом 200 в заголовках HTTP, что в самом протоколе HTTP подразумевает успешный ответ. Так же, иногда ESI присылает в ответе дополнительные заголовки HTTP, на которые нужно обращать внимание. Список таких заголовков приводится в разделе «Заголовки HTTP».

200 The requested mail

The requested mail

Заголовки HTTP

Cache-Control
The caching mechanism used
ETag
RFC7232 compliant entity tag
Expires
RFC7231 formatted datetime string
Last-Modified
RFC7231 formatted datetime string

Пример:

[
    {
        "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"
    }
]

Структура

Тип данных: array of Item #1

Item #1

Тип: object. Поля:

frominteger
From whom the mail was sent
is_readboolean
is_read boolean
labelsarray of integers
labels array
Минимальное значение: 0
Максимальное количество элементов: 25
Все элементы должны иметь уникальное значение
mail_idinteger
mail_id integer
recipientsarray of Item #2
Recipients of the mail
Количество элементов: от 0 до 52
Все элементы должны иметь уникальное значение
subjectstring
Mail subject
timestampstring
When the mail was sent

Item #2

Тип: object. Поля:

recipient_idinteger
recipient_id integer
recipient_typestring
recipient_type string
Допустимые значения:
- alliance
- character
- corporation
- mailing_list

304 Без изменений (Not modified)

Без изменений (Not modified)

Заголовки HTTP

Cache-Control
The caching mechanism used
ETag
RFC7232 compliant entity tag
Expires
RFC7231 formatted datetime string
Last-Modified
RFC7231 formatted datetime string

400 Неправильный запрос (Bad request)

Неправильный запрос (Bad request)

Пример:

{
    "error": "Bad request message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

401 Требуется авторизация (Unauthorized)

Требуется авторизация (Unauthorized)

Пример:

{
    "error": "Unauthorized message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

403 Нет доступа (Forbidden)

Нет доступа (Forbidden)

Пример:

{
    "error": "Forbidden message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки
sso_statusinteger
Код статуса из SSO

420 Лимит исчерпан (Error limited)

Лимит исчерпан (Error limited)

Пример:

{
    "error": "Error limited message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

500 Внутренняя ошибка сервера (Internal server error)

Внутренняя ошибка сервера (Internal server error)

Пример:

{
    "error": "Internal server error message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

503 Сервис недоступен (Service unavailable)

Сервис недоступен (Service unavailable)

Пример:

{
    "error": "Service unavailable message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

504 Сервер не отвечает (Gateway timeout)

Сервер не отвечает (Gateway timeout)

Пример:

{
    "error": "Gateway timeout message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки
timeoutinteger
Количество секунд, потраченные на ожидание ответа

`POST` /characters/{character_id}/mail/

Create and send a new mail

Требуемые разрешения

esi-mail.send_mail.v1

Адреса URL

Главный и версионированные адреса.

https://esi.evetech.net/latest/characters/{character_id}/mail/
https://esi.evetech.net/dev/characters/{character_id}/mail/
https://esi.evetech.net/legacy/characters/{character_id}/mail/
https://esi.evetech.net/v1/characters/{character_id}/mail/

Параметры

Название	Тип	Позиция	Описание
character_id (Обязательный)	integer	URL	Идентификатор (ID) персонажа Минимальное значение: 1
mail (Обязательный)	Item #1	Тело запроса	The mail to send
datasource	string	GET-параметр	Название сервера, для которого вы хотите получать данные Допустимые значения: tranquility Значение по-умолчанию: `tranquility`
token	string	GET-параметр	Токен доступа, если нет возможности установить его в хэдерах HTTP-запроса

Item #1

Тип: object. Поля:

Название	Тип	Описание
body (Обязательный)	string	body string Максимальное количество символов: 10 000
recipients (Обязательный)	array of Item #2	recipients array Количество элементов: от 1 до 50
subject (Обязательный)	string	subject string Максимальное количество символов: 1 000
approved_cost	integer	approved_cost integer Значение по-умолчанию: `0`

Item #2

Тип: object. Поля:

Название	Тип	Описание
recipient_id (Обязательный)	integer	recipient_id integer
recipient_type (Обязательный)	string	recipient_type string Допустимые значения: alliance character corporation mailing_list

Ответы сервера

201 Mail created

Mail created

Пример:

Структура

Тип данных: integer

400 Неправильный запрос (Bad request)

Неправильный запрос (Bad request)

Пример:

{
    "error": "Bad request message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

401 Требуется авторизация (Unauthorized)

Требуется авторизация (Unauthorized)

Пример:

{
    "error": "Unauthorized message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

403 Нет доступа (Forbidden)

Нет доступа (Forbidden)

Пример:

{
    "error": "Forbidden message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки
sso_statusinteger
Код статуса из SSO

420 Лимит исчерпан (Error limited)

Лимит исчерпан (Error limited)

Пример:

{
    "error": "Error limited message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

500 Внутренняя ошибка сервера (Internal server error)

Внутренняя ошибка сервера (Internal server error)

Пример:

{
    "error": "Internal server error message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

503 Сервис недоступен (Service unavailable)

Сервис недоступен (Service unavailable)

Пример:

{
    "error": "Service unavailable message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки

504 Сервер не отвечает (Gateway timeout)

Сервер не отвечает (Gateway timeout)

Пример:

{
    "error": "Gateway timeout message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Детали ошибки
timeoutinteger
Количество секунд, потраченные на ожидание ответа

520 Внутренняя ошибка сервера EVE Online

Внутренняя ошибка сервера EVE Online

Пример:

{
    "error": "Error 520 message"
}

Структура

Тип данных: Item #1

Item #1

Тип: object. Поля:

errorstring
Error 520 message

GET /characters/{character_id}/mail/

Требуемые разрешения

Адреса URL

Параметры

Ответы сервера

Заголовки HTTP

Пример:

Структура

Item #1

Item #2

Заголовки HTTP

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

POST /characters/{character_id}/mail/

Требуемые разрешения

Адреса URL

Параметры

Item #1

Item #2

Ответы сервера

Пример:

Структура

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

Пример:

Структура

Item #1

`GET` /characters/{character_id}/mail/

`POST` /characters/{character_id}/mail/