Skip to content

SearchStatus

Source code in docs_src/capo_mailmanager/types/search_status.py
class SearchStatus(TypedDict, closed=True):
    submission_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the search was submitted.</p>"""
    completion_timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the search completed (if finished).</p>"""
    state: NotRequired["capo_mailmanager.types.search_state.SearchState"]
    """<p>The current state of the search job.</p>"""
    error_message: NotRequired["capo_mailmanager.types.error_message.ErrorMessage"]
    """<p>An error message if the search failed.</p>"""

completion_timestamp instance-attribute

completion_timestamp: NotRequired[datetime]

The timestamp of when the search completed (if finished).

error_message instance-attribute

error_message: NotRequired[ErrorMessage]

An error message if the search failed.

state instance-attribute

state: NotRequired[SearchState]

The current state of the search job.

submission_timestamp instance-attribute

submission_timestamp: NotRequired[datetime]

The timestamp of when the search was submitted.