Skip to content

Commit

Permalink
Alphabet sorting and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
PF4Public committed Oct 20, 2022
1 parent 5ab5334 commit 0f909ab
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,25 @@ Please follow these steps and adapt them to your distribution if necessary
2. Next you should extract **Roundcube fetchmail plugin** archive into your **Roundcube** `plugins` folder creating "fetchmail" folder there.
* You can do so either by using `composer` for which there is `composer.json`, still you need to follow further installation steps since those could not be accomplished with `composer`
* Alternatively you can download needed release from [Releases page](https://github.com/PF4Public/fetchmail/releases) unpacking it accordingly
3. After that you need to enable newly installed plugin by adding it to **Roundcube** plugin list. For **Debian** related config file is `/etc/roundcube/main.inc.php` and relevant setting is
3. After that you need to enable newly installed plugin by adding it to **Roundcube** plugin list. For **Debian** related config file is `/etc/roundcube/main.inc.php` and relevant setting is

```php

$rcmail_config ['plugins'] = array();

```
Appending `, 'fetchmail'` to the list of plugins will suffice.

4. Unless default settings are suitable for you, you need to configure the plugin. See the [settings section](#settings) for more information.
5. You need to create additional table in your database using one of the supplied `.initial.sql` files and update it with all the dated `.sql` files accordingly. Another possibility is to use **Postfix Admin** table if you have it installed. If using **PostgreSQL** you may use schemas to share `fetchmail` table between **Roundcube** and **Postfix Admin**. Namely creating it in `public` schema, whereas every other table in it's appropriate schema, like `roundcube` and `postfixadmin`. Please refer to [the documentation](https://www.postgresql.org/docs/current/static/ddl-schemas.html) for more information. If you do so and use composer, however, you probably need to set the database version of this plugin in roundcube database to `9999999900` so that composer will not try updating it.
6. You will need `fetchmail.pl` script from **Postfix Admin** distribution. If you don't have **Postfix Admin** installed, you can obtain required `fetchmail.pl` script from their repo [postfixadmin / ADDITIONS / fetchmail.pl](https://github.com/postfixadmin/postfixadmin/blob/master/ADDITIONS/fetchmail.pl). But be sure to get at least revision [8bad929](https://github.com/postfixadmin/postfixadmin/blob/8bad929a4490f93587ceb00b5931405586b5cc04/ADDITIONS/fetchmail.pl), at which proper handling of `active` field introduced. Place it to where apropriate. For example, where your mailboxes are, e.g. `/var/mail`.
6. You will need `fetchmail.pl` script from **Postfix Admin** distribution. If you don't have **Postfix Admin** installed, you can obtain required `fetchmail.pl` script from their repo [postfixadmin / ADDITIONS / fetchmail.pl](https://github.com/postfixadmin/postfixadmin/blob/master/ADDITIONS/fetchmail.pl). But be sure to get at least revision [8bad929](https://github.com/postfixadmin/postfixadmin/blob/8bad929a4490f93587ceb00b5931405586b5cc04/ADDITIONS/fetchmail.pl), at which proper handling of `active` field introduced. Place it to where appropriate. For example, where your mailboxes are, e.g. `/var/mail`.
7. Next adapt `fetchmail.pl` to your config. Most likely you want to change these settings:

```perl
# database backend - uncomment one of these
our $db_type = 'Pg';
#my $db_type = 'mysql';

# host name
our $db_host="127.0.0.1";
# database name
Expand All @@ -54,12 +54,12 @@ Appending `, 'fetchmail'` to the list of plugins will suffice.
Please note that some commands might require superuser permissions

## Settings
In case you need to edit default-set settings, you may copy `config.inc.php.dist` to `config.inc.php` and edit setings as desired in the latter file, which will override defaults.
In case you need to edit default-set settings, you may copy `config.inc.php.dist` to `config.inc.php` and edit settings as desired in the latter file, which will override defaults.
* `$config['fetchmail_check_server']` if set to `true` the plugin will do a DNS lookup for the servername provided by the user. If the servername cannot be resolved in DNS, an error is displayed.
* `$config['fetchmail_db_dsn']` allows you to use a fetchmail database outside the Roundcube database, e.g. from an existing Postfix Admin installation. see [Roundcube configuration options](https://github.com/roundcube/roundcubemail/wiki/Configuration#database-connection) for correct syntax. If set to `null`, Roundcube Database is used. Default is `null`.
* `$config['fetchmail_limit']` limits the number of external mailboxes per user allowed. Default is `10`.
* `$config['fetchmail_folder']` whether to allow users to specify IMAP folder they wish to download mail from. Default is `false`.
* `$config['fetchmail_limit']` limits the number of external mailboxes per user allowed. Default is `10`.
* `$config['fetchmail_mda']` allows you to specify mda field for fetchmail. This could be useful in case you want to deliver downloaded mail via MDA or LDA directly, rather than forwarding via SMTP or LMTP. For more information please refer to [fetchmail manual](http://www.fetchmail.info/fetchmail-man.html) and [fetchmail.pl](https://github.com/postfixadmin/postfixadmin/blob/master/ADDITIONS/fetchmail.pl) script. Default is `''`, i.e. not used.
* `$config['fetchmail_check_server']` if set to `true` the plugin will do a DNS lookup for the servername provided by the user. If the servername cannot be resolved in DNS, an error is displayed.

## License
This software distributed under the terms of the GNU General Public License as published by the Free Software Foundation
Expand Down

0 comments on commit 0f909ab

Please sign in to comment.