2025/02/19 - MailManager - 2 updated api methods
Changes This release adds additional metadata fields in Mail Manager archive searches to show email source and details about emails that were archived when being sent with SES.
{'Metadata': {'ConfigurationSet': 'string',
'SendingMethod': 'string',
'SendingPool': 'string',
'SourceArn': 'string',
'SourceIdentity': 'string'}}
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
client.get_archive_message(
ArchivedMessageId='string'
)
string
[REQUIRED]
The unique identifier of the archived email message.
dict
Response Syntax
{
'Envelope': {
'From': 'string',
'Helo': 'string',
'To': [
'string',
]
},
'MessageDownloadLink': 'string',
'Metadata': {
'ConfigurationSet': 'string',
'IngressPointId': 'string',
'RuleSetId': 'string',
'SenderHostname': 'string',
'SenderIpAddress': 'string',
'SendingMethod': 'string',
'SendingPool': 'string',
'SourceArn': 'string',
'SourceIdentity': '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.
ConfigurationSet (string) --
The name of the configuration set used when sent through a configuration set with archiving enabled.
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.
SendingMethod (string) --
The name of the API call used 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.
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.
SourceIdentity (string) --
The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.
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.
{'Rows': {'SourceArn': 'string'}}
Returns the results of a completed email archive search job.
See also: AWS API Documentation
Request Syntax
client.get_archive_search_results(
SearchId='string'
)
string
[REQUIRED]
The identifier of the completed search job.
dict
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',
'SourceArn': '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) --
Mail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint.
Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call.
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.
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.