Document relation between module namespaces and interfaces

framework/module/auth.go

@@ -11,6 +11,8 @@ var (
 
 // PlainAuth is the interface implemented by modules providing authentication using
 // username:password pairs.
+//
+// Modules implementing this interface should be registered with "auth." prefix in name.
 type PlainAuth interface {
 	AuthPlain(username, password string) error
 }

framework/module/check.go

@@ -11,6 +11,9 @@ import (
 
 // Check is the module interface that is meant for read-only (with the
 // exception of the message header modifications) (meta-)data checking.
+//
+// Modules implementing this interface should be registered with "check."
+// prefix in name.
 type Check interface {
 	// CheckStateForMsg initializes the "internal" check state required for
 	// processing of the new message.

framework/module/delivery_target.go

@@ -10,6 +10,9 @@ import (
 // DeliveryTarget interface represents abstract storage for the message data
 // (typically persistent) or other kind of component that can be used as a
 // final destination for the message.
+//
+// Modules implementing this interface should be registered with "target."
+// prefix in name.
 type DeliveryTarget interface {
 	// Start starts the delivery of a new message.
 	//

framework/module/modifier.go

@@ -23,6 +23,8 @@ import (
 // RewriteRcpt is newer called before RewriteSender and RewriteBody is never called
 // before RewriteRcpts. This allows modificator code to save values
 // passed to previous calls for use in later operations.
+//
+// Modules implementing this interface should be registered with "modify." prefix in name.
 type Modifier interface {
 	// ModStateForMsg initializes modifier "internal" state
 	// required for processing of the message.

framework/module/storage.go

@@ -6,6 +6,9 @@ import (
 
 // Storage interface is a slightly modified go-imap's Backend interface
 // (authentication is removed).
+//
+// Modules implementing this interface should be registered with prefix
+// "storage." in name.
 type Storage interface {
 	// GetOrCreateIMAPAcct returns User associated with storage account specified by
 	// the name.

framework/module/table.go

@@ -2,6 +2,9 @@ package module
 
 // Tabele is the interface implemented by module that implementation string-to-string
 // translation.
+//
+// Modules implementing this interface should be registered with prefix
+// "table." in name.
 type Table interface {
 	Lookup(s string) (string, bool, error)
 }