MailManager / Client / get_archive_search_results

get_archive_search_results#

MailManager.Client.get_archive_search_results(**kwargs)#

Returns the results of a completed email archive search job.

See also: AWS API Documentation

Request Syntax

response = client.get_archive_search_results(
    SearchId='string'
)
Parameters:

SearchId (string) –

[REQUIRED]

The identifier of the completed search job.

Return type:

dict

Returns:

Response Syntax

{
    'Rows': [
        {
            'ArchivedMessageId': 'string',
            'Cc': 'string',
            'Date': 'string',
            'Envelope': {
                'From': 'string',
                'Helo': 'string',
                'To': [
                    'string',
                ]
            },
            'From': 'string',
            'HasAttachments': True|False,
            'InReplyTo': 'string',
            'IngressPointId': 'string',
            'MessageId': 'string',
            'ReceivedHeaders': [
                'string',
            ],
            'ReceivedTimestamp': datetime(2015, 1, 1),
            'SenderHostname': 'string',
            'SenderIpAddress': 'string',
            'Subject': 'string',
            'To': 'string',
            'XMailer': 'string',
            'XOriginalMailer': 'string',
            'XPriority': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    The response containing search results from a completed archive search.

    • Rows (list) –

      The list of email result objects matching the search criteria.

      • (dict) –

        A result row containing metadata for an archived email message.

        • ArchivedMessageId (string) –

          The unique identifier of the archived message.

        • Cc (string) –

          The email addresses in the CC header.

        • Date (string) –

          The date the email was sent.

        • Envelope (dict) –

          The SMTP envelope information of the email.

          • From (string) –

            The RCPT FROM given by the host from which the email was received.

          • Helo (string) –

            The HELO used by the host from which the email was received.

          • To (list) –

            All SMTP TO entries given by the host from which the email was received.

            • (string) –

        • From (string) –

          The email address of the sender.

        • HasAttachments (boolean) –

          A flag indicating if the email has attachments.

        • InReplyTo (string) –

          The email message ID this is a reply to.

        • IngressPointId (string) –

          The ID of the ingress endpoint through which the email was received.

        • MessageId (string) –

          The unique message ID of the email.

        • ReceivedHeaders (list) –

          The received headers from the email delivery path.

          • (string) –

        • ReceivedTimestamp (datetime) –

          The timestamp of when the email was received.

        • SenderHostname (string) –

          The name of the host from which the email was received.

        • SenderIpAddress (string) –

          The IP address of the host from which the email was received.

        • Subject (string) –

          The subject header value of the email.

        • To (string) –

          The email addresses in the To header.

        • XMailer (string) –

          The user agent that sent the email.

        • XOriginalMailer (string) –

          The original user agent that sent the email.

        • XPriority (string) –

          The priority level of the email.

Exceptions

  • MailManager.Client.exceptions.ValidationException

  • MailManager.Client.exceptions.AccessDeniedException

  • MailManager.Client.exceptions.ConflictException

  • MailManager.Client.exceptions.ThrottlingException