Skip to content

Metadata

Source code in docs_src/capo_mailmanager/types/metadata.py
class Metadata(TypedDict, closed=True):
    timestamp: NotRequired["datetime.datetime"]
    """<p>The timestamp of when the email was received.</p>"""
    ingress_point_id: NotRequired[
        "capo_mailmanager.types.ingress_point_id.IngressPointId"
    ]
    """<p>The ID of the ingress endpoint through which the email was received.</p>"""
    traffic_policy_id: NotRequired[
        "capo_mailmanager.types.traffic_policy_id.TrafficPolicyId"
    ]
    """<p>The ID of the traffic policy that was in effect when the email was received.</p>"""
    rule_set_id: NotRequired["capo_mailmanager.types.rule_set_id.RuleSetId"]
    """<p>The ID of the rule set that processed the email.</p>"""
    sender_hostname: NotRequired["str"]
    """<p>The name of the host from which the email was received.</p>"""
    sender_ip_address: NotRequired[
        "capo_mailmanager.types.sender_ip_address.SenderIpAddress"
    ]
    """<p>The IP address of the host from which the email was received.</p>"""
    tls_cipher_suite: NotRequired["str"]
    """<p>The TLS cipher suite used to communicate with the host from which the email was received.</p>"""
    tls_protocol: NotRequired["str"]
    """<p>The TLS protocol used to communicate with the host from which the email was received.</p>"""
    sending_method: NotRequired["str"]
    """<p>The name of the API call used when sent through a configuration set with archiving enabled.</p>"""
    source_identity: NotRequired["str"]
    """<p>The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.</p>"""
    sending_pool: NotRequired["str"]
    """<p>The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.</p>"""
    configuration_set: NotRequired["str"]
    """<p>The name of the configuration set used when sent through a configuration set with archiving enabled.</p>"""
    source_arn: NotRequired["str"]
    """<p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.</p>"""

configuration_set instance-attribute

configuration_set: NotRequired[str]

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

ingress_point_id instance-attribute

ingress_point_id: NotRequired[IngressPointId]

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

rule_set_id instance-attribute

rule_set_id: NotRequired[RuleSetId]

The ID of the rule set that processed the email.

sender_hostname instance-attribute

sender_hostname: NotRequired[str]

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

sender_ip_address instance-attribute

sender_ip_address: NotRequired[SenderIpAddress]

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

sending_method instance-attribute

sending_method: NotRequired[str]

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

sending_pool instance-attribute

sending_pool: NotRequired[str]

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

source_arn instance-attribute

source_arn: NotRequired[str]

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

source_identity instance-attribute

source_identity: NotRequired[str]

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

timestamp instance-attribute

timestamp: NotRequired[datetime]

The timestamp of when the email was received.

tls_cipher_suite instance-attribute

tls_cipher_suite: NotRequired[str]

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

tls_protocol instance-attribute

tls_protocol: NotRequired[str]

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

traffic_policy_id instance-attribute

traffic_policy_id: NotRequired[TrafficPolicyId]

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