Include more basic info in the readme
not_Dries_Buytaert - May 28, 2009 - 00:58
| Project: | Disposable e-mail protection |
| Version: | 6.x-1.0 |
| Component: | Documentation |
| Category: | task |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | active |
Jump to:
Description
What does it do exactly (description of use cases)? How can only the domainnames of emailadresses be checked/ send through the API (e.g. to prevent emailadresses from being sniffed while using the API)? Is there a UI? If so, will emails be checked on the fly, whenever the cursor leaves the emailadres field in the UI? Can an admin add a custom blacklist of domains? Etc.
#1
Some answers...(I don't maintain this module so take it for what it's worth):
What does it do? It checks e-mail addresses for user registrations against the blacklist at undisposable.net.
Check only domains? I don't know. Have you looked at the API for undisposable.net to see if that is even an option? If so, you could add that as a feature request.
Is there a UI? No.
Will e-mails be checked on-the-fly? No. They are checked at submit.
Can you add your own blacklist? No. That would seem to be out of the scope of the module which is designed to integrate the service provided by undisposable.net with Drupal. If you want to add to the list of disposable addresses, you could follow the submittal guidelines at undisposable.net. If you just want to not allow certain domains or addresses that aren't actually disposable, you should look at the Access rules in provided by Drupal core.
#2
The readme should explain that (once the module is enabled) the email address from a newly registered user will be tested against the online disposable hosts blacklist at submit. If the email address is disposable, following error is displayed:
"The e-mail address {...} has been reported as disposable."
The readme should also explain that this module does not include some GUI for configuration (it only offers some hooks).
The readme should also include installation instructions. For example:
#3
Feel free to contribute. This is open source after all.
If you write up better documentation, you can submit a patch to update it here. (Information on creating patches is in the Developers' Guide.) You could also write a book page documenting the module.