Skip to content

StartArchiveSearchRequest

Source code in docs_src/capo_mailmanager/types/start_archive_search_request.py 
17
18
19
20
21
22
23
24
25
26
27
class StartArchiveSearchRequest(TypedDict, closed=True):
    archive_id: "capo_mailmanager.types.archive_id.ArchiveId"
    """<p>The identifier of the archive to search emails in.</p>"""
    filters: NotRequired["capo_mailmanager.types.archive_filters.ArchiveFilters"]
    """<p>Criteria to filter which emails are included in the search results.</p>"""
    from_timestamp: "datetime.datetime"
    """<p>The start timestamp of the range to search emails from.</p>"""
    to_timestamp: "datetime.datetime"
    """<p>The end timestamp of the range to search emails from.</p>"""
    max_results: "capo_mailmanager.types.search_max_results.SearchMaxResults"
    """<p>The maximum number of search results to return.</p>"""

archive_id instance-attribute 

archive_id: ArchiveId

The identifier of the archive to search emails in.

filters instance-attribute 

filters: NotRequired[ArchiveFilters]

Criteria to filter which emails are included in the search results.

from_timestamp instance-attribute 

from_timestamp: datetime

The start timestamp of the range to search emails from.

max_results instance-attribute 

max_results: SearchMaxResults

The maximum number of search results to return.

to_timestamp instance-attribute 

to_timestamp: datetime

The end timestamp of the range to search emails from.