Skip to content

GetArchiveSearchResponse

Source code in docs_src/capo_mailmanager/types/get_archive_search_response.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class GetArchiveSearchResponse(TypedDict, closed=True):
    archive_id: NotRequired["capo_mailmanager.types.archive_id.ArchiveId"]
    """<p>The identifier of the archive the email search was performed in.</p>"""
    filters: NotRequired["capo_mailmanager.types.archive_filters.ArchiveFilters"]
    """<p>The criteria used to filter emails included in the search.</p>"""
    from_timestamp: NotRequired["datetime.datetime"]
    """<p>The start timestamp of the range the searched emails cover.</p>"""
    to_timestamp: NotRequired["datetime.datetime"]
    """<p>The end timestamp of the range the searched emails cover.</p>"""
    max_results: NotRequired[
        "capo_mailmanager.types.search_max_results.SearchMaxResults"
    ]
    """<p>The maximum number of search results to return.</p>"""
    status: NotRequired["capo_mailmanager.types.search_status.SearchStatus"]
    """<p>The current status of the search job.</p>"""

archive_id instance-attribute 

archive_id: NotRequired[ArchiveId]

The identifier of the archive the email search was performed in.

filters instance-attribute 

filters: NotRequired[ArchiveFilters]

The criteria used to filter emails included in the search.

from_timestamp instance-attribute 

from_timestamp: NotRequired[datetime]

The start timestamp of the range the searched emails cover.

max_results instance-attribute 

max_results: NotRequired[SearchMaxResults]

The maximum number of search results to return.

status instance-attribute 

status: NotRequired[SearchStatus]

The current status of the search job.

to_timestamp instance-attribute 

to_timestamp: NotRequired[datetime]

The end timestamp of the range the searched emails cover.