MailManager / Client / get_archive_message

get_archive_message#

MailManager.Client.get_archive_message(**kwargs)#

Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.

See also: AWS API Documentation

Request Syntax

response = client.get_archive_message(
    ArchivedMessageId='string'
)
Parameters:

ArchivedMessageId (string) –

[REQUIRED]

The unique identifier of the archived email message.

Return type:

dict

Returns:

Response Syntax

{
    'Envelope': {
        'From': 'string',
        'Helo': 'string',
        'To': [
            'string',
        ]
    },
    'MessageDownloadLink': 'string',
    'Metadata': {
        'IngressPointId': 'string',
        'RuleSetId': 'string',
        'SenderHostname': 'string',
        'SenderIpAddress': 'string',
        'Timestamp': datetime(2015, 1, 1),
        'TlsCipherSuite': 'string',
        'TlsProtocol': 'string',
        'TrafficPolicyId': 'string'
    }
}

Response Structure

  • (dict) –

    The response containing details about the requested archived email message.

    • 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) –

    • MessageDownloadLink (string) –

      A pre-signed URL to temporarily download the full message content.

    • Metadata (dict) –

      The metadata about the email.

      • IngressPointId (string) –

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

      • RuleSetId (string) –

        The ID of the rule set that processed the email.

      • 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.

      • Timestamp (datetime) –

        The timestamp of when the email was received.

      • TlsCipherSuite (string) –

        The TLS cipher suite used to communicate with the host from which the email was received.

      • TlsProtocol (string) –

        The TLS protocol used to communicate with the host from which the email was received.

      • TrafficPolicyId (string) –

        The ID of the traffic policy that was in effect when the email was received.

Exceptions