parsedmarc.source.aws 🔗

SimpleEmailService 🔗

SimpleEmailService(
    name: str = "default",
    parser: ReportParser | None = None,
    config: dict[str, Any] | None = None,
)

Bases: Source

AWS Simple Email Service (SES) Source

This source allows reading email from SES where emails are stored in S3 and notifications of new emails are sent to SQS via SNS.

References:

https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html
https://docs.aws.amazon.com/ses/latest/dg/receiving-email-notifications-examples.html

New in 9.0.

PARAMETER	DESCRIPTION
`name`	profile name for this instance, ideally should be unqiue to easily idenfity this instance and any log messages it produces TYPE: `str` DEFAULT: `'default'`
`parser`	parser to use when generating reports TYPE: `ReportParser \| None` DEFAULT: `None`
`config`	config for this instance TYPE: `dict[str, Any] \| None` DEFAULT: `None`

outstanding_jobs: MappingProxyType[str, Job]

Read only view of outstanding jobs

state: AppState

Read only Source state

register_job(job: Job) -> None

Register a job to this source so we can keep track of it

PARAMETER	DESCRIPTION
`job`	the job to register TYPE: `Job`

shutdown(
    timeout: int | float = 120, force: bool = False
) -> None

Attempt to gracefully shutdown this source.

PARAMETER	DESCRIPTION
`timeout`	Giveup after this many seonds (TODO) TYPE: `int \| float` DEFAULT: `120`
`force`	If a timeout would occur, instead force shutdown. TYPE: `bool` DEFAULT: `False`

validate_config() -> None

Validate the config of this instance

Child classes can override this method to implement their own logic. It is still recomended to call super().validate_config().

SimpleEmailService Config

New in 9.0.