Changeset 23 for branches

Show
Ignore:
Timestamp:
10/16/07 02:27:31 (1 year ago)
Author:
amcgregor
Message:

Updated the TurboMailGuide as per ticket #19.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • branches/2.0.5/documentation/guide.wiki

    r13 r23  
    55!TurboMail is a !TurboGears extension, meaning that it starts up and shuts down alongside any !TurboGears applications you write, in the same way that visit tracking and identity do. !TurboMail uses built-in Python modules for SMTP communication and MIME e-mail creation, but greatly simplifies these tasks by performing the grunt-work for you. Additionally, !TurboMail is multi-threaded, allowing for single or batch enqueueing and background delivery of mail. 
    66 
    7 == Compatability == 
     7== Compatibility == 
    88 
    9 !TurboMail is compatible with Python 2.4 and 2.5, and should be compatable with Python 2.3, although this is untested. 
     9!TurboMail is compatible with Python 2.4 and 2.5, and should be compatible with Python 2.3, although this is untested. 
    1010 
    1111== Installation & Upgrade Instructions == 
    … …  
    4545    * `utf-8` -- Uses base64 encoding. 
    4646    * `utf-8-qp` -- Configures utf-8 to use quoted-printable encoding.  (Note: this is not a real character set and can only be used with !TurboMail.  Note also that this setting reconfigures the global ''utf-8'' setting to use a different encoding and will effect other processes using this mechanism.) 
    47  * `mail.polling` (Defaut: ''False'') If enabled, configures the thread pool to poll every mail.interval seconds for new jobs. This may give performance benefits to the running application. The default behaviour is to create new threads as soon as work is enqueued, resulting in faster delivery, but greater initial load. 
     47 * `mail.polling` (Default: ''False'') If enabled, configures the thread pool to poll every mail.interval seconds for new jobs. This may give performance benefits to the running application. The default behaviour is to create new threads as soon as work is enqueued, resulting in faster delivery, but greater initial load. 
    4848 
    4949In debug mode, using a single thread with a maximum of one job can be advantageous. Having a single thread with a maximum of a single job limits !TurboMail to a single SMTP connection at a time and automatically disconnects after sending each message. 
    … …  
    107107 * `cc` -- Carbon-copy address or addresses. 
    108108 * `date` -- The Date header. 
    109  * `disposition` -- Request disposition notfication be sent to this address. 
     109 * `disposition` -- Request disposition notification be sent to this address. 
    110110 * `encoding` -- Content encoding specific to this message. 
    111111 * `headers` -- A list of additional headers.