swh.web.inbound_email.signals module

swh.web.inbound_email.signals.email_received = <django.dispatch.dispatcher.Signal object>

This signal is sent by the process_inbound_email management command.

Parameters

message (email.message.EmailMessage) – the inbound email message

Signal receivers must return an EmailProcessingStatus value so that the management command knows if the email has been processed.

Signal receivers will be called for all received emails and are expected to do their own filtering (e.g. using the original destination address).

Receivers ignoring a message must return EmailProcessingStatus.IGNORED to let the management command know that the message hasn’t been processed.

class swh.web.inbound_email.signals.EmailProcessingStatus(value)[source]

Bases: enum.Enum

Return values for the email processing signal listeners

PROCESSED = 1

The email has been successfully processed

FAILED = 2

The email has been processed, but the processing failed

IGNORED = 3

The email has been ignored (e.g. unknown recipient)