Commits

Patrick Samson  committed e5962fd

formatting

  • Participants
  • Parent commits b1e3ec6

Comments (0)

Files changed (2)

 Basically, the purpose is to allow authenticated users of a site to exchange private //**messages**// within the site.
 In this documentation, the word user is to be understood as an instance of a User, in the django.contrib.auth context.
 
+So it is mainly for a User-to-User exchange.
 But it may be beneficial for a subscriber to receive inquiries from any visitor, that is even if non authenticated.
 For instance, a subscriber as a service provider wants an ask-me-details form on a presentation page
 to facilitate possible business contacts.
   The lastest message (time deposit related) is the representative of the set.
 * by **message**, for an expanded view: each message is considered on its own.
 
+Here is a summary of features:
+* A non-User (email is unveiled) can write to a User and get a reply
+  (can be disabled by configuration)
+* Exchanges can be moderated (with auto-accept and auto-reject plug-ins)
+* Optional recipient filter plug-ins
+* Optional exchange filtering plug-ins (blacklists)
+* Multi-recipients writing is possible (can be disabled by configuration)
+  with min/max constraints
+* Messages are managed in threads
+* Messages in folders are sortable by sender|recipient|subject|date
+* 'Archives' folder in addition to classic Inbox, Sent and Trash folders
+* A Quick-Reply form to only ask for a response text
+* A cleanup management command to clear the old deleted messages
+
+It has support for optional additional applications:
+* Autocomplete recipient field (default is 'django-ajax-selects'),
+  with multiple recipients support
+* New-message notification (default is 'django-notification')
+* Asynchronous mailer (default is 'django-mailer')
+
 === Moderation ===
-
 As an option, messages may need to be validated by a moderator before to be visible to the recipient.
 Possible usages are:
 
 * Automatically, through one or more auto-moderator functions.
 
 === Filters ===
-
 As options, custom filters can disallow messages, in two ways:
 * **user filter**: a user is not in a state to act as a recipient
 * **exchange filter**: criteria for a message between a specific sender and a specific recipient are not fulfilled

File Quick_Start_Guide.wiki

 
 You may specify some additional configuration options in your {{{settings.py}}}:
 
-**{{{POSTMAN_DISALLOW_ANONYMOUS}}}**\\
+**{{{POSTMAN_DISALLOW_ANONYMOUS}}}**
+
     Set it to True if you do not allow visitors to write to users. That way, messaging is restricted to a User-to-User exchange.
 
     //Defaults to//: False.
 
-**{{{POSTMAN_DISALLOW_MULTIRECIPIENTS}}}**\\
+**{{{POSTMAN_DISALLOW_MULTIRECIPIENTS}}}**
+
     Set it to True if you do not allow more than one username in the recipient field.
 
     //Defaults to//: False.
 
-**{{{POSTMAN_DISALLOW_COPIES_ON_REPLY}}}**\\
+**{{{POSTMAN_DISALLOW_COPIES_ON_REPLY}}}**
+
     Set it to True if you do not allow additional recipients when replying.
 
     //Defaults to//: False.
     
-**{{{POSTMAN_AUTO_MODERATE_AS}}}**\\
+**{{{POSTMAN_AUTO_MODERATE_AS}}}**
+
     The default moderation status when no auto-moderation functions, if any, were decisive.
 
     * {{{True}}} to accept messages.
     * Set this option to True
     * Do not provide any auto-moderation functions
 
-**{{{POSTMAN_NOTIFIER_APP}}}**\\
+**{{{POSTMAN_NOTIFIER_APP}}}**
+
     A notifier application name, used in preference to the basic emailing, to notify users of their rejected or received messages.
 
     //Defaults to//: 'notification', as in django-notification.
     If you already have a notifier application with the default name in the installed applications
     but do not want it to be used by this application, set the option to None.
 
-**{{{POSTMAN_MAILER_APP}}}**\\
+**{{{POSTMAN_MAILER_APP}}}**
+
     An email application name, used in preference to the basic django.core.mail, to send emails.
 
     //Defaults to//: 'mailer', as in django-mailer.
     If you already have a mailer application with the default name in the installed applications
     but do not want it to be used by this application, set the option to None.
 
-**{{{POSTMAN_AUTOCOMPLETER_APP}}}**\\
+**{{{POSTMAN_AUTOCOMPLETER_APP}}}**
+
     An auto completer application specification, useful for recipient fields.
     To enable the feature, define a dictionary with these keys: