Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brendanheywood authored May 11, 2023
1 parent acae03e commit a182611
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/catalyst/moodle-tool_emailutils/ci/MOODLE_39_STABLE)

# AWS SES Complaints Plugin for Moodle
# Email utilities for Moodle

This plugin is intended to become a place for a suite of semi related email utilities
to help improve the securty, scalability, and performance of emails.

Over time some of the features may be pulled into Moodle core.

A rough roadmap with no set timelines:

* Handle incoming email complaints via AWS SES Complaints
* Manage DKIM keys
* Email round trip monitoring, eg sends an email to itself and asserts it arrives and in the right shape
* DMARC email processing and reporting

This plugin is for use with the AWS SES service.

## Branches
The following lists the supported branch to use based on your Moodle version.
Expand All @@ -18,11 +29,13 @@ git clone [email protected]:catalyst/moodle-tool_emailutils.git admin/tool/emailuti
```


## Soon to come
## AWS SES Complaints Plugin for Moodle

This plugin is for use with the AWS SES service.

The complaints list (/admin/tool/emailutils/index.php) is not implemented yet.

## Configuring AWS SES
### Configuring AWS SES

AWS Simple Email Service (SES) creates Simple Notification Service (SNS) topics
for both bounces and complaints on each domain, a SNS topic is basically a
Expand Down

0 comments on commit a182611

Please sign in to comment.