{"id":689,"date":"2021-07-23T12:35:44","date_gmt":"2021-07-23T12:35:44","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/how-to-customize-squirrelmail\/"},"modified":"2021-07-23T12:35:44","modified_gmt":"2021-07-23T12:35:44","slug":"how-to-customize-squirrelmail","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/how-to-customize-squirrelmail\/","title":{"rendered":"How to Customize SquirrelMail"},"content":{"rendered":"<\/p>\n
\n
<\/div>\n
\n
\n
Warnings:<\/div>\n
\n
    \n
  • This document is only<\/strong> valid for cPanel & WHM version 72 and earlier.\n
      \n
    • We deprecated SquirrelMail and its functionality in cPanel & WHM version 76 and earlier and removed it in cPanel & WHM version 78.<\/li>\n
    • For more information about SquirrelMail\u2019s deprecation and removal, read our cPanel Deprecation Plan documentation.<\/li>\n<\/ul>\n<\/li>\n
    • Because cPanel, L.L.C. doesn\u2019t develop SquirrelMail, cPanel Technical Support can\u2019t help with customization.<\/li>\n<\/ul><\/div>\n<\/div>\n

      Overview<\/h2>\n

      This document explains how cPanel & WHM versions 11.44 and earlier update the SquirrelMail webmail application, and how you can customize your SquirrelMail installation.<\/p>\n

      \n
      Important:<\/div>\n
      \n
        \n
      • In cPanel & WHM version 56 through 74, we shipped SquirrelMail as an RPM. To customize your SquirrelMail RPM, follow the directions in the How to Build and Install Custom RPMs documentation.<\/li>\n
      • Customization of SquirrelMail gives you full control over the end user experience. However, cPanel, L.L.C. does not<\/strong> support these customizations.<\/li>\n<\/ul><\/div>\n<\/div>\n

        General installation procedure<\/h2>\n

        Before you customize your SquirrelMail installation, it is useful to understand how cPanel & WHM updates SquirrelMail.<\/p>\n

          \n
        1. The \/scripts\/upcp<\/code> script runs to update cPanel & WHM.<\/li>\n
        2. It also executes the \/usr\/local\/cpanel\/install\/webmail<\/code> script.<\/li>\n
        3. The \/usr\/local\/cpanel\/install\/webmail<\/code> script then executes the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script.<\/li>\n<\/ol>\n

          The \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script performs the following actions:<\/p>\n

            \n
          1. \n

            It uses the following command to remove the current SquirrelMail installation:\n<\/p>\n

            \n
            rm -<\/span>rf \/usr\/<\/span>local\/cpanel\/<\/span>base\/3rdparty\/s<\/span>quirrelmail<\/code><\/pre>\n<\/div>\n<\/li>\n
          2. \n
            It extracts the appropriate SquirrelMail source tarball to the \/usr\/local\/cpanel\/base\/3rdparty\/<\/code> directory.<\/p>\n
            \n
            Note:<\/div>\n
            \n
            For more information, read the Where to place a custom SquirrelMail tarball section below.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n
          3. \n
            It changes the ownership of the SquirrelMail installation to the root<\/code> user and the wheel<\/code> group.<\/p>\n<\/li>\n
          4. \n
            It changes the SquirrelMail data directory\u2019s permissions to 755<\/code>.<\/p>\n<\/li>\n
          5. \n
            It checks for the existence of the \/var\/cpanel\/squirrelmail\/install<\/code> file.<\/p>\n
            \n
            Note:<\/div>\n
            \n
            For more information, read the Prevent changes to the SquirrelMail configuration files section below.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n
          6. \n
            It extracts IMAP configuration values and copies them into place.<\/p>\n<\/li>\n<\/ol>\n
            Prevent changes to the SquirrelMail configuration files<\/h3>\n
            During Step 5 of the installation procedure, the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script checks for the existence of the \/var\/cpanel\/squirrelmail\/install<\/code> file.<\/p>\n
              \n
            • \n
              If that file exists and is executable, the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script executes it and terminates.<\/p>\n
              \n
              Notes:<\/div>\n
              \n
                \n
              • This bypasses cPanel & WHM\u2019s manipulation of the SquirrelMail configuration files.<\/li>\n
              • Step 6 of the installation procedure does not<\/strong> occur.
                \n<\/li>\n<\/ul><\/div>\n<\/div>\n<\/li>\n
              • \n
                If the \/var\/cpanel\/squirrelmail\/install<\/code> file exists but is not<\/strong> executable, the file contents print to STDOUT<\/code> and the normal cPanel & WHM configuration of SquirrelMail continues for the remaining steps.<\/p>\n<\/li>\n<\/ul>\n
                Install a customized instance of SquirrelMail<\/h2>\n
                There are several ways to customize the SquirrelMail installation. For instructions on how to create a custom SquirrelMail tarball, read the SquirrelMail documentation.<\/p>\n
                Where to place a custom SquirrelMail tarball<\/h3>\n
                For more information about how to place a custom SquirrelMail tarball, read the following non-sequential steps:<\/p>\n
                  \n
                • \n
                  When the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script runs, it checks for custom SquirrelMail tarballs. The following list lists the locations it checks:<\/p>\n
                    \n
                  • \/var\/cpanel\/squirrelmail\/squirrelmail-$sqversion-local.tar.gz<\/code> \u2014 Use this location for a compressed tarball that you want to apply to a specific SquirrelMail version.<\/li>\n
                  • \/var\/cpanel\/squirrelmail\/squirrelmail-$sqversion-local.tar<\/code> \u2014 Use this location for an uncompressed tarball that you want to apply to a specific SquirrelMail version.<\/li>\n
                  • \/var\/cpanel\/squirrelmail\/squirrelmail-local.tar.gz<\/code> \u2014 Use this location for a compressed tarball that you want to apply to SquirrelMail regardless of version.<\/li>\n
                  • \/var\/cpanel\/squirrelmail\/squirrelmail-local.tar<\/code> \u2014 Use this location for an uncompressed tarball that you want to apply to SquirrelMail regardless of version.\n
                    \n
                    Notes:<\/div>\n
                    \n
                    If any of those tarballs exist, the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script uses that tarball instead of the cPanel-supplied tarball. cPanel & WHM uses the locations in the above list in the listed order.
                    \n  For example, if the following statements are true, cPanel & WHM uses the \/var\/cpanel\/squirrelmail\/squirrelmail-1.49a-local.tar.gz<\/code> file:
                    \n  * Both the \/var\/cpanel\/squirrelmail\/squirrelmail-local.tar<\/code> and \/var\/cpanel\/squirrelmail\/squirrelmail-1.49a-local.tar.gz<\/code> files exist.
                    \n  * The \/var\/cpanel\/squirrelmail\/squirrelmail-1.49a-local.tar.gz<\/code> file\u2019s version number is specified in the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n<\/ul>\n<\/li>\n
                  • \n
                    The value that $sqversion<\/code> represents in these locations must<\/strong> match the sqversion<\/code> variable that the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script defines. For example, if the sqversion<\/code> parameter is set to the 1.49a<\/code> version in the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script, save your custom tarball as the squirrelmail-1.49a-local.tar.gz<\/code> file.<\/p>\n
                    \n
                    Important:<\/div>\n
                    \n
                    These tarballs must<\/strong> extract to the \/usr\/local\/cpanel\/base\/3rdparty\/squirrelmail\/<\/code> directory.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n<\/ul>\n
                    Where to place a custom overlay file<\/h3>\n
                    For more information about how to place a custom overlay file, read the following non-sequential steps:<\/p>\n
                      \n
                    • \n
                      The overlay tarball allows you to customize specific aspects of SquirrelMail.<\/p>\n
                      \n
                      Note:<\/div>\n
                      \n
                      For example, you can use an overlay to change graphics, themes, or plugins.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n
                    • \n
                      The overlay does not<\/strong> need to contain a complete SquirrelMail distribution. It only needs to contain the components that you wish to modify, because cPanel & WHM overlays it onto the SquirrelMail installation.<\/p>\n
                      \n
                      Note:<\/div>\n
                      \n
                      For example, it can contain one image file. However, it must<\/strong> contain a directory structure that mimics the structure of the \/usr\/local\/cpanel\/base\/3rdparty\/squirrelmail<\/code> directory, that that starts with squirrelmail<\/code>.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n
                    • \n
                      Once you determine which tarball to use for the source install and extract it, the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script checks for the following files:<\/p>\n
                        \n
                      • \/var\/cpanel\/squirrelmail\/overlay.$sqversion.tar.gz<\/code> \u2014 Use this location for a compressed overlay you want to apply to a specific SquirrelMail version.<\/li>\n
                      • \/var\/cpanel\/squirrelmail\/overlay.$sqversion.tar<\/code> \u2014 Use this location for an uncompressed overlay you want to apply to a specific SquirrelMail version.<\/li>\n
                      • \/var\/cpanel\/squirrelmail\/overlay.tar.gz<\/code> \u2014 Use this location for a compressed overlay you want to apply to SquirrelMail regardless of version.<\/li>\n
                      • \/var\/cpanel\/squirrelmail\/overlay.tar<\/code> \u2014 Use this location for an uncompressed overlay you want to apply to SquirrelMail regardless of version.\n
                        \n
                        Note:<\/div>\n
                        \n
                        As with the custom SquirrelMail tarballs above, the following statements are true:
                        \n  * If the script locates multiple tarballs, it will use them in the order that is listed above.
                        \n  * The value of the $sqversion<\/code> variable must<\/strong> match the version number that the \/usr\/local\/cpanel\/bin\/update-squirrelmail<\/code> script specifies.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
                        Install SquirrelMail plugins<\/h2>\n
                        To enable a SquirrelMail plugin, perform the following steps:<\/p>\n
                          \n
                        1. \n
                          Run the \/usr\/local\/cpanel\/base\/3rdparty\/squirrelmail\/config\/conf.pl<\/code> command to open the SquirrelMail Configuration menu.<\/p>\n<\/li>\n
                        2. \n
                          Enter the number of the Plugins<\/code> option. The code block below lists the available SquirrelMail plugins that appear:\n<\/p>\n
                          \n
                          \n\n\n
                          \n
                           1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span>11\n<\/span>12\n<\/span>13\n<\/span>14\n<\/span>15\n<\/span>16\n<\/span>17\n<\/span>18\n<\/span>19\n<\/span>20\n<\/span>21\n<\/span>22\n<\/span><\/code><\/pre>\n<\/td>\n
                          		\n
                            Plugins<\/span>\n  Installed<\/span> Plugins<\/span>\n    1.<\/span> Login<\/span> Authentication<\/span> (login_auth<\/span>) 3.0<\/span>\n  Available<\/span> Plugins<\/span>:\n    2.<\/span> administrator<\/span>\n    3.<\/span> Bug<\/span> Report<\/span> (bug_report<\/span>) CORE<\/span>\n    4.<\/span> calendar<\/span>\n    5.<\/span> change_password<\/span> 0.2<\/span>\n    6.<\/span> Demo<\/span> (demo<\/span>) CORE<\/span>\n    7.<\/span> filters<\/span>\n    8.<\/span> fortune<\/span>\n    9.<\/span> info<\/span>\n    10.<\/span> listcommands<\/span>\n    11.<\/span> mail_fetch<\/span>\n    12.<\/span> message_details<\/span>\n    13.<\/span> New<\/span> Mail<\/span> (newmail<\/span>) CORE<\/span>\n    14.<\/span> Preview<\/span> Pane<\/span> (preview_pane<\/span>) 2.0<\/span>\n    15.<\/span> sent_subfolders<\/span>\n    16.<\/span> spamcop<\/span>\n    17.<\/span> squirrelspell<\/span> 0.5<\/span>\n    18.<\/span> Test<\/span> (test<\/span>) CORE<\/span>\n    19.<\/span> translate<\/span><\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n<\/li>\n
                        3. \n
                          Enter the number of the plugin that you wish to install.<\/p>\n<\/li>\n
                        4. \n
                          Save your changes and exit the SquirrelMail Configuration menu.<\/p>\n<\/li>\n<\/ol>\n
                          To test your new SquirrelMail configuration, navigate to example.com\/sessionid\/3rdparty\/SquirrelMail\/src\/configtest.php<\/code>, where example.com<\/code> represents your domain name, and sessionid<\/code> represents your current security token.<\/p>\n
                          \n
                          Important:<\/div>\n
                          \n
                          Before you run the configuration test for SquirrelMail from a remote server, you must<\/strong> add the following line to the \/usr\/local\/cpanel\/base\/3rdparty\/squirrelmail\/config\/config_local.php<\/code> file:\n<\/p>\n
                          \n
                              $<\/span>allow_remote_configtest<\/span> = true<\/span>;<\/code><\/pre>\n<\/div><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
                          Warnings: This document is only valid for cPanel & WHM version 72 and earlier. We deprecated SquirrelMail and its functionality in cPanel & WHM version 76 and earlier and removed it in cPanel & WHM version 78. For more information about SquirrelMail\u2019s deprecation and removal, read our cPanel Deprecation Plan documentation. Because cPanel, L.L.C. doesn\u2019t …<\/p>\n","protected":false},"author":1,"featured_media":690,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/689"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=689"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/689\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/690"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=689"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=689"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=689"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}