:doc:`MailManager <../../mailmanager>` / Client / get_archive_message

*******************
get_archive_message
*******************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/GetArchiveMessage>`_  


  **Request Syntax**
  ::

    response = client.get_archive_message(
        ArchivedMessageId='string'
    )
    
  :type ArchivedMessageId: string
  :param ArchivedMessageId: **[REQUIRED]** 

    The unique identifier of the archived email message.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'MessageDownloadLink': 'string',
          'Metadata': {
              'Timestamp': datetime(2015, 1, 1),
              'IngressPointId': 'string',
              'TrafficPolicyId': 'string',
              'RuleSetId': 'string',
              'SenderHostname': 'string',
              'SenderIpAddress': 'string',
              'TlsCipherSuite': 'string',
              'TlsProtocol': 'string',
              'SendingMethod': 'string',
              'SourceIdentity': 'string',
              'SendingPool': 'string',
              'ConfigurationSet': 'string',
              'SourceArn': 'string'
          },
          'Envelope': {
              'Helo': 'string',
              'From': 'string',
              'To': [
                  'string',
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The response containing details about the requested archived email message.

      
      

      - **MessageDownloadLink** *(string) --* 

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

        
      

      - **Metadata** *(dict) --* 

        The metadata about the email.

        
        

        - **Timestamp** *(datetime) --* 

          The timestamp of when the email was received.

          
        

        - **IngressPointId** *(string) --* 

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

          
        

        - **TrafficPolicyId** *(string) --* 

          The ID of the traffic policy that was in effect when 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.

          
        

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

          
        

        - **SendingMethod** *(string) --* 

          The name of the API call used when sent through a configuration set with archiving enabled.

          
        

        - **SourceIdentity** *(string) --* 

          The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.

          
        

        - **SendingPool** *(string) --* 

          The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.

          
        

        - **ConfigurationSet** *(string) --* 

          The name of the configuration set used when sent through a configuration set with archiving enabled.

          
        

        - **SourceArn** *(string) --* 

          Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.

          
    
      

      - **Envelope** *(dict) --* 

        The SMTP envelope information of the email.

        
        

        - **Helo** *(string) --* 

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

          
        

        - **From** *(string) --* 

          The RCPT FROM given 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) --* 
      
    
  
  **Exceptions**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

  
  *   :py:class:`MailManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MailManager.Client.exceptions.ThrottlingException`

  