rattail.mail

Email Framework

class rattail.mail.EmailHandler(config)

Base class and default implementation for email handlers.

deliver_message(email, msg, recipients=<object object>)

Deliver an email message using the given SMTP configuration.

email_is_available(email)

Returns boolean indicating if the Email profile for the given key is “available” and should be exposed to users.

email_is_enabled(email)

Returns boolean indicating if the given Email profile is “enabled” - that is, emails of its type should be sent as opposed to being suppressed.

Parameters:

email – An Email instance.

email_is_hidden(email)

Returns boolean indicating if the given Email profile is “hidden” and should not be exposed to users.

Parameters:

email – Either an Email instance, or the key value for one.

get_all_emails(**kwargs)

Retrieve the complete set of all Email profiles exposed by the app and installed packages.

get_available_emails(**kwargs)

Retrieve the set of “available” Email profiles, i.e. those which should be exposed to the app users.

get_email(key, fallback_key=None, **kwargs)

Return an email instance of the given type.

get_emails_from_module(module, **kwargs)

Return all Email profiles from the given Python module.

iter_emails(warn=True)

Iterate over all available email types.

should_record_attempts()

Returns a boolean indicating if the app should make a record of all attempts to send email.

should_send_email_on_failure()

Returns a boolean indicating if the app should send an email alert whenever sending of an email message fails.

use_entry_points()

Returns a boolean indicating if the app should get its list of available emails from the setuptools entry points, instead of the (legacy) [rattail.mail] emails config setting.

rattail.mail.send_email(config, key, data={}, attachments=[], fallback_key=None, default_subject=None, enabled=<object object>, **kwargs)

Send an email message of the given type, per config, with the given data and/or attachments.

class rattail.mail.Email

Represents an email message, of a particular type. Various aspects of the message may be defined by a subclass and/or configuration.

Attribute key:

Unique key for a particular type of email. This is used to determine which template(s) will be used to generate the email body, as well as the email sender and recipients (via config/settings), etc.