File: INSTALL

package info (click to toggle)
libmail-imapclient-perl 2.1.4-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 1,236 kB
  • ctags: 231
  • sloc: perl: 11,273; makefile: 56
file content (56 lines) | stat: -rwxr-xr-x 2,913 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Mail::IMAPClient Installation

The Mail::IMAPClient is written entirely in Perl, so it should install on any reasonably 
recent version of Perl. See the README file for a perl one-liner that you can run to verify
that your perl has what it takes to run Mail::IMAPClient.

The installation is standard:

	0) cd to installation directory
	1) perl Makefile.PL		(and reply to the prompt(s))
	2) make					(optional)
	3) make test 				(optional)
	4) make install 				

The 'make install' and 'make test' will both do step 2 ('make') if you haven't done it 
already. Currently the test script is lame (although not as lame as in the last release!)
but I hope to incorporate more thorough testing in a future version. You should at least 
try it and let me know if your tests fail. 

Version 1.0 changed the installation script so that it reuses the parameter file for 
the tests if it finds one. Installation can be run in the background if the test.txt file 
exists. Touching it is good enough to prevent prompts; having a correctly formatted 
version (as shown in test_template.txt) is even better, as it will allow you to do a 
thorough 'make test'. Invalid data in test.txt (either from precreating it or from 
responding inaccurately to prompts) will cause 'make test' to report 'not ok' results 
but won't break anything important (like the IMAPClient.pm file, or your car).

If you have tests that fail it may be more illuminating to run the tests by hand. IE:
perl -I./blib/lib t/basic.t from the installation dir will pinpoint the failing test.
Better yet, update t/basic.t to change Debug => 0 to Debug => 1 and run it again. E-mail
me the results.

If you don't have a test.txt file in your installation directory then you will have to 
answer at least one prompt. If you do have a test.txt file, and you run 'make clean', then 
you won't have a test.txt file anymore, so take precautions. 

If you do have a test.txt file and you don't run 'make clean' then a text file will be sitting 
around containing logon credentials, so take precautions. (It's just a test account anyway, 
right?)

If, when replying to the "perl Makefile.PL" prompts, you supply server, id, and password 
credentials for an id that has a ridiculously huge number of folders and subfolders then 
the 'make test' may run approximately forever. Next time try an id with less stuff. 

As of

For examples on using Mail::IMAPClient, check out the examples subdirectory. If you have 
better examples, then why haven't you e-mailed them to me? Also, I totally recommend that you
have a copy of RFC2060 handy when using this module, since the documentation for this module
is meant to compliment, not replace, RFC2060. In fact, I am so convinced that you'll need the
RFC that I've included a copy of it in the distribution, under the "docs/" subdirectory. It's
a smashing good read so have at it.

Now go and write IMAP clients.

Dave Kernen