<commit_before>Mail Manager
============

Mail Manager is an abstraction layer to allow student projects to send email whilst imposing rate limits to prevent simple mistakes - e.g. a mass email to external addresses.

Primarily intended for use within the School of Computer Science at the University of Manchester.<commit_msg>Extra documentation in README<commit_after>Mail Manager
============

Mail Manager is an abstraction layer to allow student projects to send email whilst imposing rate limits to prevent simple mistakes - e.g. a mass email to external addresses.

Primarily intended for use within the School of Computer Science at the University of Manchester.

See `example.php` for a simple example of how to use the class.

This class assumes you have a file `config.inc.php` somewhere within your path which sets the following global variables:

```
$database_host
$database_user
$database_pass
$database_name
```
{'fraction_non_alphanumeric': 0.06364617044228695, 'fraction_numerical': 0.0, 'mean_word_length': 5.065359477124183, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4680478', 'n_tokens_mistral': 215, 'n_tokens_neox': 206, 'n_words': 126}