edx-ace
Getting Started
Install dependencies
Configure delivery channels
Create a message
Transactional messages
Send a message
Design
Overview
Goals/Constraints
Architecture
Decisions
Testing
API Documentation
Basic Interface
Sending Messages
Delivery
Exceptions
Messages
Monitoring
Delivery Policy
Message Presentation
Message Recipients
Serialization
Utils
Testing
Internal
Change Log
Unreleased
[1.5.0] - 2022-02-15
[1.4.1] - 2021-12-06
[1.4.0] - 2021-11-08
[1.3.1] - 2021-08-17
[1.3.0] - 2021-08-16
[1.2.0] - 2021-07-16
[1.1.1] - 2021-07-09
[1.1.0] - 2021-03-26
[1.0.1] - 2021-03-15
[1.0.0] - 2021-03-11
[0.1.18] - 2020-11-19
[0.1.17] - 2020-10-19
[0.1.16] - 2020-10-17
[0.1.15] - 2020-03-11
[0.1.14] - 2020-03-11
[0.1.13] - 2019-12-06
[0.1.12] - 2019-10-16
[0.1.10] - 2018-11-01
[0.1.9] - 2018-07-13
[0.1.0] - 2017-08-08
edx-ace
Table of Contents
»
Index
Give Doc Feedback
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
A
AbstractRenderer (class in edx_ace.renderers)
action_links (edx_ace.channel.sailthru.SailthruEmailChannel property)
APP_LABEL (edx_ace.message.MessageType attribute)
(edx_ace.MessageType attribute)
C
Channel (class in edx_ace)
(class in edx_ace.channel)
channel_type (edx_ace.Channel attribute)
(edx_ace.channel.Channel attribute)
(edx_ace.channel.sailthru.SailthruEmailChannel attribute)
ChannelError
ChannelMap (class in edx_ace.channel)
channels() (in module edx_ace.channel)
channels_for() (in module edx_ace.policy)
ChannelType (class in edx_ace)
(class in edx_ace.channel)
check() (edx_ace.Policy method)
(edx_ace.policy.Policy method)
(edx_ace.test_utils.StubPolicy method)
check_plugin() (in module edx_ace.utils.plugins)
check_set_of_channel_types() (edx_ace.policy.PolicyResult method)
(edx_ace.PolicyResult method)
D
debug() (edx_ace.message.MessageLoggingAdapter method)
default() (edx_ace.serialization.MessageEncoder method)
default_app_label() (edx_ace.message.MessageType method)
(edx_ace.MessageType method)
default_context_value() (edx_ace.Message method)
(edx_ace.message.Message method)
(edx_ace.message.MessageType method)
(edx_ace.MessageType method)
default_name() (edx_ace.message.MessageType method)
(edx_ace.MessageType method)
default_options_value() (edx_ace.Message method)
(edx_ace.message.Message method)
(edx_ace.message.MessageType method)
(edx_ace.MessageType method)
deliver() (edx_ace.Channel method)
(edx_ace.channel.Channel method)
(edx_ace.channel.django_email.DjangoEmailChannel method)
(edx_ace.channel.sailthru.SailthruEmailChannel method)
(in module edx_ace.delivery)
deserialize() (in module edx_ace.utils.date)
DjangoEmailChannel (class in edx_ace.channel.django_email)
E
edx_ace
module
edx_ace.ace
module
edx_ace.channel
module
edx_ace.channel.django_email
module
edx_ace.channel.sailthru
module
edx_ace.delivery
module
edx_ace.errors
module
edx_ace.message
module
edx_ace.monitoring
module
edx_ace.policy
module
edx_ace.presentation
module
edx_ace.recipient
module
edx_ace.recipient_resolver
module
edx_ace.renderers
module
edx_ace.serialization
module
edx_ace.test_utils
module
edx_ace.utils
module
edx_ace.utils.date
module
edx_ace.utils.once
module
edx_ace.utils.plugins
module
EMAIL (edx_ace.channel.ChannelType attribute)
(edx_ace.ChannelType attribute)
EmailRenderer (class in edx_ace.renderers)
enabled() (edx_ace.Channel class method)
(edx_ace.channel.Channel class method)
(edx_ace.channel.django_email.DjangoEmailChannel class method)
(edx_ace.channel.sailthru.SailthruEmailChannel class method)
(edx_ace.Policy class method)
(edx_ace.policy.Policy class method)
F
FatalChannelDeliveryError
from_string() (edx_ace.serialization.MessageAttributeSerializationMixin class method)
G
generate_uuid() (edx_ace.Message method)
(edx_ace.message.Message method)
(edx_ace.message.MessageType method)
(edx_ace.MessageType method)
get_action_links() (edx_ace.channel.sailthru.SailthruEmailChannel method)
get_channel_by_name() (edx_ace.channel.ChannelMap method)
get_channel_for_message() (in module edx_ace.channel)
get_current_time() (in module edx_ace.utils.date)
get_default_channel() (edx_ace.channel.ChannelMap method)
get_manager() (in module edx_ace.utils.plugins)
get_message_specific_logger() (edx_ace.Message method)
(edx_ace.message.Message method)
get_plugins() (in module edx_ace.utils.plugins)
get_template_for_message() (edx_ace.renderers.AbstractRenderer method)
I
INTERNAL_ERROR (edx_ace.channel.sailthru.RecoverableErrorCodes attribute)
InvalidMessageError
L
log_id (edx_ace.Message property)
(edx_ace.message.Message property)
M
Message (class in edx_ace)
(class in edx_ace.message)
MessageAttributeSerializationMixin (class in edx_ace.serialization)
MessageEncoder (class in edx_ace.serialization)
MessageLoggingAdapter (class in edx_ace.message)
MessageType (class in edx_ace)
(class in edx_ace.message)
module
edx_ace
edx_ace.ace
edx_ace.channel
edx_ace.channel.django_email
edx_ace.channel.sailthru
edx_ace.delivery
edx_ace.errors
edx_ace.message
edx_ace.monitoring
edx_ace.policy
edx_ace.presentation
edx_ace.recipient
edx_ace.recipient_resolver
edx_ace.renderers
edx_ace.serialization
edx_ace.test_utils
edx_ace.utils
edx_ace.utils.date
edx_ace.utils.once
edx_ace.utils.plugins
N
NAME (edx_ace.message.MessageType attribute)
(edx_ace.MessageType attribute)
O
once() (in module edx_ace.utils.once)
overrides_delivery_for_message() (edx_ace.Channel method)
(edx_ace.channel.Channel method)
P
patch_policies() (in module edx_ace.test_utils)
personalize() (edx_ace.message.MessageType method)
(edx_ace.MessageType method)
policies() (in module edx_ace.policy)
Policy (class in edx_ace)
(class in edx_ace.policy)
PolicyResult (class in edx_ace)
(class in edx_ace.policy)
process() (edx_ace.message.MessageLoggingAdapter method)
PUSH (edx_ace.channel.ChannelType attribute)
(edx_ace.ChannelType attribute)
R
RATE_LIMIT (edx_ace.channel.sailthru.RecoverableErrorCodes attribute)
RATE_LIMIT_REMAINING (edx_ace.channel.sailthru.ResponseHeaders attribute)
RATE_LIMIT_RESET (edx_ace.channel.sailthru.ResponseHeaders attribute)
Recipient (class in edx_ace)
(class in edx_ace.recipient)
RecipientResolver (class in edx_ace)
(class in edx_ace.recipient_resolver)
RecoverableChannelDeliveryError
RecoverableErrorCodes (class in edx_ace.channel.sailthru)
register_channel() (edx_ace.channel.ChannelMap method)
render() (edx_ace.renderers.AbstractRenderer method)
(in module edx_ace.presentation)
rendered_message_cls (edx_ace.renderers.AbstractRenderer attribute)
(edx_ace.renderers.EmailRenderer attribute)
RenderedEmail (class in edx_ace.renderers)
report() (edx_ace.Message method)
(edx_ace.message.Message method)
(in module edx_ace.monitoring)
report_basics() (edx_ace.Message method)
(edx_ace.message.Message method)
report_to_newrelic() (in module edx_ace.monitoring)
ResponseHeaders (class in edx_ace.channel.sailthru)
S
SailthruEmailChannel (class in edx_ace.channel.sailthru)
send() (edx_ace.recipient_resolver.RecipientResolver method)
(edx_ace.RecipientResolver method)
(in module edx_ace)
(in module edx_ace.ace)
serialize() (in module edx_ace.utils.date)
StubPolicy (class in edx_ace.test_utils)
T
to_json() (edx_ace.serialization.MessageAttributeSerializationMixin method)
tracker_image_sources (edx_ace.channel.sailthru.SailthruEmailChannel property)
U
unique_name (edx_ace.Message property)
(edx_ace.message.Message property)
UnsupportedChannelError