Alternate SM Mod

[TheAngryPenguin]

I have put together an alternate SquirrelMail Mod that's preconfigured for hMailServer. Prepared from version 1.4.5, this build "contains a number of fixes, including a few extra security issues uncovered" from prior versions of SquirrelMail. You can grab the 7-Zip archive here [531,589 bytes] or the regular Zip archive here [1,087,391 bytes].

MD5 sums:
[See Below...]

Requirements:

• A working hMailServer installation
  
  A working web server with support for PHP 4 -- Being derived from the stable branch of SquirrelMail, this script is not compatible with PHP 5. See SquirrelMailRequirements for more info. -- PHP 5 is now supported -- see below...

Notes:

• /config/config.php -- line 110 needs to be changed.
  
  IMAP folders have been configured for Microsoft Outlook and Outlook Express users. Deleted Items, Sent Items and Drafts will be automatically created when a user logs into SM for the first time. See lines 281-325 for more information. Mozilla Thunderbird users will probably prefer a different configuration.
  
  /data/default_pref has been customized -- if you don't like it, the original is located at /data/default_pref.orig (the attributes set in /data/default_pref are copied to all new users the first time they log into SM).
  
  /data/login_alias.pref can allow customized usernames. This is especially useful if you want to eliminate the "@domain.com" during the login process. An example has been commented out in the file.
  
  /locale/timezones.cfg -- Due to a bug in SquirrelMail, an alternate /locale/timezones.cfg has been added. The original is located at /locale/timezones.cfg.orig
  
  /plugins -- the following plugins are included:
  
  • abook_import_export
    abook_take
    address_add
    administrator
    archive_mail
    askuserinfo
    autocomplete
    bug_report
    calendar
    compatibility
    delete_move_next
    filters
    folder_sizes
    fortune
    hmailserver_changepass [from hMS v3.4.1-B86]
    hmailserver_vacation [from hMS v3.4.1-B86]
    html_mail (updated with SM 1.4.5 release)
    info
    listcommands
    login_alias
    mail_fetch
    message_details
    msg_flags
    newmail
    sent_subfolders
    spamcop
    squirrelspell
    timeout_user
    translate
    unsafe_image_rules
    vlogin
  However, not everything above is enabled. See /config/config.php, lines 734-772 for more information.

Edit [20050414]:

In hindsight, I probably should have originally included this in the notes:

hMS Plugins -- as noted above, this script comes with the Vacation Message and Change Password plug-ins pre-installed. They are from version 3.4.1-B86. They should be backwards-compatible with prior versions of hMS to an extent, but if you're running a newer version, especially v4, it is recommend that you 'refresh' all hMS plug-ins after installing this mod. Simply copy ../hMailServer/Addons/Squirrelmail Plugins/* on top of the existing directories and files in ../plugins/ -- don't forget to repeat this step whenever you upgrade hMS.

Edit [20050414]:

Added "Requirements" section...

Edit [20050718]:

I am pleased to announce that the Alternate SM Mod has been updated. Based on SquirrelMail 1.4.5, it is highly recommend that you replace your current version with this update, for many vulnerabilites have been addressed; and the fact that this release supports PHP 5 makes it superior to the prior package.

• Changes
  ----------
  
  SquirrelMail Changelog
  
  SMTP AUTH is now enabled by default.
  
  The HTML Mail plug-in has been added and is preconfigured to work out of the box.
  
  Vacation Message and Change Password plug-ins have been taken from hMailServer version 4.0-B125. As always, it is recommended that you refresh these plug-ins.
  
  As before, you will need to modify line 110 in /config/config.php for new installs

If you're upgrading from the prior version, you should back up or rename /config/config.php before extracting/copying this package on top of what you already have. The changes to /config/config.php are minimal, so your older version should work fine.

Since there are vulnerabilites in the older version, I will no longer make it available. The new version of this mod can be downloaded from the same place(s) as the original in 7-Zip (1,078,715 bytes) or Zip (2,399,841 bytes) format. Here are the MD5 checksums:

• f42c2fcbfcc703b98affce346b8655fa *hms_squirrelmail.7z
  173da1c7e71be59ecc730fb7bf6c8d22 *hms_squirrelmail.zip

Enjoy!

Edit [20050727]:

Now the this package is enjoying more widespread use, it has come to my attention that some users have been automatically logged out when composing a message. This will apparently only happen if it takes longer than 10 minutes to compose a message. I'm not sure if it's a bug in the plug-in or not, but I think it shouldn't be happening during composition. You can either disable the "timeout_user" plug-in by commenting out the plug-in itself in /config/config.php or you can adjust its settings in /plugins/timeout_user/config.php. I will either disable it or change the timeout to 30 minutes in the next version. Let me know what you think.

[JustinF]

Hey, thanks a lot! I just downloaded and installed it...so far it works great.

[TheAngryPenguin]

No problem. Feel free to comment on how it's setup and whatnot. It's actually not a difficult thing to do -- I just wanted to start from scratch and build it up so that I could learn more about the SM script. If more people become interested in it, I wouldn't mind at all making it into a regular thing.

[GlenC]

Looks really good. I had one problem installing and not really sure why. The vacation message plugin was coming up as a blank screen. I copied my old options.php over from the previous version and it now works fine.

You really did a nice job with this, thanks!

[TheAngryPenguin]

Looks really good. I had one problem installing and not really sure why. The vacation message plugin was coming up as a blank screen. I copied my old options.php over from the previous version and it now works fine.

You really did a nice job with this, thanks!

Thank you. About the options.php issue with the Vacation Message plug-in -- if you still have the version from my package, please compare it with your version that works. That particular file should be replaced every time you upgrade your build (along with everything else in hmailserver_vacation as well as with hmailserver_changepass and PHPWebAdmin). At any rate, it should be identical to the one in ../hMailServer/Addons/Squirrelmail Plugins/hmailserver_vacation -- not sure if it has changed in version 4 builds of hMS...

[GlenC]

if you still have the version from my package, please compare it with your version that works.

You're right, I'm using version 4. Here are the diffs:

Your New:

Code: Select all

25     include_once (SM_PATH . 'plugins/hmailserver_vacation/config.php');
32     include_once ('../plugins/hmailserver_vacation/config.php');
183    $hCOMApp = new COM("hCOM.BaseApp");

My Old:

Code: Select all

181     $hCOMApp = new COM("hMailServer.Application");

[pjcarmen]

Sweet! I'm going downloading now, and will take it for a spin soon!

Thanks

-P

[casualonejp]

Seems to work except for one thing, when I login the left frame does not show up. The right frame comes up fine but when clicking on the folders option at the top, it goes to password or username incorrect error. Also when you first login and try to enter your personal information, after you log out and log back in again it says the same error about the password and username being incorrect and the only way to get the right frame to come back up again is to delete the prefs file that was created when you entered the personal informaiton.

Configuration....
Hmailserver: 4.0 build 100
Win 2000 Server
IIS 5
PHP 5.0.3

[TheAngryPenguin]

From SquirrelMailRequirements: "Current stable versions of SquirrelMail do not work with PHP5" -- Looks like your SOL if you want to keep PHP at version 5.0.3 -- However, you 'should' be able to get the latest development version of SM (from CVS) to run with PHP>4... I'll add a requirements section to my OP...

[satanuke]

Great job. This looks very good. Can I include this on NetServer instead of the official hMailServer squirrelmail mod?

[TheAngryPenguin]

Absolutely!

Thanks!

[satanuke]

This looks much better than the other. It has the same feature and has a better look.

[kblood]

Mmm... according to the changelog of SquirrelMail itself, it should work fine with PHP 5 from version 1.4.3-RC1:
http://www.squirrelmail.org/changelog.php

- Fix SquirrelMail to work with PHP5.

So maybe that wiki page of SquirrelMail is outdated? Well, in any case, I am going to try version 1.4.5 from CVS snapshot...
(I don't want to switch to PHP4...)

Pity, though, this modified version looks nice!

[TheAngryPenguin]

Mmm... according to the changelog of SquirrelMail itself, it should work fine with PHP 5 from version 1.4.3-RC1:
http://www.squirrelmail.org/changelog.php

- Fix SquirrelMail to work with PHP5.

So maybe that wiki page of SquirrelMail is outdated? Well, in any case, I am going to try version 1.4.5 from CVS snapshot...
(I don't want to switch to PHP4...)

Pity, though, this modified version looks nice!

If you want to use an unstable version, you can do the following to retain the look and feel of my package:

• * Install unstable version
  * Copy the 'plugins' directory from my package on top of the unstable version
  * Copy the 'data' directory from my package on top of the unstable version
  * Copy the 'config' directory from my package on top of the unstable version
  * Copy the 'themes' directory from my package on top of the unstable version
  * Optionally, copy the 'locale' directory from my package on top of the unstable version (not sure if they've been working on the timezone issue)

I don't see any reason why it shouldn't work, but if it were me, I'd build it from the ground up, or at least take some time to understand the differences of the files that you're relacing potentially older versions with.

Again, if there's enough interst in this package, I'll definitely continue to develop it.

[pjcarmen]

Again, if there's enough interst in this package, I'll definitely continue to develop it.

I installed, this and it worked right away, very nicely done. Keep up the good work!

[TheAngryPenguin]

Many thanks (again). I'm still trying to figure out which one is more accurate: AWStats, Webalizer or Analog. In either case there have been at least 20 requests for the package so far, and I'm glad that it's being received so well. If you'd like to see anything changed, or have any recommendations or other comments, I'm all ears!

[deon]

Very nice work!

I just have one question dealing with the interface. No problems with operation or function. The left frame folders show text only, no icons and no collapse capability. Any idea?

Running Windows 2003 Server, Apache, PHP 5.0.3, MySQL

Thanks,
Deon

[TheAngryPenguin]

...I just have one question dealing with the interface. No problems with operation or function. The left frame folders show text only, no icons and no collapse capability. Any idea?

Hmm... Not sure about the icons -- they didn't exist (or at least weren't enabled) by default from the source package. The only thing I changed about the folder list frame was it's width. There is a text link to icon plug-in that comes preinstalled with the official mod -- but I never cared for it that much -- I think SM performs best when it's as light as it can be. Feel free to grab it from there and bring into this mod -- maybe this is what you're desiring.

The grouping of your folders can be changed in config.php -- look at lines 327 to ~400. I'm pretty sure that you can accomidate something like this by changing one or some of these attributes. Again, if you prefer the look and feel of the official mod, duplicate its settings into this mod.

Please post back here with your results. I'm sure that someone will find this information helpful in the future.

[deon]

OK ... I just replaced the file left_main.php in the src folder with the one from the original mod for hmail. I don't have time to look at what the difference is in code but will try later on. It seems to have not adversely effected anything and it added the tiny .png icons next to the appropriate text.

Thanks,
Deon

[kermitfla3640]

It look's like the images on the left side (Folder list) were added by the first SquirrelMail Mod for hMailserver (SquirrelMail for hMailServer Mod 0.1). The latest (1.4.4, from http://www.squirrelmail.org) also does not include the image support. That being said, I did a diff on the original Mod and your update to bring the images back . Below are the results (watch for extra line wraps!):

Code: Select all

76a77
>         $line .= '<img src="../images/inbox.png" border="0" height="16" width="16" style="vertical-align: bottom;" alt="'. _("INBOX") .'" title="'. _("INBOX") .'">';
77a79,87
>     } elseif ( $real_box == $draft_folder){
>         $line .= '<img src="../images/draft.png" border="0" height="16" width="16" style="vertical-align: middle;" alt="'. $mailbox .'" title="'. $mailbox .'">';
>         $line .= str_replace(array(' ','<','>'),array('&nbsp;','<','>'),$mailbox);
>     } elseif ( $real_box == $sent_folder){
>         $line .= '<img src="../images/senti.png" border="0" height="16" width="16" style="vertical-align: middle;" alt="'. $mailbox .'" title="'. $mailbox .'">';
>         $line .= str_replace(array(' ','<','>'),array('&nbsp;','<','>'),$mailbox);
>     } elseif ( $real_box == $trash_folder){
>         $line .= '<img src="../images/delitem.png" border="0" height="16" width="16" style="vertical-align: middle;" alt="'. $mailbox .'" title="'. $mailbox .'">';
>         $line .= str_replace(array(' ','<','>'),array('&nbsp;','<','>'),$mailbox);
78a89
>         $line .= '<img src="../images/folder.png" border="0" height="16" width="16" style="vertical-align: middle;" alt="'. $mailbox .'" title="'. $mailbox .'">';
180c191
<         $link .= "unfold=$mailbox\">+";
---
>         $link .= "unfold=$mailbox\"><IMG src=\"../images/plus.png\" border=\"0\" height=\"7\" width=\"7\">+";
182c193
<         $link .= "fold=$mailbox\">-";
---
>         $link .= "fold=$mailbox\"><IMG src=\"../images/minus.png\" border=\"0\" height=\"7\" width=\"7\">-";

[TheAngryPenguin]

Nice job, kermitfla3640. I'd prefer to keep this particular SM mod as true to the original as possible (sans the plugins and default theme, of course). I'm sure that anyone else wishing to append this additional eyecandy to the mod will find your post extremely useful. Thanks for your time and effort!

[GlenC]

I found that changing setting "advanced tree" to true will give you nice folder icons on the newer version. I had to change these two lines (lines 561, 562):

Code: Select all

$advanced_tree = true; /* set this to true if you want to see a nicer mailboxtree */
$oldway = false; /* default SM behaviour */

Edit: this is in left_main.php

[john25uk]

I tried that and got an error:

Warning: preg_match() [function.preg-match]: Compilation failed: PCRE does not support \L, \l, \N, \P, \p, \U, \u, or \X at offset 18 in C:\Inetpub\WEBMAIL\functions\imap_mailbox.php on line 93

But I have managed to fix it.

Open .\functions\imap_mailbox.php and goto line 93

you will see this line there:

return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line);

Change the \\Noselect to \\\\Noselect and save

There all fixed. (Well for me anyway.)

[GlenC]

I don't know how in the world you figured THAT out but.. Thanks! I hadn't even noticed that error in my logs until you mentioned it.

[tomaste]

Just wanted to say thanks for putting this package together. A huge time saver!

Also, I'm getting an error when using the change password option:

When I submit on the change password screen:

Warning: (null)(): Invalid ProgID, GUID string, or Moniker: Invalid syntax in C:\YT\Htdocs\webmail\plugins\hmailserver_changepass\options.php on line 284

Fatal error: Call to a member function on a non-object in C:\YT\Htdocs\webmail\plugins\hmailserver_changepass\options.php on line 286

[john25uk]

Have you copied the current plugin files from your installed hMailServer directory (hMailServer\Addons\Squirrelmail Plugins) to the www server squirrelmail plugins diectory?

J

[tomaste]

Have you copied the current plugin files from your installed hMailServer directory (hMailServer\Addons\Squirrelmail Plugins) to the www server squirrelmail plugins diectory?

J

Nope. I even read that I should have, and somehow didnt absorb it. That fixed my problem.

Thanks!

[martin]

TheAngryPenguin:
I think this mod looks neater than the one currently on the download page. Also, this one is much regulary updated than the current one. OK with you if I put up this one there?

[TheAngryPenguin]

No problem. I'd hate for the original author of the mod to think that I'm trying to one-up him, but I felt that there was a need for updated package. You may want to check with him first -- I'll totally understand if he wishes against it. That being the case, if you do make this the somewhat official SM mod for hMS, I'll do everything in my power to keep the package up to date.

[kermitfla3640]

This may or may not be related to your update, but I get an error when replying to a message using the webmail:

Authentication required
Server replied: 530 SMTP authentication is required.

I know I missed something...

[kermitfla3640]

Found the solution... Not related to your mod, you have to change the config.php file to support encoded logins, by default it uses none.

Code: Select all

$smtp_auth_mech = 'login';

[vunguyen]

Found the solution... Not related to your mod, you have to change the config.php file to support encoded logins, by default it uses none.

Code: Select all

$smtp_auth_mech = 'login';

I got the same problem, took me 2 days to re-configure... but didn't work, I changed that line as you stated, it work great !!
thanks kermitfla3640 for sharring !!. good day

[kermitfla3640]

No problem, glad I could help.

[callforsitters]

Does Squirrel Mail NEED MySQL? Can it not use MS SQL?

[TheAngryPenguin]

SM does not require MySQL. And I highly doubt it will support M$ SQL.

[martin]

I'm going to put up this on the download page? I've run it for some time now and really like it. Does this thing have a name except for "Alternate SM mod"?

[TheAngryPenguin]

I haven't really given it much thought. How about something like:

SquirrelMail for hMailServer
hSquirrelMail

Unfortuantely, I have run out of creativity. I think that everyone should post their recommendations and when there are ~3-4 really good ones, create a poll.

[bbarrus]

Angry Penguin,
I have installed your SM mod.
I am still having the same refresh problems.
See Post http://www.hmailserver.com/forum/viewtopic.php?t=1948

Any suggestions?

Thanks

[TheAngryPenguin]

...and I have replied to your post over there

[cgountanis]

Can you make PHP5?

[TheAngryPenguin]

As of this post, the stable version of SquirrelMail is still in "Release Candidate" status -- as soon as 1.4.5 is released, I'll start working on it.

[FAWTS]

Hi TheAngryPenguin,

Can I suck and ask you to add the HTML_mail plugin ???

Thank you!!!

TheSucker

[TheAngryPenguin]

Hi TheAngryPenguin,

Can I suck and ask you to add the HTML_mail plugin ???

Thank you!!!

TheSucker

Not a problem -- It'll be in the next release.

[FAWTS]

Thanks a lot!!!

I use it in the "former" SM for HMS, and it works great !!!

I installed it as well as I could, and I did not had that many problems for it, but I read some people did not have my luck!!!

And maybe I won't have it too when I'll move to your SM version... So if it is already include, it would hepl me a lot!!!!

and so and again :

THANK YOU!!!!!!!

[TheAngryPenguin]

As I previously stated, I am going to wait for SquirrelMail.org to release a new stable version before I prepare the next mod. I know I am being prudent this way, but I feel that it's the right thing to do.

In the meantime, installing a SM plug-in is as simple as extracting the archive, placing it in the plugins directory and adding a reference to it in config.php -- you should be able to do all of the above in less than five minutes.

[FAWTS]

It's what I did, but I was supposed to use patch and the prompt... but I didn't do it and it works anyway!

[maciekp]

Small news update: SquirrelMail 1.4.5 has been released, as well as new PHP 4.4.0.

[TheAngryPenguin]

Thanks for the update -- now I can start getting to work on the version!

[TheAngryPenguin]

Not sure if you guys receive e-mail notifications from edited posts -- See the OP for an important update.

[FAWTS]

Well, I installed your today SM and :

No way to use another language than english, even if I DL the fr_FR files and placed it well, and change config.php to fr_FR.

No way to get icones, even if I change :

$advanced_tree = true; /* set this to true if you want to see a nicer mailboxtree */

and no way to finf $oldway...

Any solution ?

[TheAngryPenguin]

No way to use another language than english, even if I DL the fr_FR files and placed it well, and change config.php to fr_FR.

Not sure about this. Do you think that it might be related to this Tracker item?

No way to get icones, even if I change :

$advanced_tree = true; /* set this to true if you want to see a nicer mailboxtree */

and no way to finf $oldway...

Not sure about this either. If you've got the time and patience, grab the official build here and let us know if you experience the same issues.

[FAWTS]

Well, nothing to do with this tracker as the language option is not empty.

OK, I'll test it!!! I gonna laugh!!!!

[FAWTS]

Hi TheAngryPenguin,

I did what you want, and it works well, you can download it at http://www.tsinformatique.org/hms/SM_by_FAWTS.7z

The size is only 1 275 ko. Ther is a readmefirst.txt file in the archive to explain what I did ont it!

Normaly, you only need to unzip, change the config.php (if you don't understand French, you will have to change fr_FR in en_US) and it works.

For other languages, just download them on SM webSite and unezip them in local, help and images forlders!

[TheAngryPenguin]

Hi TheAngryPenguin,

I did what you want, and it works well, you can download it at http://www.tsinformatique.org/hms/SM_by_FAWTS.7z

The size is only 1 275 ko. Ther is a readmefirst.txt file in the archive to explain what I did ont it!

Normaly, you only need to unzip, change the config.php (if you don't understand French, you will have to change fr_FR in en_US) and it works.

For other languages, just download them on SM webSite and unezip them in local, help and images forlders!

In your config.php I don't see a "global $config_version;" -- not sure if this matters or not. Also, your config.php does not contain "$advanced_tree = true;" -- is this located somewhere else?

As far as the locale issue -- I've just successfully changed my locale to "fr_FR" by downloading the Locales Snapshots and modifying /config/config.php

Remember: The whole point of this mod is to take the offical current SquirrelMail release that's stable and modify it just enough to easily use with hMS. You need to maunally setup non-US locales even with the official build. Adding all locales to this package would make the size ~11MB larger.

[FAWTS]

I reinstalled everything, and now I can get it in French, but it does not refresh with Firefox, only with IE and there is no way to have "the beautifull tree" with Firefox nor IE...

[FAWTS]

Well, I used a lot of pages from the "former" SM mod, and now, the story of the tree is ok. U need to use the main left.php form the old and change the 3 lines as explained before. In the new main left, there isn't the "oldway" line...

About the prob of refresh, I looked for all the pages containing the refresh term in his code, and there're a lot in the folders functions, include and src. I replaced all of them with the old version, and it seems to work. And after a while (it depends, at least around 10 minutes) it stops refreshing. I continue testing it and I try to find why it stop...

I also installed the folder synch plugin, but I'm not sure it is really useful...

If somebody find something more usefull about the refresh story!!!

[FAWTS]

Here a new version of SM for HMS that works perfectly on my computer with ie as well as Firefox : http://www.tsinformatique.org/hms/squir ... for_hms.7z .

To unzip it you will need 7zip http://www.7-zip.org/ .

Normaly, you only have to unzip it to your www folder.
edit the config.php in the config folder to check your domain name and your language (all the languages are include, to find the code of yours, just go to the locale folder and find it).

The icons stuff come from 2 differents plugins : image_buttons and msg_flags. and to make those plugins works, you need to modify other pages in src and functions. Here it is already done.

I still haven't found why it did not refresh with TheAngryPenguin version, but here it should!!!

Tell me what you think about this version and I still want to understand this refreshing story !!!!

[FAWTS]

Well, I tried a lot of stuff, but eventualy, no way to make Firefox refresh everytime and I still haven't found what makes it stop refreshing...

Maybe the 1.0.6 version will sove this prob, but I will wait a bit before installing is as I read many people got problems with it...

So while you use SM, the best seems to be ie...

[TheAngryPenguin]

No problems with the auto-refresh here. Keep in mind that in my package, "timeout_user" is enabled by default. It's set for 10 minutes of inactivity. Perhaps you're running some kind of software that's inadvertantly disabling the javascript (or whatever language) used to trigger the "Auto Refresh Folder List" feature. Again, I'm having no problems whatsoever with both IE and Firefox (1.0.5 and 1.0.6). Is anyone else?

[FAWTS]

I have disable the time_out plugin after it closed a session while I was writting a very long and very important mail!!!

And I don't have this prob with the former SM mod...

I lefte a Firefos windows open with a SM session running the all night, and it refreshed until I woke up and I read my mails...

It is really strange. I nearly would have prefered that refreshing doesn't work at all than sometimes it works and sometimes not...

Anybody else has this problem?