edx-ace
Getting Started
Install dependencies
Configure delivery channels
Create a message
Send a message
Design
Overview
Goals/Constraints
Architecture
Testing
API Documentation
Basic Interface
Sending Messages
Delivery
Exceptions
Messages
Monitoring
Delivery Policy
Message Presentation
Message Recipients
Serialization
Utils
Testing
Internal
Change Log
Unreleased
[0.1.0] - 2017-08-08
edx-ace
Table of Contents
»
Index
Give Doc Feedback
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
A
AbstractRenderer (class in edx_ace.renderers)
app_label (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
APP_LABEL (edx_ace.message.MessageType attribute)
app_label (edx_ace.message.MessageType attribute)
APP_LABEL (edx_ace.MessageType attribute)
app_label (edx_ace.MessageType attribute)
B
body (edx_ace.renderers.RenderedEmail attribute)
body_html (edx_ace.renderers.RenderedEmail attribute)
C
Channel (class in edx_ace)
(class in edx_ace.channel)
channel (edx_ace.renderers.AbstractRenderer attribute)
(edx_ace.renderers.EmailRenderer attribute)
channel_type (edx_ace.Channel attribute)
(edx_ace.channel.Channel attribute)
(edx_ace.channel.sailthru.SailthruEmailChannel attribute)
ChannelError
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)
context (edx_ace.Message attribute)
(edx_ace.MessageType attribute)
(edx_ace.message.Message attribute)
(edx_ace.message.MessageType attribute)
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.MessageType method)
(edx_ace.message.Message method)
(edx_ace.message.MessageType method)
default_name() (edx_ace.message.MessageType method)
(edx_ace.MessageType method)
deliver() (edx_ace.Channel method)
(edx_ace.channel.Channel method)
(edx_ace.channel.sailthru.SailthruEmailChannel method)
(in module edx_ace.delivery)
deny (edx_ace.policy.PolicyResult attribute)
(edx_ace.PolicyResult attribute)
deserialize() (in module edx_ace.utils.date)
E
edx_ace (module)
edx_ace.ace (module)
edx_ace.channel (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)
email_address (edx_ace.Recipient attribute)
(edx_ace.recipient.Recipient attribute)
EmailRenderer (class in edx_ace.renderers)
enabled() (edx_ace.Channel class method)
(edx_ace.Policy class method)
(edx_ace.channel.Channel class method)
(edx_ace.channel.sailthru.SailthruEmailChannel class method)
(edx_ace.policy.Policy class method)
expiration_time (edx_ace.Message attribute)
(edx_ace.MessageType attribute)
(edx_ace.message.Message attribute)
(edx_ace.message.MessageType attribute)
F
FatalChannelDeliveryError
from_name (edx_ace.renderers.RenderedEmail attribute)
from_string() (edx_ace.serialization.MessageAttributeSerializationMixin class method)
G
generate_uuid() (edx_ace.Message method)
(edx_ace.MessageType method)
(edx_ace.message.Message method)
(edx_ace.message.MessageType method)
get_current_time() (in module edx_ace.utils.date)
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)
H
head_html (edx_ace.renderers.RenderedEmail attribute)
I
INTERNAL_ERROR (edx_ace.channel.sailthru.RecoverableErrorCodes attribute)
InvalidMessageError
L
language (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
log_id (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
log_level (edx_ace.Message attribute)
(edx_ace.MessageType attribute)
(edx_ace.message.Message attribute)
(edx_ace.message.MessageType attribute)
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)
N
name (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
NAME (edx_ace.message.MessageType attribute)
name (edx_ace.message.MessageType attribute)
NAME (edx_ace.MessageType attribute)
name (edx_ace.MessageType attribute)
O
once() (in module edx_ace.utils.once)
P
patch_channels() (in module edx_ace.test_utils)
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)
recipient (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
RecipientResolver (class in edx_ace)
(class in edx_ace.recipient_resolver)
RecoverableChannelDeliveryError
RecoverableErrorCodes (class in edx_ace.channel.sailthru)
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)
send_uuid (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
serialize() (in module edx_ace.utils.date)
StubPolicy (class in edx_ace.test_utils)
subject (edx_ace.renderers.RenderedEmail attribute)
T
to_json() (edx_ace.serialization.MessageAttributeSerializationMixin method)
U
unique_name (edx_ace.Message attribute)
(edx_ace.message.Message attribute)
UnsupportedChannelError
username (edx_ace.Recipient attribute)
(edx_ace.recipient.Recipient attribute)
uuid (edx_ace.Message attribute)
(edx_ace.MessageType attribute)
(edx_ace.message.Message attribute)
(edx_ace.message.MessageType attribute)