Skip to content

StartArchiveExportRequest

Source code in docs_src/capo_mailmanager/types/start_archive_export_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class StartArchiveExportRequest(TypedDict, closed=True):
    archive_id: "capo_mailmanager.types.archive_id.ArchiveId"
    """<p>The identifier of the archive to export emails from.</p>"""
    filters: NotRequired["capo_mailmanager.types.archive_filters.ArchiveFilters"]
    """<p>Criteria to filter which emails are included in the export.</p>"""
    from_timestamp: "datetime.datetime"
    """<p>The start of the timestamp range to include emails from.</p>"""
    to_timestamp: "datetime.datetime"
    """<p>The end of the timestamp range to include emails from.</p>"""
    max_results: NotRequired[
        "capo_mailmanager.types.export_max_results.ExportMaxResults"
    ]
    """<p>The maximum number of email items to include in the export.</p>"""
    export_destination_configuration: "capo_mailmanager.types.export_destination_configuration.ExportDestinationConfiguration"
    """<p>Details on where to deliver the exported email data.</p>"""
    include_metadata: NotRequired["bool"]
    """<p>Whether to include message metadata as JSON files in the export.</p>"""

archive_id instance-attribute 

archive_id: ArchiveId

The identifier of the archive to export emails from.

export_destination_configuration instance-attribute 

export_destination_configuration: ExportDestinationConfiguration

Details on where to deliver the exported email data.

filters instance-attribute 

filters: NotRequired[ArchiveFilters]

Criteria to filter which emails are included in the export.

from_timestamp instance-attribute 

from_timestamp: datetime

The start of the timestamp range to include emails from.

include_metadata instance-attribute 

include_metadata: NotRequired[bool]

Whether to include message metadata as JSON files in the export.

max_results instance-attribute 

max_results: NotRequired[ExportMaxResults]

The maximum number of email items to include in the export.

to_timestamp instance-attribute 

to_timestamp: datetime

The end of the timestamp range to include emails from.