/usr/share/perl5/Mail/POP3Client.pm is in libmail-pop3client-perl 2.18-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 | #******************************************************************************
# $Id: POP3Client.pm,v 2.18 2008/02/27 03:03:21 ssd Exp $
#
# Description: POP3Client module - acts as interface to POP3 server
# Author: Sean Dowd <pop3client@dowds.net>
#
# Copyright (c) 1999-2008 Sean Dowd. All rights reserved.
# This module is free software; you can redistribute it and/or modify
# it under the same terms as Perl itself.
#
#******************************************************************************
package Mail::POP3Client;
use strict;
use warnings;
use Carp;
use IO::Socket qw(SOCK_STREAM);
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
require Exporter;
@ISA = qw(Exporter);
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.
@EXPORT = qw(
);
my $ID =q( $Id: POP3Client.pm,v 2.18 2008/02/27 03:03:21 ssd Exp $ );
$VERSION = substr q$Revision: 2.18 $, 10;
# Preloaded methods go here.
#******************************************************************************
#* constructor
#* new Mail::POP3Client( USER => user,
#* PASSWORD => pass,
#* HOST => host,
#* AUTH_MODE => [BEST|APOP|CRAM-MD5|PASS],
#* TIMEOUT => 30,
#* LOCALADDR => 'xxx.xxx.xxx.xxx[:xx]',
#* DEBUG => 1 );
#* OR (deprecated)
#* new Mail::POP3Client( user, pass, host [, port, debug, auth_mode, local_addr])
#******************************************************************************
sub new
{
my $classname = shift;
my $self = {
DEBUG => 0,
SERVER => "pop3",
PORT => 110,
COUNT => -1,
SIZE => -1,
ADDR => "",
STATE => 'DEAD',
MESG => 'OK',
BANNER => '',
MESG_ID => '',
AUTH_MODE => 'BEST',
EOL => "\015\012",
TIMEOUT => 60,
STRIPCR => 0,
LOCALADDR => undef,
SOCKET => undef,
USESSL => 0,
};
$self->{tranlog} = ();
$^O =~ /MacOS/i && ($self->{STRIPCR} = 1);
bless( $self, $classname );
$self->_init( @_ );
if ( defined($self->User()) && defined($self->Pass()) )
{
$self->Connect();
}
return $self;
}
#******************************************************************************
#* initialize - check for old-style params
#******************************************************************************
sub _init {
my $self = shift;
# if it looks like a hash
if ( @_ && (scalar( @_ ) % 2 == 0) )
{
# ... and smells like a hash...
my %hashargs = @_;
if ( ( defined($hashargs{USER}) &&
defined($hashargs{PASSWORD}) ) ||
defined($hashargs{HOST})
)
{
# ... then it must be a hash! Push all values into my internal hash.
foreach my $key ( keys %hashargs )
{
$self->{$key} = $hashargs{$key};
}
}
else {$self->_initOldStyle( @_ );}
}
else {$self->_initOldStyle( @_ );}
}
#******************************************************************************
#* initialize using the old positional parameter style new - deprecated
#******************************************************************************
sub _initOldStyle {
my $self = shift;
$self->User( shift );
$self->Pass( shift );
my $host = shift;
$host && $self->Host( $host );
my $port = shift;
$port && $self->Port( $port );
my $debug = shift;
$debug && $self->Debug( $debug );
my $auth_mode = shift;
$auth_mode && ($self->{AUTH_MODE} = $auth_mode);
my $localaddr = shift;
$localaddr && ($self->{LOCALADDR} = $localaddr);
}
#******************************************************************************
#* What version are we?
#******************************************************************************
sub Version {
return $VERSION;
}
#******************************************************************************
#* Is the socket alive?
#******************************************************************************
sub Alive
{
my $me = shift;
$me->State =~ /^AUTHORIZATION$|^TRANSACTION$/i;
} # end Alive
#******************************************************************************
#* What's the frequency Kenneth?
#******************************************************************************
sub State
{
my $me = shift;
my $stat = shift or return $me->{STATE};
$me->{STATE} = $stat;
} # end Stat
#******************************************************************************
#* Got anything to say?
#******************************************************************************
sub Message
{
my $me = shift;
my $msg = shift or return $me->{MESG};
$me->{MESG} = $msg;
} # end Message
#******************************************************************************
#* set/query debugging
#******************************************************************************
sub Debug
{
my $me = shift;
my $debug = shift or return $me->{DEBUG};
$me->{DEBUG} = $debug;
} # end Debug
#******************************************************************************
#* set/query the port number
#******************************************************************************
sub Port
{
my $me = shift;
my $port = shift or return $me->{PORT};
$me->{PORT} = $port;
} # end port
#******************************************************************************
#* set the host
#******************************************************************************
sub Host
{
my $me = shift;
my $host = shift or return $me->{HOST};
# $me->{INTERNET_ADDR} = inet_aton( $host ) or
# $me->Message( "Could not inet_aton: $host, $!") and return;
$me->{HOST} = $host;
} # end host
#******************************************************************************
#* set the local address
#******************************************************************************
sub LocalAddr
{
my $me = shift;
my $addr = shift or return $me->{LOCALADDR};
$me->{LOCALADDR} = $addr;
}
#******************************************************************************
#* query the socket to use as a file handle - allows you to set the
#* socket too to allow SSL (thanks to Jamie LeTual)
#******************************************************************************
sub Socket {
my $me = shift;
my $socket = shift or return $me->{'SOCKET'};
$me->{'SOCKET'} = $socket;
}
sub AuthMode {
my $me = shift;
my $mode = shift;
return $me->{'AUTH_MODE'} unless $mode;
$me->{'AUTH_MODE'} = $mode;
}
#******************************************************************************
#* set/query the USER
#******************************************************************************
sub User
{
my $me = shift;
my $user = shift or return $me->{USER};
$me->{USER} = $user;
} # end User
#******************************************************************************
#* set/query the password
#******************************************************************************
sub Pass
{
my $me = shift;
my $pass = shift or return $me->{PASSWORD};
$me->{PASSWORD} = $pass;
} # end Pass
sub Password { Pass(@_); }
#******************************************************************************
#*
#******************************************************************************
sub Count
{
my $me = shift;
my $c = shift;
if (defined $c and length($c) > 0) {
$me->{COUNT} = $c;
} else {
return $me->{COUNT};
}
} # end Count
#******************************************************************************
#* set/query the size of the mailbox
#******************************************************************************
sub Size
{
my $me = shift;
my $c = shift;
if (defined $c and length($c) > 0) {
$me->{SIZE} = $c;
} else {
return $me->{SIZE};
}
} # end Size
#******************************************************************************
#*
#******************************************************************************
sub EOL {
my $me = shift;
return $me->{'EOL'};
}
#******************************************************************************
#*
#******************************************************************************
sub Close
{
my $me = shift;
# only send the QUIT message is the socket is still connected. Some
# POP3 servers close the socket after a failed authentication. It
# is unclear whether the RFC allows this or not, so we'll attempt to
# check the condition of the socket before sending data here.
if ($me->Alive() && $me->Socket() && $me->Socket()->connected() ) {
$me->_sockprint( "QUIT", $me->EOL );
# from Patrick Bourdon - need this because some servers do not
# delete in all cases. RFC says server can respond (in UPDATE
# state only, otherwise always OK).
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for QUIT");
# XXX: Should add the following?
#$me->State('DEAD');
undef $me->{SOCKET};
return 0;
}
$me->Message( $line );
close( $me->Socket() ) or $me->Message("close failed: $!") and do {
undef $me->{SOCKET};
return 0;
};
$me->State('DEAD');
undef $me->{SOCKET};
$line =~ /^\+OK/i || return 0;
}
1;
} # end Close
sub close { Close(@_); }
sub logout { Close(@_); }
#******************************************************************************
#*
#******************************************************************************
sub DESTROY
{
my $me = shift;
$me->Close;
} # end DESTROY
#******************************************************************************
#* Connect to the specified POP server
#******************************************************************************
sub Connect
{
my ($me, $host, $port) = @_;
$host and $me->Host($host);
$port and $me->Port($port);
$me->Close();
my $s = $me->{SOCKET};
$s || do {
if ( $me->{USESSL} ) {
if ( $me->Port() == 110 ) { $me->Port( 995 ); }
eval {
require IO::Socket::SSL;
};
$@ and $me->Message("Could not load IO::Socket::SSL: $@") and return 0;
$s = IO::Socket::SSL->new( PeerAddr => $me->Host(),
PeerPort => $me->Port(),
Proto => "tcp",
Type => SOCK_STREAM,
LocalAddr => $me->LocalAddr(),
Timeout => $me->{TIMEOUT} )
or $me->Message( "could not connect SSL socket [$me->{HOST}, $me->{PORT}]: $!" )
and return 0;
$me->{SOCKET} = $s;
} else {
$s = IO::Socket::INET->new( PeerAddr => $me->Host(),
PeerPort => $me->Port(),
Proto => "tcp",
Type => SOCK_STREAM,
LocalAddr => $me->LocalAddr(),
Timeout => $me->{TIMEOUT} )
or
$me->Message( "could not connect socket [$me->{HOST}, $me->{PORT}]: $!" )
and
return 0;
$me->{SOCKET} = $s;
}
};
$s->autoflush( 1 );
defined(my $msg = $me->_sockread()) or $me->Message("Could not read") and return 0;
chomp $msg;
$me->{BANNER}= $msg;
# add check for servers that return -ERR on connect (not in RFC1939)
$me->Message($msg);
$msg =~ /^\+OK/i || return 0;
my $atom = qr([-_\w!#$%&'*+/=?^`{|}~]+);
$me->{MESG_ID}= $1 if ($msg =~/(<$atom(?:\.$atom)*\@$atom(?:\.$atom)*>)/o);
$me->Message($msg);
$me->State('AUTHORIZATION');
defined($me->User()) and defined($me->Pass()) and $me->Login();
} # end Connect
sub connect { Connect(@_); }
#******************************************************************************
#* login to the POP server. If the AUTH_MODE is set to BEST, and the server
#* appears to support APOP, it will try APOP, if that fails, then it will try
#* SASL CRAM-MD5 if the server appears to support it, and finally PASS.
#* If the AUTH_MODE is set to APOP, and the server appears to support APOP, it
#* will use APOP or it will fail to log in. Likewise, for AUTH_MODE CRAM-MD5,
#* no PASS-fallback is made. Otherwise password is sent in clear text.
#******************************************************************************
sub Login
{
my $me= shift;
return 1 if $me->State eq 'TRANSACTION'; # Already logged in
if ($me->{AUTH_MODE} eq 'BEST') {
my $retval;
if ($me->{MESG_ID}) {
$retval = $me->Login_APOP();
return($retval) if ($me->State eq 'TRANSACTION');
}
my $has_cram_md5 = 0;
foreach my $capa ($me->Capa()) {
$capa =~ /^SASL.*?\sCRAM-MD5\b/ and $has_cram_md5 = 1 and last;
}
if ($has_cram_md5) {
$retval = $me->Login_CRAM_MD5();
return($retval) if ($me->State() eq 'TRANSACTION');
}
}
elsif ($me->{AUTH_MODE} eq 'APOP') {
return(0) if (!$me->{MESG_ID}); # fail if the server does not support APOP
return($me->Login_APOP());
}
elsif ($me->{AUTH_MODE} eq 'CRAM-MD5') {
return($me->Login_CRAM_MD5());
}
elsif ($me->{AUTH_MODE} ne 'PASS') {
$me->Message("Programing error. AUTH_MODE (".$me->{AUTH_MODE}.") not BEST | APOP | CRAM-MD5 | PASS.");
return(0);
}
return($me->Login_Pass());
}
sub login { Login(@_); }
#******************************************************************************
#* login to the POP server using APOP (md5) authentication.
#******************************************************************************
sub Login_APOP
{
my $me = shift;
eval {
require Digest::MD5;
};
$@ and $me->Message("APOP failed: $@") and return 0;
my $hash = Digest::MD5::md5_hex($me->{MESG_ID} . $me->Pass());
$me->_checkstate('AUTHORIZATION', 'APOP') or return 0;
$me->_sockprint( "APOP " , $me->User , ' ', $hash, $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for APOP");
$me->State('AUTHORIZATION');
return 0;
}
chomp $line;
$me->Message($line);
# some servers will close here...
$me->NOOP() || do {
$me->State('DEAD');
undef $me->{SOCKET};
$me->Message("APOP failed: server has closed the socket");
return 0;
};
$line =~ /^\+OK/ or $me->Message("APOP failed: $line") and return 0;
$me->State('TRANSACTION');
$me->POPStat() or return 0;
}
#******************************************************************************
#* login to the POP server using CRAM-MD5 (RFC 2195) authentication.
#******************************************************************************
sub Login_CRAM_MD5
{
my $me = shift;
eval {
require Digest::HMAC_MD5;
require MIME::Base64;
};
$@ and $me->Message("AUTH CRAM-MD5 failed: $@") and return 0;
$me->_checkstate('AUTHORIZATION', 'AUTH') or return 0;
$me->_sockprint('AUTH CRAM-MD5', $me->EOL());
my $line = $me->_sockread();
chomp $line;
$me->Message($line);
if ($line =~ /^\+ (.+)$/) {
my $hmac =
Digest::HMAC_MD5::hmac_md5_hex(MIME::Base64::decode($1), $me->Pass());
(my $response = MIME::Base64::encode($me->User() . " $hmac")) =~ s/[\r\n]//g;
$me->_sockprint($response, $me->EOL());
$line = $me->_sockread();
chomp $line;
$me->Message($line);
$line =~ /^\+OK/ or
$me->Message("AUTH CRAM-MD5 failed: $line") and return 0;
} else {
$me->Message("AUTH CRAM-MD5 failed: $line") and return 0;
}
$me->State('TRANSACTION');
$me->POPStat() or return 0;
}
#******************************************************************************
#* login to the POP server using simple (cleartext) authentication.
#******************************************************************************
sub Login_Pass
{
my $me = shift;
$me->_checkstate('AUTHORIZATION', 'USER') or return 0;
$me->_sockprint( "USER " , $me->User() , $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for USER");
$me->State('AUTHORIZATION');
return 0;
}
chomp $line;
$me->Message($line);
$line =~ /^\+/ or $me->Message("USER failed: $line") and $me->State('AUTHORIZATION')
and return 0;
$me->_sockprint( "PASS " , $me->Pass() , $me->EOL );
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for PASS");
$me->State('AUTHORIZATION');
return 0;
}
chomp $line;
$me->Message($line);
$line =~ /^\+OK/ or $me->Message("PASS failed: $line") and $me->State('AUTHORIZATION')
and return 0;
$me->State('TRANSACTION');
($me->POPStat() >= 0) or return 0;
} # end Login
#******************************************************************************
#* Get the Head of a message number. If you give an optional number
#* of lines you will get the first n lines of the body also. This
#* allows you to preview a message.
#******************************************************************************
sub Head
{
my $me = shift;
my $num = shift;
my $lines = shift;
$lines ||= 0;
$lines =~ /\d+/ || ($lines = 0);
my $header = '';
$me->_checkstate('TRANSACTION', 'TOP') or return;
$me->_sockprint( "TOP $num $lines", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for TOP");
return;
}
chomp $line;
$line =~ /^\+OK/ or $me->Message("Bad return from TOP: $line") and return;
$line =~ /^\+OK (\d+) / and my $buflen = $1;
while (1) {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for TOP");
return;
}
last if $line =~ /^\.\s*$/;
$line =~ s/^\.\././;
$header .= $line;
}
return wantarray ? split(/\r?\n/, $header) : $header;
} # end Head
#******************************************************************************
#* Get the header and body of a message
#******************************************************************************
sub HeadAndBody
{
my $me = shift;
my $num = shift;
my $mandb = '';
$me->_checkstate('TRANSACTION', 'RETR') or return;
$me->_sockprint( "RETR $num", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
chomp $line;
$line =~ /^\+OK/ or $me->Message("Bad return from RETR: $line") and return;
$line =~ /^\+OK (\d+) / and my $buflen = $1;
while (1) {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
last if $line =~ /^\.\s*$/;
# convert any '..' at the start of a line to '.'
$line =~ s/^\.\././;
$mandb .= $line;
}
return wantarray ? split(/\r?\n/, $mandb) : $mandb;
} # end HeadAndBody
sub message_string { HeadAndBody(@_); }
#******************************************************************************
#* get the head and body of a message and write it to a file handle.
#* Sends the raw data: does no CR/NL stripping or mapping.
#******************************************************************************
sub HeadAndBodyToFile
{
local ($, , $\);
my $me = shift;
my $fh = shift;
my $num = shift;
my $body = '';
$me->_checkstate('TRANSACTION', 'RETR') or return;
$me->_sockprint( "RETR $num", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return 0;
}
chomp $line;
$line =~ /^\+OK/ or $me->Message("Bad return from RETR: $line") and return 0;
$line =~ /^\+OK (\d+) / and my $buflen = $1;
while (1) {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return 0;
}
last if $line =~ /^\.\s*$/;
# convert any '..' at the start of a line to '.'
$line =~ s/^\.\././;
print $fh $line;
}
return 1;
} # end BodyToFile
#******************************************************************************
#* get the body of a message
#******************************************************************************
sub Body
{
my $me = shift;
my $num = shift;
my $body = '';
$me->_checkstate('TRANSACTION', 'RETR') or return;
$me->_sockprint( "RETR $num", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
chomp $line;
$line =~ /^\+OK/ or $me->Message("Bad return from RETR: $line") and return;
$line =~ /^\+OK (\d+) / and my $buflen = $1;
# skip the header
do {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
$line =~ s/[\r\n]//g;
} until $line =~ /^(\s*|\.)$/;
$line =~ /^\.\s*$/ && return; # we found a header only! Lotus Notes seems to do this.
while (1) {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
last if $line =~ /^\.\s*$/;
# convert any '..' at the start of a line to '.'
$line =~ s/^\.\././;
$body .= $line;
}
return wantarray ? split(/\r?\n/, $body) : $body;
} # end Body
#******************************************************************************
#* get the body of a message and write it to a file handle. Sends the raw data:
#* does no CR/NL stripping or mapping.
#******************************************************************************
sub BodyToFile
{
local ($, , $\);
my $me = shift;
my $fh = shift;
my $num = shift;
my $body = '';
$me->_checkstate('TRANSACTION', 'RETR') or return;
$me->_sockprint( "RETR $num", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
chomp $line;
$line =~ /^\+OK/ or $me->Message("Bad return from RETR: $line") and return;
$line =~ /^\+OK (\d+) / and my $buflen = $1;
# skip the header
do {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
$line =~ s/[\r\n]//g;
} until $line =~ /^(\s*|\.)$/;
$line =~ /^\.\s*$/ && return; # we found a header only! Lotus Notes seems to do this.
while (1) {
$line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RETR");
return;
}
chomp $line;
last if $line =~ /^\.\s*$/;
# convert any '..' at the start of a line to '.'
$line =~ s/^\.\././;
print $fh $line, "\n";
}
} # end BodyToFile
#******************************************************************************
#* handle a STAT command - returns the number of messages in the box
#******************************************************************************
sub POPStat
{
my $me = shift;
$me->_checkstate('TRANSACTION', 'STAT') or return -1;
$me->_sockprint( "STAT", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for STAT");
return -1;
}
$line =~ /^\+OK/ or $me->Message("STAT failed: $line") and return -1;
$line =~ /^\+OK (\d+) (\d+)/ and $me->Count($1), $me->Size($2);
return $me->Count();
}
#******************************************************************************
#* issue the LIST command
#******************************************************************************
sub List {
my $me = shift;
my $num = shift || '';
my $CMD = shift || 'LIST';
$CMD=~ tr/a-z/A-Z/;
$me->Alive() or return;
my @retarray = ();
my $ret = '';
$me->_checkstate('TRANSACTION', $CMD) or return;
$me->_sockprint($CMD, $num ? " $num" : '', $me->EOL());
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for LIST");
return;
}
$line =~ /^\+OK/ or $me->Message("$line") and return;
if ($num) {
$line =~ s/^\+OK\s*//;
return $line;
}
while( defined( $line = $me->_sockread() ) ) {
$line =~ /^\.\s*$/ and last;
$ret .= $line;
chomp $line;
push(@retarray, $line);
}
if ($ret) {
return wantarray ? @retarray : $ret;
}
}
#******************************************************************************
#* issue the LIST command, but return results in an indexed array.
#******************************************************************************
sub ListArray {
my $me = shift;
my $num = shift || '';
my $CMD = shift || 'LIST';
$CMD=~ tr/a-z/A-Z/;
$me->Alive() or return;
my @retarray = ();
my $ret = '';
$me->_checkstate('TRANSACTION', $CMD) or return;
$me->_sockprint($CMD, $num ? " $num" : '', $me->EOL());
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for LIST");
return;
}
$line =~ /^\+OK/ or $me->Message("$line") and return;
if ($num) {
$line =~ s/^\+OK\s*//;
return $line;
}
while( defined( $line = $me->_sockread() ) ) {
$line =~ /^\.\s*$/ and last;
$ret .= $line;
chomp $line;
my ($num, $uidl) = split('\s+', $line);
$retarray[$num] = $uidl;
}
if ($ret) {
return wantarray ? @retarray : $ret;
}
}
#******************************************************************************
#* retrieve the given message number - uses HeadAndBody
#******************************************************************************
sub Retrieve {
return HeadAndBody( @_ );
}
#******************************************************************************
#* retrieve the given message number to the given file handle- uses
#* HeadAndBodyToFile
#******************************************************************************
sub RetrieveToFile {
return HeadAndBodyToFile( @_ );
}
#******************************************************************************
#* implement the LAST command - see the rfc (1081) OBSOLETED by RFC
#******************************************************************************
sub Last
{
my $me = shift;
$me->_checkstate('TRANSACTION', 'LAST') or return;
$me->_sockprint( "LAST", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for LAST");
return 0;
}
$line =~ /\+OK (\d+)\D*$/ and return $1;
}
#******************************************************************************
#* reset the deletion stat
#******************************************************************************
sub Reset
{
my $me = shift;
$me->_checkstate('TRANSACTION', 'RSET') or return;
$me->_sockprint( "RSET", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for RSET");
return 0;
}
$line =~ /^\+OK/ and return 1;
return 0;
}
#******************************************************************************
#* delete the given message number
#******************************************************************************
sub Delete {
my $me = shift;
my $num = shift || return;
$me->_checkstate('TRANSACTION', 'DELE') or return;
$me->_sockprint( "DELE $num", $me->EOL );
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for DELE");
return 0;
}
$me->Message($line);
$line =~ /^\+OK/ && return 1;
return 0;
}
sub delete_message { Delete(@_); }
#******************************************************************************
#* UIDL - submitted by Dion Almaer (dion@member.com)
#******************************************************************************
sub Uidl
{
my $me = shift;
my $num = shift || '';
$me->Alive() or return;
my @retarray = ();
my $ret = '';
$me->_checkstate('TRANSACTION', 'UIDL') or return;
$me->_sockprint('UIDL', $num ? " $num" : '', $me->EOL());
my $line = $me->_sockread();
unless (defined $line) {
$me->Message("Socket read failed for UIDL");
return;
}
$line =~ /^\+OK/ or $me->Message($line) and return;
if ($num) {
$line =~ s/^\+OK\s*//;
return $line;
}
while( defined( $line = $me->_sockread() ) ) {
$line =~ /^\.\s*$/ and last;
$ret .= $line;
chomp $line;
my ($num, $uidl) = split('\s+', $line);
$retarray[$num] = $uidl;
}
if ($ret) {
return wantarray ? @retarray : $ret;
}
}
#******************************************************************************
#* CAPA - query server capabilities, see RFC 2449
#******************************************************************************
sub Capa {
my $me = shift;
# no state check here, all are allowed
$me->Alive() or return;
my @retarray = ();
my $ret = '';
$me->_sockprint('CAPA', $me->EOL());
my $line = $me->_sockread();
$line =~ /^\+OK/ or $me->Message($line) and return;
while(defined($line = $me->_sockread())) {
$line =~ /^\.\s*$/ and last;
$ret .= $line;
chomp $line;
push(@retarray, $line);
}
if ($ret) {
return wantarray ? @retarray : $ret;
}
}
#******************************************************************************
#* XTND - submitted by Chris Moates (six@mox.net)
#******************************************************************************
sub Xtnd {
my $me = shift;
my $xtndarg = shift || '';
if ($xtndarg eq '') {
$me->Message("XTND requires a string argument");
return;
}
my $s = $me->Socket();
$me->_checkstate('TRANSACTION', 'XTND') or return;
$me->Alive() or return;
$me->_sockprint( "XTND $xtndarg", $me->EOL );
my $line = $me->_sockread();
$line =~ /^\+OK/ or $me->Message($line) and return;
$line =~ s/^\+OK\s*//;
return $line;
}
#******************************************************************************
#* NOOP - used to check socket
#******************************************************************************
sub NOOP {
my $me = shift;
my $s = $me->Socket();
$me->Alive() or return 0;
$me->_sockprint( "NOOP", $me->EOL );
my $line = $me->_sockread();
# defined( $line ) or return 0;
$line =~ /^\+OK/ or return 0;
return 1;
}
#******************************************************************************
#* Mail::IMAPClient compatibility functions (wsnyder@wsnyder.org)
#******************************************************************************
# Empty stubs
sub Peek {}
sub Uid {}
# Pop doesn't have concept of different folders
sub folders { return ('INBOX'); }
sub Folder { return ('INBOX'); }
sub select {}
# Message accessing
sub unseen {
my $me = shift;
my $count = $me->Count;
return () if !$count;
return ( 1..$count);
}
#*****************************************************************************
#* Check the state before issuing a command
#*****************************************************************************
sub _checkstate
{
my ($me, $state, $cmd) = @_;
my $currstate = $me->State();
if ($currstate ne $state) {
$me->Message("POP3 command $cmd may be given only in the '$state' state " .
"(current state is '$currstate').");
return 0;
} else {
return 1;
}
}
#*****************************************************************************
#* funnel all read/write through here to allow easier debugging
#* (mitra@earth.path.net)
#*****************************************************************************
sub _sockprint
{
local ($, , $\);
my $me = shift;
my $s = $me->Socket();
$me->Debug and Carp::carp "POP3 -> ", @_;
my $outline = "@_";
chomp $outline;
push(@{$me->{tranlog}}, $outline);
print $s @_;
}
sub _sockread
{
my $me = shift;
my $line = $me->Socket()->getline();
unless (defined $line) {
return;
}
# Macs seem to leave CR's or LF's sitting on the socket. This
# removes them.
$me->{STRIPCR} && ($line =~ s/^[\r]+//);
$me->Debug and Carp::carp "POP3 <- ", $line;
$line =~ /^[\\+\\-](OK|ERR)/i && do {
my $l = $line;
chomp $l;
push(@{$me->{tranlog}}, $l);
};
return $line;
}
# end package Mail::POP3Client
# Autoload methods go after =cut, and are processed by the autosplit program.
1;
__END__
################################################################################
# POD Documentation (perldoc Mail::POP3Client or pod2html this_file)
################################################################################
=head1 NAME
Mail::POP3Client - Perl 5 module to talk to a POP3 (RFC1939) server
=head1 SYNOPSIS
use Mail::POP3Client;
$pop = new Mail::POP3Client( USER => "me",
PASSWORD => "mypassword",
HOST => "pop3.do.main" );
for( $i = 1; $i <= $pop->Count(); $i++ ) {
foreach( $pop->Head( $i ) ) {
/^(From|Subject):\s+/i && print $_, "\n";
}
}
$pop->Close();
# OR with SSL
$pop = new Mail::POP3Client( USER => "me",
PASSWORD => "mypassword",
HOST => "pop3.do.main",
USESSL => true,
);
# OR
$pop2 = new Mail::POP3Client( HOST => "pop3.otherdo.main" );
$pop2->User( "somebody" );
$pop2->Pass( "doublesecret" );
$pop2->Connect() >= 0 || die $pop2->Message();
$pop2->Close();
# OR to use your own SSL socket...
my $socket = IO::Socket::SSL->new( PeerAddr => 'pop.securedo.main',
PeerPort => 993,
Proto => 'tcp') || die "No socket!";
my $pop = Mail::POP3Client->new();
$pop->User('somebody');
$pop->Pass('doublesecret');
$pop->Socket($socket);
$pop->Connect();
=head1 DESCRIPTION
This module implements an Object-Oriented interface to a POP3 server.
It implements RFC1939 (http://www.faqs.org/rfcs/rfc1939.html)
=head1 EXAMPLES
Here is a simple example to list out the From: and Subject: headers in
your remote mailbox:
#!/usr/local/bin/perl
use Mail::POP3Client;
$pop = new Mail::POP3Client( USER => "me",
PASSWORD => "mypassword",
HOST => "pop3.do.main" );
for ($i = 1; $i <= $pop->Count(); $i++) {
foreach ( $pop->Head( $i ) ) {
/^(From|Subject):\s+/i and print $_, "\n";
}
print "\n";
}
=head1 CONSTRUCTORS
Old style (deprecated):
new Mail::POP3Client( USER, PASSWORD [, HOST, PORT, DEBUG, AUTH_MODE] );
New style (shown with defaults):
new Mail::POP3Client( USER => "",
PASSWORD => "",
HOST => "pop3",
PORT => 110,
AUTH_MODE => 'BEST',
DEBUG => 0,
TIMEOUT => 60,
LOCALADDR => 'xxx.xxx.xxx.xxx[:xx]',
SOCKET => undef,
USESSL => 0,
);
=over 4
=item *
USER is the userID of the account on the POP server
=item *
PASSWORD is the cleartext password for the userID
=item *
HOST is the POP server name or IP address (default = 'pop3')
=item *
PORT is the POP server port (default = 110)
=item *
DEBUG - any non-null, non-zero value turns on debugging (default = 0)
=item *
AUTH_MODE - pass 'APOP' to force APOP (MD5) authorization. (default is 'BEST')
=item *
TIMEOUT - set a timeout value for socket operations (default = 60)
=item *
LOCALADDR - allow selecting a local inet address to use
=back
=head1 METHODS
These commands are intended to make writing a POP3 client easier.
They do not necessarily map directly to POP3 commands defined in
RFC1081 or RFC1939, although all commands should be supported. Some
commands return multiple lines as an array in an array context.
=over 8
=item I<new>( USER => 'user', PASSWORD => 'password', HOST => 'host',
PORT => 110, DEBUG => 0, AUTH_MODE => 'BEST', TIMEOUT => 60,,
LOCALADDR => 'xxx.xxx.xxx.xxx[:xx]', SOCKET => undef, USESSL => 0 )
)
Construct a new POP3 connection with this. You should use the
hash-style constructor. B<The old positional constructor is
deprecated and will be removed in a future release. It is strongly
recommended that you convert your code to the new version.>
You should give it at least 2 arguments: USER and PASSWORD. The
default HOST is 'pop3' which may or may not work for you. You can
specify a different PORT (be careful here).
new will attempt to Connect to and Login to the POP3 server if you
supply a USER and PASSWORD. If you do not supply them in the
constructor, you will need to call Connect yourself.
The valid values for AUTH_MODE are 'BEST', 'PASS', 'APOP' and 'CRAM-MD5'.
BEST says to try APOP if the server appears to support it and it can be
used to successfully log on, next try similarly with CRAM-MD5, and finally
revert to PASS. APOP and CRAM-MD5 imply that an MD5 checksum will be
used instead of sending your password in cleartext. However,
B<if the server does not claim to support APOP or CRAM-MD5,
the cleartext method will be used. Be careful.> There are a few
servers that will send a timestamp in the banner greeting, but APOP
will not work with them (for instance if the server does not know your
password in cleartext). If you think your authentication information
is correct, run in DEBUG mode and look for errors regarding
authorization. If so, then you may have to use 'PASS' for that server.
The same applies to CRAM-MD5, too.
If you enable debugging with DEBUG => 1, socket traffic will be echoed
to STDERR.
Another warning, it's impossible to differentiate between a timeout
and a failure.
If you pass a true value for USESSL, the port will be changed to 995 if
it is not set or is 110. Otherwise, it will use your port. If USESSL
is true, IO::Socket::SSL will be loaded. If it is not in your perl,
the call to connect will fail.
new returns a valid Mail::POP3Client object in all cases. To test for
a connection failure, you will need to check the number of messages:
-1 indicates a connection error. This will likely change sometime in
the future to return undef on an error, setting $! as a side effect.
This change will not happen in any 2.x version.
=item I<Head>( MESSAGE_NUMBER [, PREVIEW_LINES ] )
Get the headers of the specified message, either as an array or as a
string, depending on context.
You can also specify a number of preview lines which will be returned
with the headers. This may not be supported by all POP3 server
implementations as it is marked as optional in the RFC. Submitted by
Dennis Moroney <dennis@hub.iwl.net>.
=item I<Body>( MESSAGE_NUMBER )
Get the body of the specified message, either as an array of lines or
as a string, depending on context.
=item I<BodyToFile>( FILE_HANDLE, MESSAGE_NUMBER )
Get the body of the specified message and write it to the given file handle.
my $fh = new IO::Handle();
$fh->fdopen( fileno( STDOUT ), "w" );
$pop->BodyToFile( $fh, 1 );
Does no stripping of NL or CR.
=item I<HeadAndBody>( MESSAGE_NUMBER )
Get the head and body of the specified message, either as an array of
lines or as a string, depending on context.
=over 4
=item Example
foreach ( $pop->HeadAndBody( 1 ) )
print $_, "\n";
prints out the complete text of message 1.
=back
=item I<HeadAndBodyToFile>( FILE_HANDLE, MESSAGE_NUMBER )
Get the head and body of the specified message and write it to the given file handle.
my $fh = new IO::Handle();
$fh->fdopen( fileno( STDOUT ), "w" );
$pop->HeadAndBodyToFile( $fh, 1 );
Does no stripping of NL or CR.
=item I<Retrieve>( MESSAGE_NUMBER )
Same as HeadAndBody.
=item I<RetrieveToFile>( FILE_HANDLE, MESSAGE_NUMBER )
Same as HeadAndBodyToFile.
=item I<Delete>( MESSAGE_NUMBER )
Mark the specified message number as DELETED. Becomes effective upon
QUIT (invoking the Close method). Can be reset with a Reset message.
=item I<Connect>
Start the connection to the POP3 server. You can pass in the host and
port. Returns 1 if the connection succeeds, or 0 if it fails (Message
will contain a reason). The constructor always returns a blessed
reference to a Mail::POP3Client obhect. This may change in a version
3.x release, but never in a 2.x release.
=item I<Close>
Close the connection gracefully. POP3 says this will perform any
pending deletes on the server.
=item I<Alive>
Return true or false on whether the connection is active.
=item I<Socket>
Return the file descriptor for the socket, or set if supplied.
=item I<Size>
Set/Return the size of the remote mailbox. Set by POPStat.
=item I<Count>
Set/Return the number of remote messages. Set during Login.
=item I<Message>
The last status message received from the server or a message
describing any problem encountered.
=item I<State>
The internal state of the connection: DEAD, AUTHORIZATION, TRANSACTION.
=item I<POPStat>
Return the results of a POP3 STAT command. Sets the size of the
mailbox.
=item I<List>([message_number])
Returns the size of the given message number when called with an
argument using the following format:
<message_number> <size_in_bytes>
If message_number is omitted, List behaves the same as ListArray,
returning an indexed array of the sizes of each message in the same
format.
You can parse the size in bytes using split:
($msgnum, $size) = split('\s+', $pop -> List( n ));
=item I<ListArray>
Return a list of sizes of each message. This returns an indexed
array, with each message number as an index (starting from 1) and the
value as the next entry on the line. Beware that some servers send
additional info for each message for the list command. That info may
be lost.
=item I<Uidl>( [MESSAGE_NUMBER] )
Return the unique ID for the given message (or all of them). Returns
an indexed array with an entry for each valid message number.
Indexing begins at 1 to coincide with the server's indexing.
=item I<Capa>
Query server capabilities, as described in RFC 2449. Returns the
capabilities in an array. Valid in all states.
=item I<XTND>
Optional extended commands. Transaction state only.
=item I<Last>
Return the number of the last message, retrieved from the server.
=item I<Reset>
Tell the server to unmark any message marked for deletion.
=item I<User>( [USER_NAME] )
Set/Return the current user name.
=item I<Pass>( [PASSWORD] )
Set/Return the current user name.
=item I<Login>
Attempt to login to the server connection.
=item I<Host>( [HOSTNAME] )
Set/Return the current host.
=item I<Port>( [PORT_NUMBER] )
Set/Return the current port number.
=back
=head1 IMAP COMPATIBILITY
Basic Mail::IMAPClient method calls are also supported: close, connect,
login, message_string, Password, and unseen. Also, empty stubs are
provided for Folder, folders, Peek, select, and Uid.
=head1 REQUIREMENTS
This module does not have mandatory requirements for modules that are not part
of the standard Perl distribution. However, APOP needs need Digest::MD5 and
CRAM-MD5 needs Digest::HMAC_MD5 and MIME::Base64.
=head1 AUTHOR
Sean Dowd <pop3client@dowds.net>
=head1 CREDITS
Based loosely on News::NNTPClient by Rodger Anderson
<rodger@boi.hp.com>.
=head1 SEE ALSO
perl(1)
the Digest::MD5 manpage, the Digest::HMAC_MD5 manpage, the MIME::Base64 manpage
RFC 1939: Post Office Protocol - Version 3
RFC 2195: IMAP/POP AUTHorize Extension for Simple Challenge/Response
RFC 2449: POP3 Extension Mechanism
=cut
|