README
1GENERAL USE
2===========
3Plugin allows adding addresses from CSV (comma separated values) file to
4available local SquirrelMail address books. It also allows exporting
5SquirrelMail address book entries to CSV file.
6
7
8Authors
9=======
10v.0.3-0.5 Lewis Bergman
11v.0.6 Dustin Anders
12v.0.7-0.8 Christian Sauer <christian at endrun.org>
13 Andy Brook <andyb at iserv.net>
14
15From v.0.9 plugin is maintained by SM-Plugins project developers.
16See http://sourceforge.net/projects/sm-plugins/
17
18
19Bugs
20====
21Use tracker on http://sourceforge.net/projects/sm-plugins/ to report
22plugin bugs. Check CHANGELOG file before reporting known issues.
23
24
25Error messages
26==============
27Some plugin error messages direct end user to system administrator.
28If end user selects different interface language, error messages
29can be translated to selected language.
30
31Here goes explanation of error messages and ways to solve them.
32
33* "Imported CSV file is too big."
34* "The uploaded file exceeds the MAX_FILE_SIZE directive that was
35 specified in the HTML."
36
37 Plugin defaults to 5 KB upload limit. It can be increased in site
38 configuration file, $aie_csv_maxsize variable. See INSTALL
39 documentation and plugins/abook_import_export/config_default.php
40 file.
41
42 5KB limit is historical. Older plugin versions used this value.
43 Imported address books usually exceed it. Variable makes sure
44 that you read plugin install documentation. Don't set it to very
45 high value. If limit is too high, users might hit session data
46 storage or PHP memory limits.
47
48 Please note that plugin uses html MAX_FILE_SIZE attribute in
49 upload form, but it does not trust submitted value when
50 uploaded data is processed. Uploaded data size is always compared
51 with $aie_csv_maxsize configuration variable. 'MAX_FILE_SIZE'
52 error is standard PHP error message. It can be displayed only
53 when uploaded address book size is very close to address book
54 upload limits set by $aie_csv_maxsize.
55
56* "Can't move uploaded file to attachment directory."
57
58 Plugin stores processed data in SquirrelMail attachment directory.
59 SquirrelMail can look functional, when attachment directory is not
60 writable, but all uploads will fail. Please check your config.
61 Directory specified in $attachment_dir settings must be writable.
62 If relative paths are used, they must use SM_PATH constant.
63
64* "Address book uploads are disabled."
65
66 You have file uploads disabled in PHP configuration. End users
67 can't import address books. Enable file uploads or set
68 $aie_hide_upload_error configuration variable to true. If you have
69 set this PHP configuration variable with php_value or php_admin_value,
70 fix your configuration. file_uploads variable is boolean and should
71 be set with php_flag or php_admin_flag.
72
73* "Unable to access uploaded data."
74
75 Plugin should save uploaded data in session during first import stage
76 and retrieve it in second stage. Error message is displayed when data
77 retrieval fails in second stage. This is a simple safety check. It is
78 unlikely to happen. If you see it, error might be caused by some
79 limitations in your session handler. Maybe by session data size
80 limits.
81
82* "The uploaded file exceeds the upload_max_filesize directive in php.ini."
83* "The uploaded file was only partially uploaded."
84* "No file was uploaded."
85* "Missing a temporary folder."
86* "Failed to write file to disk."
87
88 Standand PHP upload error messages. Something is wrong with file
89 uploads. See http://www.php.net/features.file-upload
90
91* "Please select a file for uploading."
92
93 End user forgot to select file that must be uploaded or selected data is
94 unreadable.
95
96* "Unknown upload error."
97
98 PHP upload error handler returned unknown error code. Maybe your
99 PHP version introduced some new error code variable and plugin
100 can't handle it. Please inform plugin developers about this error
101 and provide information about used PHP version.
102
103
104
105