{"id":760,"date":"2021-07-23T12:37:31","date_gmt":"2021-07-23T12:37:31","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/importing-squirrelmail-address-books-to-roundcube\/"},"modified":"2021-07-23T12:37:31","modified_gmt":"2021-07-23T12:37:31","slug":"importing-squirrelmail-address-books-to-roundcube","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/importing-squirrelmail-address-books-to-roundcube\/","title":{"rendered":"Importing SquirrelMail Address Books to Roundcube"},"content":{"rendered":"<\/p>\n
\n
<\/div>\n
\n

Overview<\/h2>\n
\n
Warning:<\/div>\n
\n
    \n
  • This document is only<\/strong> valid for cPanel & WHM versions 78 and 80.<\/li>\n
  • Roundcube version 1.3.8 and earlier does not support email addresses that contain Unicode characters.<\/li>\n
  • We recommend that only experienced server administrators perform the steps in this document.<\/li>\n
  • Because cPanel, L.L.C. doesn\u2019t develop SquirrelMail, cPanel Technical Support can\u2019t help with address book imports.<\/li>\n<\/ul><\/div>\n<\/div>\n
    \n
    Note:<\/div>\n
    \n

    For instructions on how to migrate SquirrelMail address books to Horde, read our Importing SquirrelMail Address Books to Horde documentation.<\/p>\n<\/p><\/div>\n<\/div>\n

    This document describes the roundcube_squirrelmail_contact_import plugin.<\/p>\n

    We deprecated<\/strong> SquirrelMail in cPanel & WHM version 74 and removed it in cPanel & WHM version 78. The roundcube_squirrelmail_contact_import<\/code> plugin migrates a SquirrelMail user\u2019s email contact list to their Roundcube address book. When a Roundcube user logs in to their email account after the hosting provider installs the plugin, the system migrates the user\u2019s SquirrelMail contacts to Roundcube.<\/p>\n

    Install and uninstall the plugin<\/h2>\n

    To install the plugin, run the following command as the root<\/code> user:\n<\/p>\n

    \n
    yum install roundcube-<\/span>squirrelmail-<\/span>contacts-<\/span>import-<\/span>plugin<\/code><\/pre>\n<\/div>\n
    The system adds the following files to the \/usr\/local\/cpanel\/base\/3rdparty\/roundcube\/plugins\/<\/code> directory:\n<\/p>\n
    \n
    \n\n\n
    \n
    1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span><\/code><\/pre>\n<\/td>\n
    		\n
    cpanel_squirrelmail_contact_import<\/span>\/<\/span>\ncpanel_squirrelmail_contact_import<\/span>\/<\/span>config<\/span>.inc<\/span>.php<\/span>\ncpanel_squirrelmail_contact_import<\/span>\/<\/span>config<\/span>.inc<\/span>.php<\/span>.dist<\/span>\ncpanel_squirrelmail_contact_import<\/span>\/<\/span>cpanel_squirrelmail_contact_import<\/span>.php<\/span>\ncpanel_squirrelmail_contact_import<\/span>\/<\/span>LICENSE<\/span>.md<\/span><\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
    To uninstall the plugin, run the following command: <\/p>\n
    \n
    yum remove roundcube-<\/span>squirrelmail-<\/span>contacts-<\/span>import-<\/span>plugin<\/code><\/pre>\n<\/div>\n
    Configuration options<\/h2>\n
    You can configure the following options for the plugin in the \/usr\/local\/cpanel\/base\/3rdparty\/roundcube\/plugins\/cpanel_squirrelmail_contact_import\/config.inc.php<\/code> file:<\/p>\n\n\n\n\n\n\n\n\n\n\n
    Option<\/th>\nDescription<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
    cpanel_squirrelmail_data_dir<\/code><\/td>\nSets the full path to the SquirrelMail data directory.<\/td>\n\n
    \n
    $config['cpanel_squirrelmail_data_dir'<\/span>] =<\/span> getenv('HOME'<\/span>).<\/span> '\/.sqmaildata'<\/span>;<\/code><\/pre>\n<\/div>\n<\/td>\n<\/tr>\n
    cpanel_squirrelmail_run_once<\/code><\/td>\nCreates a touch file in the cpanel_squirrelmail_data_dir<\/code> to prevent the plugin from running more than once.<\/td>\n\n
    \n
    $config['cpanel_squirrelmail_run_once'<\/span>] =<\/span> true;<\/code><\/pre>\n<\/div>\n<\/td>\n<\/tr>\n
    cpanel_squirrelmail_unique<\/code><\/td>\nChecks for duplicate email addresses.<\/td>\n\n
    \n
    $config['cpanel_squirrelmail_unique'<\/span>] =<\/span> false;<\/code><\/pre>\n<\/div>\n<\/td>\n<\/tr>\n
    cpanel_squirrelmail_group_name<\/code><\/td>\nCreates a new email folder for imported SquirrelMail contacts.<\/p>\n
    \n
    Note:<\/div>\n
    \n        If you enable this option and set the cpanel_squirrelmail_unique<\/code> option to true, the system adds any duplicate email addresses to new email groups.\n    <\/div>\n<\/div>\n<\/td>\n
    		\n
    \n
    $config['cpanel_squirrelmail_group_name'<\/span>] =<\/span> 'SquirrelMail Contacts'<\/span>;<\/code><\/pre>\n<\/div>\n<\/td>\n<\/tr>\n
    cpanel_squirrelmail_log_level<\/code><\/td>\nConfigures the type of information for the system to record in the cPanel user\u2019s \/home\/user\/tmp\/error.log<\/code> file.<\/p>\n
      \n
    • 0<\/code> \u2014 Disable this setting.<\/li>\n
    • 1<\/code> \u2014 Only record errors in the error.log file.<\/li>\n
    • 2<\/code> \u2014 Record all information in the error.log file.<\/li>\n<\/ul>\n<\/td>\n
    		\n
    \n
    $config['cpanel_squirrelmail_log_level'<\/span>] =<\/span> 1<\/span>;<\/code><\/pre>\n<\/div>\n<\/td>\n<\/tr>\n
    cpanel_squirrelmail_file_charset<\/code><\/td>\nConfigures the SquirrelMail files\u2019 character set. To configure this option for the ASCII character set, leave this option blank.<\/td>\n\n
    \n
    $config['cpanel_squirrelmail_file_charset'<\/span>] =<\/span> ''<\/span>;<\/code><\/pre>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    The full configuration file will resemble the following example:\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><\/code><\/pre>\n<\/td>\n
    		\n
    \/\/ full path to the squirrelmail data directory\n<\/span><\/span>$<\/span>config<\/span>['<\/span>cpanel_squirrelmail_data_dir<\/span>'<\/span>] = getenv<\/span>('<\/span>HOME<\/span>'<\/span>). '<\/span>\/<\/span>.sqmaildata<\/span>'<\/span>;\n\n\/\/ Place a \"touch\" file in $config['cpanel_squirrelmail_data_dir'], preventing the plugin from\n<\/span>\/\/ running again if the file exits.\n<\/span><\/span>$<\/span>config<\/span>['<\/span>cpanel_squirrelmail_run_once<\/span>'<\/span>] = true<\/span>;\n\n\/\/ whether or not to check for duplicate addresses - if used with the\n<\/span>\/\/ cpanel_squirrelmail_group_name option duplicates will be added to new groups\n<\/span><\/span>$<\/span>config<\/span>['<\/span>cpanel_squirrelmail_unique<\/span>'<\/span>] = false<\/span>;\n\n\/\/ optional new group name for imported contacts - set to false to disable\n<\/span><\/span>$<\/span>config<\/span>['<\/span>cpanel_squirrelmail_group_name<\/span>'<\/span>] = '<\/span>SquirrelMail<\/span> Contacts<\/span>'<\/span>;\n\n\/\/ log level 0 to disable, 1 for errors only, 2 for verbose\n<\/span>\/\/ the default log file is the cpanel users \/home\/user\/tmp\/error\n<\/span><\/span>$<\/span>config<\/span>['<\/span>cpanel_squirrelmail_log_level<\/span>'<\/span>] = 1<\/span>;\n\n\/\/ file charset - e.g. 'EUC-JP'. Leave empty for ASCII.\n<\/span><\/span>$<\/span>config<\/span>['<\/span>cpanel_squirrelmail_file_charset<\/span>'<\/span>] = ''<\/span>;<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
    The Roundcube interface<\/h2>\n
    After you install the plugin, the system migrates any SquirrelMail contacts to Roundcube. These contacts reside in the SquirrelMail mailbox. This mailbox resides in the Personal Addresses<\/em> mailbox in the Groups<\/em> section of the roundcube<\/em> interface.<\/p>\n
    \n    
    \n<\/figure>\n
    Log file<\/h2>\n
    The log data for this plugin resides in the \/home\/username\/logs\/roundcube<\/code> file and resembles the following example:<\/p>\n
    \n
    Note:<\/div>\n
    \n
      \n
    • In cPanel & WHM version 78, the log data resides in the \/home\/username\/tmp\/errors<\/code> file.<\/li>\n
    • In these filepaths, username<\/code> represents a cPanel user\u2019s username.<\/li>\n
    • This example displays a list of SquirrelMail address book migration errors.<\/li>\n<\/ul><\/div>\n<\/div>\n
      \n
      \n\n\n
      \n
      1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span><\/code><\/pre>\n<\/td>\n
      		\n
      [04<\/span>-<\/span>Mar<\/span>-<\/span>2019<\/span> 11<\/span>:58<\/span>:49<\/span> America<\/span>\/<\/span>Chicago<\/span>] [Contacts<\/span>: Name<\/span> or<\/span> email<\/span> not<\/span> valid<\/span> \u00f6k\u00e7e<\/span> -<\/span> \u00f6k\u00e7e<\/span>@<\/span>nothing<\/span>.com<\/span> for<\/span> user<\/span> hoboloco<\/span>@<\/span>nothing<\/span>.com<\/span>]\n[04<\/span>-<\/span>Mar<\/span>-<\/span>2019<\/span> 11<\/span>:58<\/span>:49<\/span> America<\/span>\/<\/span>Chicago<\/span>] [Contacts<\/span>: Name<\/span> or<\/span> email<\/span> not<\/span> valid<\/span> D\u00f6rte<\/span> -<\/span> D\u00f6rte<\/span>@<\/span>S\u00f6rensen<\/span>.nothing<\/span>.com<\/span> for<\/span> user<\/span> hoboloco<\/span>@<\/span>nothing<\/span>.com<\/span>]\n[04<\/span>-<\/span>Mar<\/span>-<\/span>2019<\/span> 11<\/span>:58<\/span>:49<\/span> America<\/span>\/<\/span>Chicago<\/span>] [Contacts<\/span>: Name<\/span> or<\/span> email<\/span> not<\/span> valid<\/span> \u03b8\u03c3\u03b5\u03c1<\/span> -<\/span> \u03b8\u03c3\u03b5\u03c1<\/span>@<\/span>\u03b5\u03c7\u03b1\u03bc\u03c0\u03bb\u03b5<\/span>.\u03c8\u03bf\u03bc<\/span> for<\/span> user<\/span> hoboloco<\/span>@<\/span>nothing<\/span>.com<\/span>]\n[04<\/span>-<\/span>Mar<\/span>-<\/span>2019<\/span> 11<\/span>:58<\/span>:49<\/span> America<\/span>\/<\/span>Chicago<\/span>] [Contacts<\/span>: Name<\/span> or<\/span> email<\/span> not<\/span> valid<\/span> \u7528\u6237<\/span>@<\/span>\u4f8b\u5b50<\/span> -<\/span> \u7528\u6237<\/span>@<\/span>\u4f8b\u5b50<\/span>.\u5e7f\u544a<\/span> for<\/span> user<\/span> hoboloco<\/span>@<\/span>nothing<\/span>.com<\/span>]\n[04<\/span>-<\/span>Mar<\/span>-<\/span>2019<\/span> 11<\/span>:58<\/span>:49<\/span> America<\/span>\/<\/span>Chicago<\/span>] [Contacts<\/span>: Name<\/span> or<\/span> email<\/span> not<\/span> valid<\/span> Pel\u00e9<\/span>@<\/span>nothing<\/span>.com<\/span> -<\/span> Pel\u00e9<\/span>@<\/span>nothing<\/span>.com<\/span> for<\/span> user<\/span> hoboloco<\/span>@<\/span>nothing<\/span>.com<\/span>]<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
      Overview Warning: This document is only valid for cPanel & WHM versions 78 and 80. Roundcube version 1.3.8 and earlier does not support email addresses that contain Unicode characters. We recommend that only experienced server administrators perform the steps in this document. Because cPanel, L.L.C. doesn\u2019t develop SquirrelMail, cPanel Technical Support can\u2019t help with address …<\/p>\n","protected":false},"author":1,"featured_media":761,"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\/760"}],"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=760"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/760\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/761"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=760"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=760"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=760"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}