Changes between Version 6 and Version 7 of docs


Ignore:
Timestamp:
01/09/11 14:38:42 (8 years ago)
Author:
octo
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • docs

    v6 v7  
    22= Documentation = 
    33 
    4 This documentation covers !LogicMail 1.0.  A lot of it is applicable to earlier versions, and may be applicable to future versions.  It is considered to be a living document, and will be updated along with !LogicMail itself. 
     4This documentation is primarily focused on !LogicMail 2.0.  However a lot of it is applicable to earlier versions, and may be applicable to future versions.  It is considered to be a living document, and will be updated along with !LogicMail itself. 
    55 
     6== Installation == 
     7For initial installation and setup, please refer to these walk-through guides: 
     8 
     9 * [wiki:setup20 LogicMail 2.0 Setup Guide] 
    610 * [wiki:setup10 LogicMail 1.0 Setup Guide] 
    711 
    8 == Installation == 
    9  
    1012== Configuration == 
    11  
    12 When first started, !LogicMail presents an empty accounts list screen.  To begin setup, go to the menu and select "Configuration". 
    13 You will then see a list of the following configuration sections: 
    1413 
    1514||Global settings||Options that apply across the whole application.|| 
     
    2019=== Global settings === 
    2120 
    22 ||'''''Option'''''           ||'''''Default'''''||'''''Description'''''|| 
    23 ||'''Global settings:'''     ||                 || 
    24 ||Message count              ||30               ||Number of messages to download when connecting to a mailbox.|| 
    25 ||Message order              ||Ascending        ||Order in which to display messages.|| 
    26 ||!WiFi mode                 ||Disabled         ||''Disabled'' - Do not use !WiFi[[BR]]''Prompt'' - Prompt for !WiFi use when making connections[[BR]]''Always'' - Always try to connect via !WiFi|| 
    27 ||'''IMAP settings:'''       ||                 || 
    28 ||Max size to dl per msg (kb)||32               ||Maximum amount of data (in kilobytes) to download when viewing a message|| 
    29 ||Max folder depth           ||4                ||Maximum depth to check when getting an account's mail folder tree|| 
    30 ||'''POP settings:'''        ||                 || 
    31 ||Max lines to dl per msg    ||400              ||Maximum amount of data (in lines of text, readable and encoded) to download when viewing a message|| 
    32 ||'''Connection debugging''' ||Unchecked        ||Enable to cause all network communications to be logged for debugging.  Only use this when no other means of capturing network communications are available for debugging, and disable immediately afterwards.|| 
     21{{{#!td valign=top 
     22[[Image(9800-config-home.png)]] 
     23}}} 
     24{{{#!td valign=top 
     25||= Option =||= Choices =||= Description =|| 
     26||'''Identities'''           ||||User information that you might want to maintain across multiple accounts.|| 
     27||'''Accounts'''             ||||Connection and setup information for servers (POP/IMAP) you receive E-Mail through.|| 
     28||'''Outgoing servers'''     ||||Servers used for sending E-Mail (SMTP).|| 
     29||'''Message display:'''     |||||| 
     30||Preferred message format   ||'''Plain Text'''[[BR]]HTML||Which message format to use, if both are available.|| 
     31||Message order              ||'''Descending'''[[BR]]Ascending||Order in which to display messages.|| 
     32||Hide deleted messages      ||'''Checked'''[[BR]]Unchecked||Whether to hide messages flagged as deleted on the mail server.|| 
     33||Prompt on message delete?  ||'''Checked'''[[BR]]Unchecked||Whether to prompt before deleting a message.|| 
     34||Remove deleted messages    ||'''Prompt'''[[BR]]Always[[BR]]Never||What to do when closing a folder with messages flagged as deleted.|| 
     35||'''Networking:'''          |||||| 
     36||Connection method          ||'''Auto'''[[BR]]Direct TCP[[BR]]MDS[[BR]]WAP 2.0[[BR]]WiFi only||Which network transport to use when connection to a server.|| 
     37||Use WiFi if available      ||'''Checked'''[[BR]]Unchecked||Whether to attempt connection over WiFi, if it is available.|| 
     38||Override hostname          ||Checked[[BR]]'''Unchecked'''||Enables override of the hostname passed to outgoing (SMTP) servers when connecting.|| 
     39||Hostname                   || ||Hostname to use for the {{{EHLO}}} SMTP command if the above is enabled.|| 
     40||'''Other:'''               |||||| 
     41||Local data location        ||'''Media Card'''[[BR]]Device Memory[[BR]]Disabled||Where to store local folder contents and cached message content.  If disabled, these features will be unavailable.|| 
     42||Mailbox cache: Clear       ||||Click this button to clear the mailbox index cache.|| 
     43||Language                   ||BlackBerry[[BR]]Language name||Overrides the device language setting when LogicMail is running.  ''Note: Only available on development builds.''|| 
     44||Unicode normalization      ||Checked[[BR]]'''Unchecked'''||Normalizes Unicode text for correct display of Vietnamese characters, especially on pre-5.0 BlackBerry devices.|| 
     45||Connection debugging       ||Checked[[BR]]'''Unchecked'''||Logs all sent and received network packets to the BlackBerry event log, as described on the [wiki:debugging] page.|| 
     46}}} 
    3347 
    3448 
    35 === Identities === 
    36  
    37 ||'''''Option'''''||'''''Default'''''||'''''Description'''''|| 
    38 ||Identity        ||                 ||(Required) Name used to refer to this identity in the configuration screens|| 
    39 ||Full name       ||                 ||Full name to use when sending E-Mail|| 
    40 ||E-Mail address  ||                 ||(Required) E-Mail address to use as the sender of E-Mail|| 
    41 ||Reply-To address||                 ||Address that recipients should use for replies.  Only necessary if it is different from the above setting.|| 
    42 ||Signature       ||                 ||Signature to put at the bottom of E-Mail messages.  Can enter multiple lines.|| 
    43  
    44 === Accounts === 
    45  
    46 ||'''''Option'''''     ||'''''Default'''''||'''''Description'''''|| 
    47 ||Account name         ||                 ||(Required) Name used to refer to this identity in the configuration screens|| 
    48 ||Server               ||                 ||(Required) Address of the incoming E-Mail server|| 
    49 ||SSL                  ||Unchecked        ||Whether to use SSL when connecting|| 
    50 ||Port                 ||110/995 or 143/993||(Required) Port to connect to on the server.  Default is based on the protocol and SSL setting, but can be changed.|| 
    51 ||Username             ||                 ||Username for authenticating with the server. (If left blank, you will be prompted on connection.)|| 
    52 ||Password             ||                 ||Password for authenticating with the server. (If left blank, you will be prompted on connection.)|| 
    53 ||Use MDS proxy        ||Checked          ||Whether to connect directly (unchecked), or go through a service proxy (checked).|| 
    54 ||                     ||                 || 
    55 ||Identity             ||                 ||Identity (from above) to associate with the account|| 
    56 ||Outgoing server      ||None             ||Outgoing server (from below) to associate with the account for sending E-Mail|| 
    57 ||                     ||                 || 
    58 ||Sent message folder  ||None             ||(IMAP Only) Folder to store sent messages in.  This option is only available once you have connected to your mail server for the first time and retrieved the folder tree.|| 
    59  
    60 === Outgoing servers === 
    61  
    62 ||'''''Option'''''     ||'''''Default'''''||'''''Description'''''|| 
    63 ||Account name         ||                 ||(Required) Name used to refer to this identity in the configuration screens|| 
    64 ||Server               ||                 ||(Required) Address of the outgoing (SMTP) E-Mail server|| 
    65 ||SSL                  ||Unchecked        ||Whether to use SSL when connecting.  !LogicMail only supports SSL connections that begin SSL-encrypted.  Connections that start unencrypted, then send STARTTLS to become encrypted, are not supported due to platform limitations.|| 
    66 ||Port                 ||25/465           ||(Required) Port to connect to on the server.  Default is based on the protocol and SSL setting, but can be changed.|| 
    67 ||Authentication       ||NONE             ||Form of authentication to use with the SMTP server.  Options are: ''NONE'', ''PLAIN'', ''LOGIN'', and ''CRAM-MD5''. 
    68 ||Username             ||                 ||Username for authenticating with the server. (If left blank, you will be prompted on connection.)|| 
    69 ||Password             ||                 ||Password for authenticating with the server. (If left blank, you will be prompted on connection.)|| 
    70 ||Use MDS proxy        ||Checked          ||Whether to connect directly (unchecked), or go through a service proxy (checked).|| 
    7149 
    7250== Usage ==