Add support for shared folders - patch

[geeojr]

I can't see shared folders with Courier. Courier-imap
makes shared folders available at the root level. Root
level contains: INBOX. & shared. -- need to check
for both.

[harrinp1]

I also vote for this feature. Diffrent IMAP servers handle this diffrently so you need to check the namespace to find out the Public folder namespace.

[captainmish]

another vote here - there are a number of installations that rely heavily on shared folders, thus making roundcube a non-starter for them.

[thesubmitter]

I also vote for this. For me this is a deal breaker for roundcube.

[zzamboni]

Here's another vote - this would be tremendously useful.

[mbalex]

a quick hack to enable other namespaces inside ilohamail library

[jvale]

Here here! This feature is essential so that I can deploy RoundCube at the site I'm adminning.

Eventough it's a bit of an ugly hack, the patch works like a charm with a Courier server.

[jvale]

Correction: the hack doesn't work that well. I can see the shared folders, but 'special' folders like Drafts, Trash and Sent are no longer 'special'. Meaning, I can't delete messages and it fails when copying a message I just sent to the 'Sent' folder.

[mbalex]

jvale is correct if you dont change anything else. since the default root dir is "INBOX" on courier all special folders are usally relative to "INBOX" defined. since this hack changes the default root dir to "", the special folders etc need to prefix "INBOX." .

$rcmail_configdrafts_mbox? = 'INBOX.Drafts';

$rcmail_configjunk_mbox? = 'INBOX.Junk';

$rcmail_configsent_mbox? = 'INBOX.Sent';

$rcmail_configtrash_mbox? = 'INBOX.Trash';

$rcmail_configdefault_imap_folders? = array('INBOX', 'INBOX.Drafts', 'INBOX.Sent', 'INBOX.Junk', 'INBOX.Trash');

[thomasb]

Marked #1484043 as a duplicate of this bug

[thomasb]

Another patch for shared folders: ​http://lists.roundcube.net/mail-archive/dev/2010-02/0000015.html

[gordonjahn]

I've reviewed the patches and suggestions for getting shared folders working with RC but didn't like changing the Ilohamail library.

I've taken an alternative approach in the attached sharedpatch.txt patch -- the underlying library isn't modified as it works fine. Instead, imap_root is set in the config like this:

$rcmail_configimap_root? = array('INBOX', 'shared');

If this isn't set to an array('INBOX') by default, things stop working. I'm not sure if that should be handled in the config section though.

Anyway, after setting this and applying the patch, the mod_mailbox() function in rcube_imap.php is the main one that needs attention to ensure it doesn't mess with the folder names wrongly and the list_unsubscribed function is modified to check all the roots specified in the config file.

This seems to work for me, but wider testing might be nice, and this approach might be useful for others.

[gordonjahn]

Patch against 0.3.1 stable adding shared folder support - see comment for use (updated)

[gordonjahn]

I've attached an updated version of my patch from earlier - moving messages into and out of shared folders wasn't working, which is resolved now, and the need to configure has been removed. With the patch added, RC will work as normal is imap_root is not set (as default) and if the imap_root setting is set as detailed above, shared folder support works too.

[alec]

I think shared folders should be supported using NAMESPACE extension. Could you guys create a test IMAP account for me on server with shared folders configured? I would like to work on this but, have no testing environment.

[etiennesw]

Hi gordonjahn,

I am trying to setup Roundcube with the courier-imap server we use.

Would you be kind enough to give me instructions on how to install your patch for shared folders?

Where do we apply the code found in your text file?

Thanks

Rgs
Etienne

[gordonjahn]

Etienne..

The file is a unified patch file which you could apply the patch by using the patch utility inside a Bash shell - these programs should be on most Unix/Linux/Mac? systems already or, for Windows, install them using something like Cygwin. The process to enable would then be something like:

• Downloading Roundcube 0.3.1 and unpack
• Download the patch file attached here - put it in the same directory as RC 0.3.1
• Run the patch whilst in the RC directory: cat sharedpatch.txt | patch -p 2
• Configure RC for shared folders: $rcmail_config[imap_root] = array('INBOX', 'shared');
• Configure other RC options as required

Having done this, shared folders should work if enabled on the mail server. The final configuration line above is for the Courier IMAP mail server which uses the shared namespace for shared folders. If you don't have this set up already, I configured Courier for shared folders using the (vague) instructions at ​http://www.courier-mta.org/imap/README.sharedfolders.html .

This has a lot of background info, but it come down to using the maildirmake command with different options to set up the shared folders and then to make them available for each user - see the docs for this command if you need to use it.

Hope that helps,
Gordon

[etiennesw]

Hi Gordon,

I successfully applied the patch as you said and also set the imap_root = array('INBOX','#shared')
since our prefix is #shared. In roundcube the #shared folder appears, but is empty and cannot be subscribed to.

The shared folders on our courier-imap server were created via maildirmake and work well with Thunderbird and Horde webmail, however, Roundcube is proving to be problamatic with public shared folders.

Thanks anyway for your help.

Rgs
Etienne

[etiennesw]

Hi Gordon,

I managed to get the shared folders to work in Roundcube. After applying your patch I had to define every shared folder in the main.inc.php file as part of the arrary.

$rcmail_configimap_root? = array('INBOX','#shared.folder1, #shared.folder2, #shared.folder3);

Thanks

Rgs
Etienne

[gordonjahn]

That's really weird - I just did the prefix and then could configure them using the usual IMAP subscription configuration page.

That said, if it works, great!

[brandond]

Alec - do you still want a test server with namespace support? I've got Dovecot boxes coming out my ears, and would be glad to set one aside for you to bash on.

[alec]

Yes, I need only an account with configured some namespaces. I'd like to connect to it from my box. Currently I'm a little busy, but I could do some tests later in this month. Write to alec at alec dot pl.

[combatwombat]

Hi .. not sure who ....

I can see that this functionality is planned/going to be put into the mainstream code in 0.5beta, however this lack of capability is the most important issue in RC, it is stopping me from converting 200 users off squirrelmail (cyrus backend). SM, Hastymail and everyone else supports it, but RC doesnt.. can it be bought forward, I think a lot of potential users are just waiting for this and they will throw the switch.

Rgds
John

[alec]

This is "lack of capability", not a bug. Please, don't change the milestone.

[kaz]

Has anyone rediffed this patch against 0.4?

[glen]

i've rediffed against 0.4, works for me:

$rcmail_config['imap_root'] = array('INBOX', 'shared');

using courier-imap 4.8.0

​http://cvs.pld-linux.org/cgi-bin/cvsweb.cgi/packages/roundcubemail/shared-folders.patch?rev=1.3

[alec]

I've prepared a patch for svn-trunk. On servers with NAMESPACE support no configuration is required. On servers without NAMESPACE support you'll need to set imap_personal (old imap_root) and imap_shared options.

[pawelz]

It breaks my roundcube installation. I tested it on PLD Linux, version posted by glen (​http://cvs.pld-linux.org/cgi-bin/cvsweb.cgi/packages/roundcubemail/shared-folders.patch?rev=1.3).

Since I applied this patch I'm able to acces only inbox. All other, shared and private, folders are gone.

Also I don't understand what exactly this patch is supposed to do. Shared folders work perfectly for me without this patch.

Please, do not apply this patch.

My environment is:

• roundcube 0.4.2, php-5.3.3, PLD Linux
• dovecot 1:1.2.13-1~bpo50+1, Debian Lenny (accessed via imapproxy 1.2.6-5, also on Debian Lenny)

PS.: Feel free to contact me if you need additional information about my environemnt. I can test new versions of this patch or/and configuration changes.

[pawelz]

I added the following line to the config file:

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

and now it works again for me.

[alec]

The patch is for svn-trunk version and with this patch applied imap_root option doesn't exist. Contact me (alec at alec.pl) if you can provide a test account that I could connect from my box.

[fraggy]

Hi
the new patch works around 50% ;)
Now I can see all shared folders but I don't have access... the folder path is not correct.
"Server Error: STATUS: Mailbox doesn't exist:"

We are using dovecot mailserver. All shares are stored in Maildir/shared/from.user/....
like: shared/max.muster/.testshare or shared/max.muster/.testshare.sub1
the new patch is searching for: shared.max\2emuster.testshare or shared.max\2emuster.testshare.sub1

These search strings are correct for all "normal" folders but not for shared folders!
The normal folder hierarchy separator is a dot and a dot in the foldername has the string "\2e" as separator

So what I need is
shared/user.who.shares/.sharedfolders.maybewithsub instead of
shared.user\2ewho\2eshares.sharedfolders.maybewithsub

feel free to ask me, if you don't understand my confusing description :D

[alec]

@fraggy: what do you have in imap_delimiter, imap_personal and imap_shared options? Does your server support NAMESPACE extension? Enable imap_debug and attach the log (or send it to me).

[fraggy]

main.inc.php

$rcmail_config['imap_delimiter'] = '/';
$rcmail_config['imap_personal'] = NULL; 
$rcmail_config['imap_shared'] = NULL;

dovecot config

namespace private {
   separator = /
   prefix = INBOX/
   ....
}

namespace shared {
   separator = /
   # %%n, %%d and %%u are expanded to the destination user.
   prefix = shared/%%u/
   # List the shared/ namespace only if there are visible shared mailboxes.
   list = children
   ....
}

imap log

[02-Nov-2010 13:33:54 +0100]: C: A0023 STATUS INBOX/shared/adam.marsch (UNSEEN)
[02-Nov-2010 13:33:54 +0100]: S: A0023 NO Mailbox doesn't exist: shared.adam\2emarsch
[02-Nov-2010 13:33:54 +0100]: C: A0024 SELECT INBOX/shared/adam.marsch
[02-Nov-2010 13:33:54 +0100]: S: A0024 NO Mailbox doesn't exist: shared.adam\2emarsch
[02-Nov-2010 13:33:54 +0100]: C: A0025 STATUS INBOX/shared/adam.marsch/testshare (UNSEEN)
[02-Nov-2010 13:33:54 +0100]: S: A0025 NO Mailbox doesn't exist: shared.adam\2emarsch.testshare
[02-Nov-2010 13:33:54 +0100]: C: A0026 SELECT INBOX/shared/adam.marsch/testshare
[02-Nov-2010 13:33:54 +0100]: S: A0026 NO Mailbox doesn't exist: shared.adam\2emarsch.testshare
[02-Nov-2010 13:33:54 +0100]: C: A0027 STATUS INBOX/shared/adam.marsch/testshare/subfolder1 (UNSEEN)
[02-Nov-2010 13:33:54 +0100]: S: A0027 NO Mailbox doesn't exist: shared.adam\2emarsch.testshare.subfolder1
[02-Nov-2010 13:33:54 +0100]: C: A0028 SELECT INBOX/shared/adam.marsch/testshare/subfolder1
[02-Nov-2010 13:33:54 +0100]: S: A0028 NO Mailbox doesn't exist: shared.adam\2emarsch.testshare.subfolder1

correct values are shared/adam.marsch ; shared/adam.marsch/.testshare ; shared/adam.marsch/.testshare.subfolder1

[alec]

I'd like to see, what is returned for NAMESPACE command.

[fraggy]

something like this?

[02-Nov-2010 13:33:54 +0100]: S: * NAMESPACE (("INBOX/" "/")) (("shared/" "/")) NIL

I'll delete all privat log entries and send the log file to you

[alec]

Here's the problem. My patch works only with personal and public namespaces. It doesn't work with shared (others). I'll work on this.

[alec]

BTW, you could check with imap_shared="shared/" and imap_personal="INBOX/".

[fraggy]

had no luck with imap_shared and imap_personal :/

[alec]

Because namespace/delimiter settings are cached in session, you'll need to re-login after config changes. Write to alec at alec.pl, we'll continue there. Please, do logout, clear the log, and login. Sent me the complete log.

[alec]

I've fixed the patch. @fraggy confirmed it's working for him.

[alec]

Patch applied in [00290a60].