EVECelery.tasks.ESI.Mail.get_characters_character_id_mail#

A task definition module with associated response models returned by the task.

This module was automatically generated from Jinja templates with the codegen tool included in the root of this repo. You should not directly modify this module but instead modify the template ‘codegen/Templates/ESI_Task.py’.

Module Contents#

Classes#

get_characters_character_id_mail

Return mail headers

class EVECelery.tasks.ESI.Mail.get_characters_character_id_mail.get_characters_character_id_mail#

Bases: EVECelery.tasks.BaseTasks.TaskESI.TaskESI

Return mail headers

request_method() str#

Returns the type of request made to ESI

This method will return the request method (get, post, etc.) made to ESI.

Returns:

Request method passed to requests.request()

Return type:

str

route(character_id: int, **kwargs) str#

ESI route with input request parameters

Parameters:

character_id (int) – An EVE character ID

Returns:

ESI route with request path parameters if any

Return type:

str

cache_ttl_default() int#

TTL for when cache is unspecified.

Returns:

The number of seconds to cache a response

Return type:

int

get_sync(character_id: int, datasource: str = 'tranquility', labels: list[int] | None = None, last_mail_id: int | None = None, token: str | None = None, kwargs_apply_async: dict | None = None, kwargs_get: dict | None = None) EVECelery.tasks.ESI.Mail.Models.get_characters_character_id_mail_200.Response200_get_characters_character_id_mail#

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

NOTE: This function calls the task and blocks until the result is available. This function is a wrapper around Celery’s task.apply_async() and AsyncResult.get() methods. Instead of a dictionary, this function returns a pydantic model to more easily see what returned data responses look like, what is optionally returned, etc.

If you would instead like to return an async result, use Celery’s apply_async() method on this task.

Parameters:
  • character_id (int) – An EVE character ID

  • datasource (str) – The server name you would like data from – [‘tranquility’]

  • labels (list[int] | None) – Fetch only mails that match one or more of the given labels

  • last_mail_id (int | None) – List only mail with an ID lower than the given ID, if present

  • token (str | None) – Access token to use if unable to set a header

  • kwargs_apply_async (Optional[dict]) –

    Dictionary of keyword arguments passed to task.apply_async()

  • kwargs_get (Optional[dict]) –

    Dictionary of keyword arguments passed to AsyncResult.get()

Returns:

The response from ESI as a pydantic object. The response model will follow the structure of Response200_get_characters_character_id_mail.

Return type:

Union[EVECelery.tasks.ESI.Mail.Models.get_characters_character_id_mail_200.Response200_get_characters_character_id_mail]

run(character_id: int, datasource: str = 'tranquility', labels: list[int] | None = None, last_mail_id: int | None = None, token: str | None = None, **kwargs) dict#

The task body that runs on the EVECelery worker

This is the task body that runs on the EVECelery worker.

IMPORTANT NOTE: You should not directly call this function from your client code as it will run within the context of your client and won’t be sent to the message broker to run on a worker node. To correctly call this task body, see Celery’s documentation on methods for calling tasks.

See also this task’s get_sync() which is a wrapper function around Celery’s apply_async().get() call.

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

Parameters:
  • character_id (int) – An EVE character ID

  • datasource (str) – The server name you would like data from – [‘tranquility’]

  • labels (list[int] | None) – Fetch only mails that match one or more of the given labels

  • last_mail_id (int | None) – List only mail with an ID lower than the given ID, if present

  • token (str | None) – Access token to use if unable to set a header

Returns:

The response from ESI as a JSON dictionary. The response dictionary will follow the structure of Response200_get_characters_character_id_mail.

Return type:

dict