dolibarr /htdocs/core/class/smtps.class.php

Language PHP Lines 1756
MD5 Hash b9bd8a273da5d988840dbe916960bd73
Repository https://github.com/asterix14/dolibarr.git View Raw File
   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
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
<?php
/**
 *	\file       htdocs/core/class/smtps.class.php
 *	\brief      File of class to manage SMTPS email sending
 *
 * Class to construct and send SMTP compliant email, even to a secure
 * SMTP server, regardless of platform.
 *
 * Goals:
 *  - mime compliant
 *  - multiple Reciptiants
 *    - TO
 *    - CC
 *    - BCC
 *  - multi-part message
 *    - plain text
 *    - HTML
 *    - inline attachments
 *    - attachments
 *  - GPG access
 *
 * This Class is based off of 'SMTP PHP MAIL' by Dirk Paehl, http://www.paehl.de
 *
 * @author Walter Torres <walter@torres.ws> [with a *lot* of help!]
 * @author Laurent Destailleur <eldy@users.sourceforge.net>
 * @author Regis Houssin
 *
 * @license GNU General Public Licence
 */

/**
 * Version number of Class
 */
define('SMTPs_VER', '1.16', false);

/**
 * SMTPs Success value
 */
define('SMTPs_SUCCEED', true, false);

/**
 * SMTPs Fail value
 */
define('SMTPs_FAIL', false, false);

/**
 * Improper parameters
 */
define('SMTPs_INVALID_PARAMETERS', 50, false);




/**
 * 	\class	SMTPs
 * 	\brief	Class to construct and send SMTP compliant email, even
 * 			to a secure SMTP server, regardless of platform.
 */
class SMTPs
{
    /**
     * Host Name or IP of SMTP Server to use
     */
    var $_smtpsHost = 'localhost';

    /**
     * SMTP Server Port definition. 25 is default value
     * This can be defined via a INI file or via a setter method
     */
    var $_smtpsPort = '25';

    /**
     * Secure SMTP Server access ID
     * This can be defined via a INI file or via a setter method
     */
    var $_smtpsID = null;

    /**
     * Secure SMTP Server access Password
     * This can be defined via a INI file or via a setter method
     */
    var $_smtpsPW = null;

    /**
     * Who sent the Message
     * This can be defined via a INI file or via a setter method
     */
    var $_msgFrom = null;

    /**
     * Where are replies and errors to be sent to
     * This can be defined via a INI file or via a setter method
     */
    var $_msgReplyTo = null;

    /**
     * Who will the Message be sent to; TO, CC, BCC
     * Multi-diminsional array containg addresses the message will
     * be sent TO, CC or BCC
     */
    var $_msgRecipients = null;

    /**
     * Message Subject
     */
    var $_msgSubject = null;

    /**
     * Message Content
     */
    var $_msgContent = null;

    /**
     * Custom X-Headers
     */
    var $_msgXheader = null;

    /**
     * Character set
     * Defaulted to 'iso-8859-1'
     */
    var $_smtpsCharSet = 'iso-8859-1';

    /**
     * Message Sensitivity
     * Defaults to ZERO - None
     */
    var $_msgSensitivity = 0;

    /**
     * Message Sensitivity
     */
    var $_arySensitivity = array ( false,
                                  'Personal',
                                  'Private',
                                  'Company Confidential' );

    /**
     * Message Sensitivity
     * Defaults to 3 - Normal
     */
    var $_msgPriority = 3;

    /**
     * Message Priority
     */
    var $_aryPriority = array ( 'Bulk',
                                'Highest',
                                'High',
                                'Normal',
                                'Low',
                                'Lowest' );

    /**
     * Content-Transfer-Encoding
     * Defaulted to 0 - 7bit
     */
    var $_smtpsTransEncodeType = 0;

    /**
     * Content-Transfer-Encoding
     */
    var $_smtpsTransEncodeTypes = array( '7bit',               // Simple 7-bit ASCII
                                         '8bit',               // 8-bit coding with line termination characters
                                         'base64',             // 3 octets encoded into 4 sextets with offset
                                         'binary',             // Arbitrary binary stream
                                         'mac-binhex40',       // Macintosh binary to hex encoding
                                         'quoted-printable',   // Mostly 7-bit, with 8-bit characters encoded as "=HH"
                                         'uuencode' );         // UUENCODE encoding

    /**
     * Content-Transfer-Encoding
     * Defaulted to '7bit'
     */
    var $_smtpsTransEncode = '7bit';

    /**
     * Boundary String for MIME seperation
     */
    var $_smtpsBoundary = null;

    /**
     * Determines the method inwhich the message are to be sent.
     * - 'sockets' [0] - conect via network to SMTP server - default
     * - 'pipe     [1] - use UNIX path to EXE
     * - 'phpmail  [2] - use the PHP built-in mail function
     * NOTE: Only 'sockets' is implemented
     */
    var $_transportType = 0;

    /**
     * If '$_transportType' is set to '1', then this variable is used
     * to define the UNIX file system path to the sendmail execuable
     */
    var $_mailPath = '/usr/lib/sendmail';

    /**
     * Sets the SMTP server timeout in seconds.
     */
    var $_smtpTimeout = 10;

    /**
     * Determines whether to calculate message MD5 checksum.
     */
    var $_smtpMD5 = false;

    /**
     * Class error codes and messages
     */
    var $_smtpsErrors = null;

    /**
     * Defines log level
     *  0 - no logging
     *  1 - connectivity logging
     *  2 - message generation logging
     *  3 - detail logging
     */
    var $_log_level = 0;

    /**
     * Place Class in" debug" mode
     */
    var $_debug = false;


    // DOL_CHANGE LDR
    var $log = '';
    var $_errorsTo = '';
    var $_deliveryReceipt = 0;




    function setDeliveryReceipt($_val = 0)
    {
        $this->_deliveryReceipt = $_val;
    }

    function getDeliveryReceipt()
    {
        return $this->_deliveryReceipt;
    }

    function setErrorsTo($_strErrorsTo)
    {
        if ( $_strErrorsTo )
        $this->_errorsTo = $this->_strip_email($_strErrorsTo);
    }

    function getErrorsTo ( $_part = true )
    {
        $_retValue = '';

        if ( $_part === true )
        $_retValue = $this->_errorsTo;
        else
        $_retValue = $this->_errorsTo[$_part];

        return $_retValue;
    }


    function setDebug( $_vDebug = false )
    {
        $this->_debug = $_vDebug;
    }

    /**
     * build RECIPIENT List, all addresses who will recieve this message
	 *
     * @return void
     */
    function buildRCPTlist()
    {
        // Pull TO list
        $_aryToList = $this->getTO();
    }

    /**
     * Attempt a connection to mail server
     *
     * @return mixed  $_retVal   Boolean indicating success or failure on connection
     */
    function _server_connect()
    {
        // Default return value
        $_retVal = true;

        // We have to make sure the HOST given is valid
        // This is done here because '@fsockopen' will not give me this
        // information if it failes to connect because it can't find the HOST
        $host=$this->getHost();
        $host=preg_replace('@tcp://@i','',$host);	// Remove prefix
        $host=preg_replace('@ssl://@i','',$host);	// Remove prefix

        // DOL_CHANGE LDR
        include_once(DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php');

        if ( (! is_ip($host)) && ((gethostbyname ( $host )) == $host) )
        {
            $this->_setErr(99, $host . ' is either offline or is an invalid host name.');
            $_retVal = false;
        }
        else
        {
            //See if we can connect to the SMTP server
            if ( $this->socket = @fsockopen($this->getHost(),       // Host to 'hit', IP or domain
            $this->getPort(),       // which Port number to use
            $this->errno,           // actual system level error
            $this->errstr,          // and any text that goes with the error
            $this->_smtpTimeout) )  // timeout for reading/writing data over the socket
            {
                // Fix from PHP SMTP class by 'Chris Ryan'
                // Sometimes the SMTP server takes a little longer to respond
                // so we will give it a longer timeout for the first read
                // Windows still does not have support for this timeout function
                if (function_exists('stream_set_timeout')) stream_set_timeout($this->socket, $this->_smtpTimeout, 0);

                // Check response from Server
                if ( $_retVal = $this->server_parse($this->socket, "220") )
                $_retVal = $this->socket;
            }
            // This connection attempt failed.
            else
            {
                // DOL_CHANGE LDR
                if (empty($this->errstr)) $this->errstr='Failed to connect with fsockopen host='.$this->getHost().' port='.$this->getPort();
                $this->_setErr($this->errno, $this->errstr);
                $_retVal = false;
            }
        }

        return $_retVal;
    }

    /**
     * Attempt mail server authentication for a secure connection
     *
     * @return mixed  $_retVal   Boolean indicating success or failure of authentication
     */
    function _server_authenticate()
    {
        // Send the RFC2554 specified EHLO.
        // This improvment as provided by 'SirSir' to
        // accomodate both SMTP AND ESMTP capable servers
        $host=$this->getHost();
        $host=preg_replace('@tcp://@i','',$host);	// Remove prefix
        $host=preg_replace('@ssl://@i','',$host);	// Remove prefix
        if ( $_retVal = $this->socket_send_str('EHLO ' . $host, '250') )
        {
            // Send Authentication to Server
            // Check for errors along the way
            $this->socket_send_str('AUTH LOGIN', '334');

            // User name will not return any error, server will take anything we give it.
            $this->socket_send_str(base64_encode($this->_smtpsID), '334');

            // The error here just means the ID/password combo doesn't work.
            // There is not a method to determine which is the problem, ID or password
            if ( ! $_retVal = $this->socket_send_str(base64_encode($this->_smtpsPW), '235') )
            $this->_setErr(130, 'Invalid Authentication Credentials.');
        }
        else
        {
            $this->_setErr(126, '"' . $host . '" does not support authenticated connections.');
        }

        return $_retVal;
    }

    /**
     * Now send the message
     *
     * @param  boolean $_bolTestMsg  whether to run this method in 'Test' mode.
     * @param  boolean $_bolDebug    whether to log all communication between this Class and the Mail Server.
     * @return mixed   void
     *                 $_strMsg      If this is run in 'Test' mode, the actual message structure will be returned
     */
    function sendMsg ( $_bolTestMsg = false, $_bolDebug = false )
    {
        /**
         * Default return value
         */
        $_retVal = false;

        // Connect to Server
        if ( $this->socket = $this->_server_connect() )
        {
            // If a User ID *and* a password is given, assume Authentication is desired
            if( !empty($this->_smtpsID) && !empty($this->_smtpsPW) )
            {
                // Send the RFC2554 specified EHLO.
                $_retVal = $this->_server_authenticate();
            }

            // This is a "normal" SMTP Server "handshack"
            else
            {
                // Send the RFC821 specified HELO.
                $host=$this->getHost();
                $host=preg_replace('@tcp://@i','',$host);	// Remove prefix
                $host=preg_replace('@ssl://@i','',$host);	// Remove prefix
                $_retVal = $this->socket_send_str('HELO ' . $host, '250');
            }

            // Well, did we get to the server?
            if ( $_retVal )
            {
                // From this point onward most server response codes should be 250
                // Specify who the mail is from....
                // This has to be the raw email address, strip the "name" off
                $this->socket_send_str('MAIL FROM: ' . $this->getFrom('addr' ), '250');

                // 'RCPT TO:' must be given a single address, so this has to loop
                // through the list of addresses, regardless of TO, CC or BCC
                // and send it out "single file"
                foreach ( $this->get_RCPT_list() as $_address )
                {
                    /*
                     * TODO
                     * After each 'RCPT TO:' is sent, we need to make sure it was kosher,
                     * if not, the whole message will fail
                     * If any email address fails, we will need to RESET the connection,
                     * mark the last address as "bad" and start the address loop over again.
                     * If any address fails, the entire message fails.
                     */
                    $this->socket_send_str('RCPT TO: <' . $_address . '>', '250');
                }

                // Tell the server we are ready to start sending data
                // with any custom headers...
                // This is the last response code we look for until the end of the message.
                $this->socket_send_str('DATA', '354');

                // Now we are ready for the message...
                // Ok, all the ingredients are mixed in let's cook this puppy...
                $this->socket_send_str($this->getHeader().$this->getBodyContent() . "\r\n" . '.', '250');

                // Now tell the server we are done and close the socket...
                fputs($this->socket, 'QUIT');
                fclose($this->socket );
            }
        }

        return $_retVal;
    }

    // =============================================================
    // ** Setter & Getter methods

    // ** Basic System configuration

    /**
     * setConfig() is used to populate select class properties from either
     * a user defined INI file or the systems 'php.ini' file
     *
     * If a user defined INI is to be used, the files complete path is passed
     * as the method single parameter. The INI can define any class and/or
     * user properties. Only properties defined within this file will be setter
     * and/or orverwritten
     *
     * If the systems 'php.ini' file is to be used, the method is called without
     * parameters. In this case, only HOST, PORT and FROM properties will be set
     * as they are the only properties that are defined within the 'php.ini'.
     *
     * If secure SMTP is to be used, the user ID and Password can be defined with
     * the user INI file, but the properties are not defined with the systems
     * 'php.ini'file, they must be defined via their setter methods
     *
     * This method can be called twice, if desired. Once without a parameter to
     * load the properties as defined within the systems 'php.ini' file, and a
     * second time, with a path to a user INI file for other properties to be
     * defined.
     *
     * @param mixed $_strConfigPath path to config file or VOID
     * @return void
     */
    function setConfig ( $_strConfigPath = null )
    {
        /**
         * Returns constructed SELECT Object string or boolean upon failure
         * Default value is set at TRUE
         */
        $_retVal = true;

        // if we have a path...
        if ( ! empty ($_strConfigPath) )
        {
            // If the path is not valid, this will NOT generate an error,
            // it will simply return FALSE.
            if ( ! @include ( $_strConfigPath ) )
            {
                $this->_setErr(110, '"' . $_strConfigPath . '" is not a valid path.');
                $_retVal = false;
            }
        }

        // Read the Systems php.ini file
        else
        {
            // Set these properties ONLY if they are set in the php.ini file.
            // Otherwise the default values will be used.
            if ( $_host = ini_get ('SMTPs') )
            $this->setHost($_host);

            if ( $_port = ini_get ('smtp_port') )
            $this->setPort($_port);

            if ( $_from = ini_get ('sendmail_from') )
            $this->setFrom($_from);
        }

        // Send back what we have
        return $_retVal;
    }

    /**
     * Determines the method inwhich the messages are to be sent.
     * - 'sockets' [0] - conect via network to SMTP server
     * - 'pipe     [1] - use UNIX path to EXE
     * - 'phpmail  [2] - use the PHP built-in mail function
     *
     * @param int $_type  Interger value representing Mail Transport Type
     * @return void
     */
    function setTransportType($_type = 0)
    {
        if ( ( is_numeric ($_type) ) &&
        ( ( $_type >= 0 ) && ( $_type <= 3 ) ) )
        $this->_transportType = $_type;
    }

    /**
     * Return the method inwhich the message is to be sent.
     * - 'sockets' [0] - conect via network to SMTP server
     * - 'pipe     [1] - use UNIX path to EXE
     * - 'phpmail  [2] - use the PHP built-in mail function
     *
     * @return int $_strHost Host Name or IP of the Mail Server to use
     */
    function getTransportType()
    {
        return $this->_transportType;
    }

    /**
     * Path to the sendmail execuable
     *
     * @param string $_path Path to the sendmail execuable
     * @return void
     *
     */
    function setMailPath($_path)
    {
        // This feature is not yet implemented
        return true;

        if ( $_path )
        $this->_mailPath = $_path;
    }

    /**
     * Defines the Host Name or IP of the Mail Server to use.
     * This is defaulted to 'localhost'
     * This is  used only with 'socket' based mail transmission
     *
     * @param 	string 	$_strHost 		Host Name or IP of the Mail Server to use
     * @return 	void
     */
    function setHost($_strHost)
    {
        if ( $_strHost )
        $this->_smtpsHost = $_strHost;
    }

    /**
     * Retrieves the Host Name or IP of the Mail Server to use
     * This is  used only with 'socket' based mail transmission
     *
     * @return 	string 	$_strHost 		Host Name or IP of the Mail Server to use
     */
    function getHost()
    {
        return $this->_smtpsHost;
    }

    /**
     * Defines the Port Number of the Mail Server to use
     * This is defaulted to '25'
     * This is  used only with 'socket' based mail transmission
     *
     * @param 	int 	$_intPort 		Port Number of the Mail Server to use
     * @return 	void
     */
    function setPort($_intPort)
    {
        if ( ( is_numeric ($_intPort) ) &&
        ( ( $_intPort >= 1 ) && ( $_intPort <= 65536 ) ) )
        $this->_smtpsPort = $_intPort;
    }

    /**
     * Retrieves the Port Number of the Mail Server to use
     * This is  used only with 'socket' based mail transmission
     *
     * @return 	string 		Port Number of the Mail Server to use
     */
    function getPort()
    {
        return $this->_smtpsPort;
    }

    /**
     * User Name for authentication on Mail Server
     *
     * @param 	string 	$_strID 	User Name for authentication on Mail Server
     * @return 	void
     */
    function setID($_strID)
    {
        $this->_smtpsID = $_strID;
    }

    /**
     * Retrieves the User Name for authentication on Mail Server
     *
     * @return string 	User Name for authentication on Mail Server
     */
    function getID()
    {
        return $this->_smtpsID;
    }

    /**
     * User Password for authentication on Mail Server
     *
     * @param 	string 	$_strPW 	User Password for authentication on Mail Server
     * @return 	void
     */
    function setPW($_strPW)
    {
        $this->_smtpsPW = $_strPW;
    }

    /**
     * Retrieves the User Password for authentication on Mail Server
     *
     * @return 	string 		User Password for authentication on Mail Server
     */
    function getPW()
    {
        return $this->_smtpsPW;
    }

    /**
     * Character set used for current message
     * Character set is defaulted to 'iso-8859-1';
     *
     * @param string $_strCharSet Character set used for current message
     * @return void
     */
    function setCharSet($_strCharSet)
    {
        if ( $_strCharSet )
        $this->_smtpsCharSet = $_strCharSet;
    }

    /**
     * Retrieves the Character set used for current message
     *
     * @return string $_smtpsCharSet Character set used for current message
     */
    function getCharSet()
    {
        return $this->_smtpsCharSet;
    }

    /**
     * Content-Transfer-Encoding, Defaulted to '7bit'
     * This can be changed for 2byte characers sets
     * Known Encode Types
     *  - 7bit               Simple 7-bit ASCII
     *  - 8bit               8-bit coding with line termination characters
     *  - base64             3 octets encoded into 4 sextets with offset
     *  - binary             Arbitrary binary stream
     *  - mac-binhex40       Macintosh binary to hex encoding
     *  - quoted-printable   Mostly 7-bit, with 8-bit characters encoded as "=HH"
     *  - uuencode           UUENCODE encoding
     *
     * @param string $_strTransEncode Content-Transfer-Encoding
     * @return void
     */
    function setTransEncode ( $_strTransEncode )
    {
        if ( array_search ( $_strTransEncode, $this->_smtpsTransEncodeTypes ) )
        $this->_smtpsTransEncode = $_strTransEncode;
    }

    /**
     * Retrieves the Content-Transfer-Encoding
     *
     * @return string $_smtpsTransEncode Content-Transfer-Encoding
     */
    function getTransEncode()
    {
        return $this->_smtpsTransEncode;
    }

    /**
     * Content-Transfer-Encoding, Defaulted to '0' [ZERO]
     * This can be changed for 2byte characers sets
     * Known Encode Types
     *  - [0] 7bit               Simple 7-bit ASCII
     *  - [1] 8bit               8-bit coding with line termination characters
     *  - [2] base64             3 octets encoded into 4 sextets with offset
     *  - [3] binary             Arbitrary binary stream
     *  - [4] mac-binhex40       Macintosh binary to hex encoding
     *  - [5] quoted-printable   Mostly 7-bit, with 8-bit characters encoded as "=HH"
     *  - [6] uuencode           UUENCODE encoding
     *
     * @param string $_strTransEncodeType Content-Transfer-Encoding
     * @return void
     *
     */
    function setTransEncodeType($_strTransEncodeType)
    {
        if (array_search($_strTransEncodeType, $this->_smtpsTransEncodeTypes))
        $this->_smtpsTransEncodeType = $_strTransEncodeType;
    }

    /**
     * Retrieves the Content-Transfer-Encoding
     *
     * @return 	string 		Content-Transfer-Encoding
     */
    function getTransEncodeType()
    {
        return $this->_smtpsTransEncodeTypes[$this->_smtpsTransEncodeType];
    }


    // ** Message Construction

    /**
     * FROM Address from which mail will be sent
     *
     * @param 	string 	$_strFrom 	Address from which mail will be sent
     * @return 	void
     */
    function setFrom($_strFrom)
    {
        if ( $_strFrom )
        $this->_msgFrom = $this->_strip_email($_strFrom);
    }

    /**
     * Retrieves the Address from which mail will be sent
     *
     * @param  	boolean $_part		To "strip" 'Real name' from address
     * @return 	string 				Address from which mail will be sent
     */
    function getFrom($_part = true)
    {
        $_retValue = '';

        if ( $_part === true )
        $_retValue = $this->_msgFrom;
        else
        $_retValue = $this->_msgFrom[$_part];

        return $_retValue;
    }


    /**
     * Inserts given addresses into structured format.
     * This method takes a list of given addresses, via an array
     * or a COMMA delimted string, and inserts them into a highly
     * structured array. This array is designed to remove duplicate
     * addresses and to sort them by Domain.
     *
     * @param 	string 	$_type 			TO, CC, or BCC lists to add addrresses into
     * @param 	mixed 	$_addrList 		Array or COMMA delimited string of addresses
     * @return void
     *
     */
    function _buildAddrList( $_type, $_addrList )
    {
        // Pull existing list
        $aryHost = $this->_msgRecipients;

        // Only run this if we have something
        if ( !empty ($_addrList ))
        {
            // $_addrList can be a STRING or an array
            if ( is_string ($_addrList) )
            {
                // This could be a COMMA delimited string
                if ( strstr ($_addrList, ',') )
                // "explode "list" into an array
                $_addrList = explode (',', $_addrList);

                // Stick it in an array
                else
                $_addrList = array($_addrList);
            }

            // take the array of addresses and split them further
            foreach ( $_addrList as $_strAddr )
            {
                // Strip off the end '>'
                $_strAddr = str_replace ('>', '', $_strAddr);

                // Seperate "Real Name" from eMail address
                $_tmpaddr = null;
                $_tmpaddr = explode ('<', $_strAddr);

                // We have a "Real Name" and eMail address
                if ( count ($_tmpaddr) == 2 )
                {
                    $_tmpHost = explode ('@', $_tmpaddr[1]);
                    $_tmpaddr[0] = trim ($_tmpaddr[0], ' ">');
                    $aryHost[$_tmpHost[1]][$_type][$_tmpHost[0]] = $_tmpaddr[0];
                }
                // We only have an eMail address
                else
                {
                    // Strip off the beggining '<'
                    $_strAddr = str_replace ('<', '', $_strAddr);

                    $_tmpHost = explode ('@', $_strAddr);
                    $_tmpHost[0] = trim ($_tmpHost[0]);
                    $_tmpHost[1] = trim ($_tmpHost[1]);

                    $aryHost[$_tmpHost[1]][$_type][$_tmpHost[0]] = '';
                }
            }
        }
        // replace list
        $this->_msgRecipients = $aryHost;
    }

    /**
     * Returns an array of the various parts of an email address
     * This assumes a well formed address:
     * - "Real name" <username@domain.tld>
     * - "Real Name" is optional
     * - if "Real Name" does not exist, the angle brackets are optional
     * This will split an email address into 4 or 5 parts.
     * - $_aryEmail[org]  = orignal string
     * - $_aryEmail[real] = "real name" - if there is one
     * - $_aryEmail[addr] = address part "username@domain.tld"
     * - $_aryEmail[host] = "domain.tld"
     * - $_aryEmail[user] = "userName"
     *
     *	@param		string		$_strAddr		Email address
     * 	@return 	array	 					An array of the various parts of an email address
     */
    function _strip_email($_strAddr)
    {
        // Keep the orginal
        $_aryEmail['org'] = $_strAddr;

        // Set entire string to Lower Case
        $_strAddr = strtolower ($_strAddr);

        // Drop "stuff' off the end
        $_strAddr = trim ($_strAddr, ' ">');

        // Seperate "Real Name" from eMail address, if we have one
        $_tmpAry = explode ('<', $_strAddr);

        // Do we have a "Real name"
        if ( count ($_tmpAry) == 2 )
        {
            // We may not really have a "Real Name"
            if ( $_tmpAry[0])
            $_aryEmail['real'] = trim ($_tmpAry[0], ' ">');

            $_aryEmail['addr'] = $_tmpAry[1];
        }
        else
        $_aryEmail['addr'] = $_tmpAry[0];

        // Pull User Name and Host.tld apart
        list($_aryEmail['user'], $_aryEmail['host'] ) = explode ('@', $_aryEmail['addr']);

        // Put the brackets back around the address
        $_aryEmail['addr'] = '<' . $_aryEmail['addr'] . '>';

        return $_aryEmail;
    }

    /**
     * Returns an array of bares addresses for use with 'RCPT TO:'
     * This is a "build as you go" method. Each time this method is called
     * the underlaying array is destroyed and reconstructed.
     *
     * @return 		array		Returns an array of bares addresses
     */
    function get_RCPT_list()
    {
        /**
         * An array of bares addresses for use with 'RCPT TO:'
         */
        unset ($_RCPT_list);

        // walk down Recipients array and pull just email addresses
        foreach ( $this->_msgRecipients as $_host => $_list )
        {
            foreach ( $_list as $_subList )
            {
                foreach ( $_subList as $_name => $_addr )
                {
                    // build RCPT list
                    $_RCPT_list[] = $_name . '@' . $_host;
                }
            }
        }

        return $_RCPT_list;
    }

    /**
     * Returns an array of addresses for a specific type; TO, CC or BCC
     *
     * @param 		mixed 	$_which 	Which collection of adresses to return
     * @return 		array 				Array of emaill address
     */
    function get_email_list($_which = null)
    {
        // We need to know which address segment to pull
        if ( $_which )
        {
            // Make sure we have addresses to process
            if ( $this->_msgRecipients )
            {
                $_RCPT_list=array();
                // walk down Recipients array and pull just email addresses
                foreach ( $this->_msgRecipients as $_host => $_list )
                {
                    if ( $this->_msgRecipients[$_host][$_which] )
                    {
                        foreach ( $this->_msgRecipients[$_host][$_which] as $_addr => $_realName )
                        {
                            if ( $_realName )	// DOL_CHANGE FIX
                            {
                                $_realName = '"' . $_realName . '"';
                                $_RCPT_list[] = $_realName . ' <' . $_addr . '@' . $_host . '>';
                            }
                            else
                            {
                                $_RCPT_list[] = $_addr . '@' . $_host;
                            }
                        }
                    }
                }

                return implode(', ', $_RCPT_list);
            }
            else
            {
                $this->_setErr(101, 'No eMail Address for message to be sent to.');
                return false;
            }
        }
        else
        {
            $this->_setErr(102, 'eMail type not defined.');
            return false;
        }

    }

    /**
     * TO Address[es] inwhich to send mail to
     *
     * @param 	mixed 	$_addrTo 	TO Address[es] inwhich to send mail to
     * @return 	void
     */
    function setTO($_addrTo)
    {
        if ( $_addrTo )
        $this->_buildAddrList('to', $_addrTo);
    }

    /**
     * Retrieves the TO Address[es] inwhich to send mail to
     *
     * @return 	string 	TO Address[es] inwhich to send mail to
     */
    function getTo()
    {
        return $this->get_email_list('to');
    }

    /**
     * CC Address[es] inwhich to send mail to
     *
     * @param 	string	$_strCC		CC Address[es] inwhich to send mail to
     * @return 	void
     */
    function setCC($_strCC)
    {
        if ( $_strCC )
        $this->_buildAddrList('cc', $_strCC);
    }

    /**
     * Retrieves the CC Address[es] inwhich to send mail to
     *
     * @return 	string 		CC Address[es] inwhich to send mail to
     */
    function getCC()
    {
        return $this->get_email_list('cc');
    }

    /**
     * BCC Address[es] inwhich to send mail to
     *
     * @param 	string		$_strBCC	Recipients BCC Address[es] inwhich to send mail to
     * @return 	void
     */
    function setBCC($_strBCC)
    {
        if ( $_strBCC )
        $this->_buildAddrList('bcc', $_strBCC);
    }

    /**
     * Retrieves the BCC Address[es] inwhich to send mail to
     *
     * @return 	string		BCC Address[es] inwhich to send mail to
     */
    function getBCC()
    {
        return $this->get_email_list('bcc');
    }

    /**
     * Message Subject
     *
     * @param 	string 	$_strSubject	Message Subject
     * @return 	void
     */
    function setSubject($_strSubject = '')
    {
        if ( $_strSubject )
        $this->_msgSubject = $_strSubject;
    }

    /**
     * Retrieves the Message Subject
     *
     * @return 	string 		Message Subject
     */
    function getSubject()
    {
        return $this->_msgSubject;
    }

    /**
     * Constructes and returns message header
     *
     * @return string Complete message header
     */
    function getHeader()
    {
        $_header = 'From: '       . $this->getFrom( 'org' ) . "\r\n"
        . 'To: '         . $this->getTO()          . "\r\n";

        if ( $this->getCC() )
        $_header .= 'Cc: ' . $this->getCC()  . "\r\n";

        if ( $this->getBCC() )
        $_header .= 'Bcc: ' . $this->getBCC()  . "\r\n";

        $host=$this->getHost();
        $host=preg_replace('@tcp://@i','',$host);	// Remove prefix
        $host=preg_replace('@ssl://@i','',$host);	// Remove prefix

        //NOTE: Message-ID should probably contain the username of the user who sent the msg
        $_header .= 'Subject: '    . $this->getSubject()     . "\r\n"
        .  'Date: '       . date("r")               . "\r\n"
        .  'Message-ID: <' . time() . '.SMTPs@' . $host . ">\r\n";
        //                 . 'Read-Receipt-To: '   . $this->getFrom( 'org' ) . "\r\n"
        //                 . 'Return-Receipt-To: ' . $this->getFrom( 'org' ) . "\r\n";

        if ( $this->getSensitivity() )
        $_header .= 'Sensitivity: ' . $this->getSensitivity()  . "\r\n";

        if ( $this->_msgPriority != 3 )
        $_header .= $this->getPriority();


        // DOL_CHANGE LDR
        if ( $this->getDeliveryReceipt() )
        $_header .= 'Disposition-Notification-To: '.$this->getFrom('addr') . "\r\n";
        if ( $this->getErrorsTo() )
        $_header .= 'Errors-To: '.$this->getErrorsTo('addr') . "\r\n";


        $_header .= 'X-Mailer: Dolibarr version ' . DOL_VERSION .' (using SMTPs Mailer)'                   . "\r\n"
        .  'Mime-Version: 1.0'                            . "\r\n";

        return $_header;
    }

    /**
     * Message Content
     *
     * @param string $_msgContent Message Content
     * @return void
     */
    function setBodyContent ( $strContent, $strType = 'plain' )
    {
        //if ( $strContent )
        //{
        if ( $strType == 'html' )
        $strMimeType = 'text/html';
        else
        $strMimeType = 'text/plain';

        // Make RFC821 Compliant, replace bare linefeeds
        $strContent = preg_replace("/(?<!\r)\n/si", "\r\n", $strContent );

        $strContent = rtrim(wordwrap($strContent));

        $this->_msgContent[$strType] = array();

        $this->_msgContent[$strType]['mimeType'] = $strMimeType;
        $this->_msgContent[$strType]['data']     = $strContent;

        if ( $this->getMD5flag() )
        $this->_msgContent[$strType]['md5']      = dol_hash($strContent);
        //}
    }

    /**
     * Retrieves the Message Content
     *
     * @return 	string			Message Content
     */
    function getBodyContent()
    {
        // Generate a new Boundary string
        $this->_setBoundary();

        // What type[s] of content do we have
        $_types = array_keys ($this->_msgContent);

        // How many content types do we have
        $keyCount = count ($_types);

        // If we have ZERO, we have a problem
        if( $keyCount === 0 )
        die ("Sorry, no content");

        // If we have ONE, we can use the simple format
        else if( $keyCount === 1 )
        {
            $_msgData = $this->_msgContent;
            $_msgData = $_msgData[$_types[0]];

            $content = 'Content-Type: ' . $_msgData['mimeType'] . '; charset="' . $this->getCharSet() . '"' . "\r\n"
            . 'Content-Transfer-Encoding: ' . $this->getTransEncodeType() . "\r\n"
            . 'Content-Disposition: inline'  . "\r\n"
            . 'Content-Description: message' . "\r\n";

            if ( $this->getMD5flag() )
            $content .= 'Content-MD5: ' . $_msgData['md5'] . "\r\n";

            $content .= "\r\n"
            .  $_msgData['data'] . "\r\n";
        }

        // If we have more than ONE, we use the multi-part format
        else if( $keyCount > 1 )
        {
            // Since this is an actual multi-part message
            // We need to define a content message Boundary
            // NOTE: This was 'multipart/alternative', but Windows based
            //       mail servers have issues with this.
            /*
            * TODO  Investigate "nested" boundary message parts
            */
            //$content = 'Content-Type: multipart/related; boundary="' . $this->_getBoundary() . '"'   . "\r\n";
            $content = 'Content-Type: multipart/mixed; boundary="' . $this->_getBoundary() . '"'   . "\r\n";

            // TODO Restore
            //                     . "\r\n"
            //                     . 'This is a multi-part message in MIME format.' . "\r\n";
            $content .= "Content-Transfer-Encoding: 8bit" . "\r\n";
            $content .= "\r\n";

            // Loop through message content array
            foreach ($this->_msgContent as $type => $_content )
            {
                if ( $type == 'attachment' )
                {
                    // loop through all attachments
                    foreach ( $_content as $_file => $_data )
                    {

                        // TODO Restore "\r\n"
                        $content .= "--" . $this->_getBoundary() . "\r\n"
                        .  'Content-Disposition: attachment; filename="' . $_data['fileName'] . '"' . "\r\n"
                        .  'Content-Type: ' . $_data['mimeType'] . '; name="' . $_data['fileName'] . '"' . "\r\n"
                        .  'Content-Transfer-Encoding: base64' . "\r\n"
                        .  'Content-Description: File Attachment' . "\r\n";

                        if ( $this->getMD5flag() )
                        $content .= 'Content-MD5: ' . $_data['md5'] . "\r\n";

                        $content .= "\r\n"
                        .  $_data['data'] . "\r\n"
                        . "\r\n";
                    }
                }
                // DOL_CHANGE LDR
                else if ( $type == 'image' )
                {
                    // loop through all images
                    foreach ( $_content as $_image => $_data )
                    {
                        // TODO Restore "\r\n"
                        $content .= "--" . $this->_getBoundary() . "\r\n";

                        $content .= 'Content-Type: ' . $_data['mimeType'] . '; name="' . $_data['imageName'] . '"' . "\r\n"
                        .  'Content-Transfer-Encoding: base64' . "\r\n"
                        .  'Content-Disposition: inline; filename="' . $_data['imageName'] . '"' . "\r\n"
                        .  'Content-ID: <' . $_data['cid'] . '> ' . "\r\n";

                        if ( $this->getMD5flag() )
                        $content .= 'Content-MD5: ' . $_data['md5'] . "\r\n";

                        $content .= "\r\n"
                        . $_data['data'] . "\r\n";
                    }
                }
                else
                {
                    // TODO Restore "\r\n"
                    $content .= "--" . $this->_getBoundary() . "\r\n"
                    . 'Content-Type: ' . $_content['mimeType'] . '; '
                    //                             . 'charset="' . $this->getCharSet() . '"';
                    . 'charset=' . $this->getCharSet() . '';

                    // TODO Restore
                    //                    $content .= ( $type == 'html') ? '; name="HTML Part"' : '';
                    $content .=  "\r\n";
                    //                    $content .= 'Content-Transfer-Encoding: ';
                    //                    $content .= ($type == 'html') ? 'quoted-printable' : $this->getTransEncodeType();
                    //                    $content .=  "\r\n"
                    //                             . 'Content-Disposition: inline'  . "\r\n"
                    //                             . 'Content-Description: ' . $type . ' message' . "\r\n";

                    if ( $this->getMD5flag() )
                    $content .= 'Content-MD5: ' . $_content['md5'] . "\r\n";

                    $content .= "\r\n"
                    . $_content['data'] . "\r\n"
                    . "\r\n";
                }
            }

            // Close message boundries
            //            $content .= "\r\n--" . $this->_getBoundary() . '--' . "\r\n" ;
            $content .= "--" . $this->_getBoundary() . '--' . "\r\n" ;
        }

        return $content;
    }

    /**
     * File attachments are added to the content array as sub-arrays,
     * allowing for multiple attachments for each outbound email
     *
     * @param string $strContent  File data to attach to message
     * @param string $strFileName File Name to give to attachment
     * @param string $strMimeType File Mime Type of attachment
     * @return void
     */
    function setAttachment($strContent, $strFileName = 'unknown', $strMimeType = 'unknown')
    {
        if ( $strContent )
        {
            $strContent = rtrim(chunk_split(base64_encode($strContent), 76, "\r\n"));

            $this->_msgContent['attachment'][$strFileName]['mimeType'] = $strMimeType;
            $this->_msgContent['attachment'][$strFileName]['fileName'] = $strFileName;
            $this->_msgContent['attachment'][$strFileName]['data']     = $strContent;

            if ( $this->getMD5flag() )
            $this->_msgContent['attachment'][$strFileName]['md5']      = dol_hash($strContent);
        }
    }


    // DOL_CHANGE LDR

    /**
     * Image attachments are added to the content array as sub-arrays,
     * allowing for multiple images for each outbound email
     *
     * @param 	string $strContent  	Image data to attach to message
     * @param 	string $strImageName 	Image Name to give to attachment
     * @param 	string $strMimeType 	Image Mime Type of attachment
     * @param 	string $strImageCid		CID
     * @return 	void
     */
    function setImageInline($strContent, $strImageName = 'unknown', $strMimeType = 'unknown', $strImageCid = 'unknown')
    {
        if ($strContent)
        {
            $this->_msgContent['image'][$strImageName]['mimeType'] = $strMimeType;
            $this->_msgContent['image'][$strImageName]['imageName'] = $strImageName;
            $this->_msgContent['image'][$strImageName]['cid']      = $strImageCid;
            $this->_msgContent['image'][$strImageName]['data']     = $strContent;

            if ( $this->getMD5flag() )
            $this->_msgContent['image'][$strFileName]['md5']      = dol_hash($strContent);
        }
    }
    // END DOL_CHANGE LDR


    /**
     * Message Content Sensitivity
     * Message Sensitivity values:
     *   - [0] None - default
     *   - [1] Personal
     *   - [2] Private
     *   - [3] Company Confidential
     *
     * @param 	string	$_value		Message Sensitivity
     * @return 	void
     */
    function setSensitivity($_value = 0)
    {
        if ( ( is_numeric ($_value) ) &&
        ( ( $_value >= 0 ) && ( $_value <= 3 ) ) )
        $this->_msgSensitivity = $_value;
    }

    /**
     * Returns Message Content Sensitivity string
     * Message Sensitivity values:
     *   - [0] None - default
     *   - [1] Personal
     *   - [2] Private
     *   - [3] Company Confidential
     *
     * @param 	string 	Message Sensitivity
     * @return 	void
     */
    function getSensitivity()
    {
        return $this->_arySensitivity[$this->_msgSensitivity];
    }

    /**
     * Message Content Priority
     * Message Priority values:
     *  - [0] 'Bulk'
     *  - [1] 'Highest'
     *  - [2] 'High'
     *  - [3] 'Normal' - default
     *  - [4] 'Low'
     *  - [5] 'Lowest'
     *
     * @param 	string 	$_value 	Message Priority
     * @return 	void
     */
    function setPriority ( $_value = 3 )
    {
        if ( ( is_numeric ($_value) ) &&
        ( ( $_value >= 0 ) && ( $_value <= 5 ) ) )
        $this->_msgPriority = $_value;
    }

    /**
     * Message Content Priority
     * Message Priority values:
     *  - [0] 'Bulk'
     *  - [1] 'Highest'
     *  - [2] 'High'
     *  - [3] 'Normal' - default
     *  - [4] 'Low'
     *  - [5] 'Lowest'
     *
     * @return void
     */
    function getPriority()
    {
        return 'Importance: ' . $this->_aryPriority[$this->_msgPriority] . "\r\n"
        . 'Priority: '   . $this->_aryPriority[$this->_msgPriority] . "\r\n"
        . 'X-Priority: ' . $this->_msgPriority . ' (' . $this->_aryPriority[$this->_msgPriority] . ')' . "\r\n";
    }

    /**
     * Set flag which determines whether to calculate message MD5 checksum.
     *
     * @param 	string 	$_flag		Message Priority
     * @return 	void
     */
    function setMD5flag($_flag = false)
    {
        $this->_smtpMD5 = $_flag;
    }

    /**
     * Gets flag which determines whether to calculate message MD5 checksum.
     *
     * @return 	string 				Message Priority
     */
    function getMD5flag()
    {
        return $this->_smtpMD5;
    }

    /**
     * Message X-Header Content
     * This is a simple "insert". Whatever is given will be placed
     * "as is" into the Xheader array.
     *
     * @param string $strXdata Message X-Header Content
     * @return void
     */
    function setXheader($strXdata)
    {
        if ( $strXdata )
        $this->_msgXheader[] = $strXdata;
    }

    /**
     * Retrieves the Message X-Header Content
     *
     * @return string $_msgContent Message X-Header Content
     */
    function getXheader()
    {
        return $this->_msgXheader;
    }

    /**
     * Generates Random string for MIME message Boundary
     *
     * @return void
     */
    function _setBoundary()
    {
        $this->_smtpsBoundary = "multipart_x." . time() . ".x_boundary";
    }

    /**
     * Retrieves the MIME message Boundary
     *
     * @return string $_smtpsBoundary MIME message Boundary
     */
    function _getBoundary()
    {
        return $this->_smtpsBoundary;
    }

    /**
     * This function has been modified as provided by SirSir to allow multiline responses when
     * using SMTP Extensions
     *
     * @param	$socket
     * @param	$response
     */
    function server_parse($socket, $response)
    {
        /**
         * Returns constructed SELECT Object string or boolean upon failure
         * Default value is set at TRUE
         */
        $_retVal = true;

        $server_response = '';

        while ( substr($server_response,3,1) != ' ' )
        {
            if( !( $server_response = fgets($socket, 256) ) )
            {
                $this->_setErr(121, "Couldn't get mail server response codes");
                $_retVal = false;
            }
        }

        if( !( substr($server_response, 0, 3) == $response ) )
        {
            $this->_setErr(120, "Ran into problems sending Mail.\r\nResponse: $server_response");
            $_retVal = false;
        }

        return $_retVal;
    }

    function socket_send_str ( $_strSend, $_returnCode = null, $CRLF = "\r\n" )
    {
        if ($this->_debug) $this->log.=$_strSend;	// DOL_CHANGE LDR for log
        fputs($this->socket, $_strSend . $CRLF);
        if ($this->_debug) $this->log.=' ('.$_returnCode.')' . $CRLF;

        if ( $_returnCode )
        return $this->server_parse($this->socket, $_returnCode);
    }

    // =============================================================
    // ** Error handling methods

    /**
     * Defines errors codes and messages for Class
     *
     * @param  int    $_errNum  Error Code Number
     * @param  string $_errMsg  Error Message
     * @return void
     */
    function _setErr ( $_errNum, $_errMsg )
    {
        $this->_smtpsErrors[] = array( 'num' => $_errNum,
                                       'msg' => $_errMsg );
    }

    /**
     * Returns errors codes and messages for Class
     *
     * @return string $_errMsg  Error Message
     */
    function getErrors()
    {
        $_errMsg = array();

        foreach ( $this->_smtpsErrors as $_err => $_info )
        {
            $_errMsg[] = 'Error [' . $_info['num'] .']: '. $_info['msg'];
        }

        return implode("\n", $_errMsg);
    }


}


// =============================================================
// ** CSV Version Control Info

/**
 * Revision      2011/09/12 07:49:59  eldy
 * Doxygen
 *
 * Revision      2011/09/06 06:53:53  hregis
 * Fix: use dol_hash instead md5 php function
 *
 * Revision      2011/09/03 00:14:27  eldy
 * Doxygen
 *
 * Revision      2011/08/28 14:24:23  eldy
 * Doxygen
 *
 * Revision      2011/07/12 22:19:02  eldy
 * Fix: Attachment fails if content was empty
 *
 * Revision      2011/06/20 23:17:50  hregis
 * Fix: use best structure of mail
 *
 * Revision      2010/04/13 20:58:37  eldy
 * Fix: Can provide ip address on smtps. Better error reporting.
 *
 * Revision      2010/04/13 20:30:25  eldy
 * Fix: Can provide ip address on smtps. Better error reporting.
 *
 * Revision      2010/01/12 13:02:07  hregis
 * Fix: missing attach-files
 *
 * Revision      2009/11/01 14:16:30  eldy
 * Fix: Sending mail with SMTPS was not working.
 *
 * Revision      2009/10/20 13:14:47  hregis
 * Fix: function "split" is deprecated since php 5.3.0
 *
 * Revision      2009/05/13 19:10:07  eldy
 * New: Can use inline images.Everything seems to work with thunderbird and webmail gmail. New to be tested on other mail browsers.
 *
 * Revision      2009/05/13 14:49:30  eldy
 * Fix: Make code so much simpler and solve a lot of problem with new version.
 *
 * Revision      2009/02/09 00:04:35  eldy
 * Added support for SMTPS protocol
 *
 * Revision       2008/04/16 23:11:45  eldy
 * New: Add action "Test server connectivity"
 *
 * Revision 1.18  2007/01/12 22:17:08  ongardie
 * - Added full_http_site_root() to utils-misc.php
 * - Made SMTPs' getError() easier to use
 * - Improved activity modified emails
 *
 * Revision 1.17  2006/04/05 03:15:40  ongardie
 * -Fixed method name typo that resulted in a fatal error.
 *
 * Revision 1.16  2006/03/08 04:05:25  jswalter
 *  - '$_smtpsTransEncode' was removed and '$_smtpsTransEncodeType' is now used
 *  - '$_smtpsTransEncodeType' is defaulted to ZERO
 *  - corrected 'setCharSet()'  internal vars
 *  - defined '$_mailPath'
 *  - added '$_smtpMD5' as a class property
 *  - added 'setMD5flag()' to set above property
 *  - added 'getMD5flag()' to retrieve above property
 *  - 'setAttachment()' will add an MD5 checksum to attachements if above property is set
 *  - 'setBodyContent()' will add an MD5 checksum to message parts if above property is set
 *  - 'getBodyContent()' will insert the MD5 checksum for messages and attachments if above property is set
 *  - removed leading dashes from message boundry
 *  - added propery "Close message boundry" tomessage block
 *  - corrected some comments in various places
 *  - removed some incorrect comments in others
 *
 * Revision 1.15  2006/02/21 02:00:07  vanmer
 * - patch to add support for sending to exim mail server
 * - thanks to Diego Ongaro at ETSZONE (diego@etszone.com)
 *
 * Revision 1.14  2005/08/29 16:22:10  jswalter
 *  - change 'multipart/alternative' to 'multipart/mixed', but Windows based mail servers have issues with this.
 * Bug 594
 *
 * Revision 1.13  2005/08/21 01:57:30  vanmer
 * - added initialization for array if no recipients exist
 *
 * Revision 1.12  2005/08/20 12:04:30  braverock
 * - remove potentially binary characters from Message-ID
 * - add getHost to get the hostname of the mailserver
 * - add username to Message-ID header
 *
 * Revision 1.11  2005/08/20 11:49:48  braverock
 * - fix typos in boundary
 * - remove potentially illegal characters from boundary
 *
 * Revision 1.10  2005/08/19 20:39:32  jswalter
 *  - added _server_connect()' as a seperate method to handle server connectivity.
 *  - added '_server_authenticate()' as a seperate method to handle server authentication.
 *  - 'sendMsg()' now uses the new methods to handle server communication.
 *  - modified 'server_parse()' and 'socket_send_str()' to give error codes and messages.
 *
 * Revision 1.9  2005/08/19 15:40:18  jswalter
 *  - IMPORTANT: 'setAttachement()' is now spelled correctly: 'setAttachment()'
 *  - added additional comment to several methods
 *  - added '$_smtpsTransEncodeTypes' array to limit encode types
 *  - added parameters to 'sendMsg()' for future development around debugging and logging
 *  - added error code within 'setConfig()' if the given path is not found
 *  - 'setTransportType()' now has parameter validation
 *     [this still is not implemented]
 *  - 'setPort()' now does parameter validation
 *  - 'setTransEncode()' now has parameter validation against '$_smtpsTransEncodeTypes'
 *  - modified 'get_email_list()' to handle error handling
 *  - 'setSensitivity()' now has parameter validation
 *  - 'setPriority()' now has parameter validation
 *
 * Revision 1.8  2005/06/24 21:00:20  jswalter
 *   - corrected comments
 *   - corrected the defualt value for 'setPriority()'
 *   - modified 'setAttachement()' to process multiple attachments correctly
 *   - modified 'getBodyContent()' to handle multiple attachments
 * Bug 310
 *
 * Revision 1.7  2005/05/19 21:12:34  braverock
 * - replace chunk_split() with wordwrap() to fix funky wrapping of templates
 *
 * Revision 1.6  2005/04/25 04:55:06  jswalter
 *  - cloned from Master Version
 *
 * Revision 1.10  2005/04/25 04:54:10  walter
 *  - "fixed" 'getBodyContent()' to handle a "simple" text only message
 *
 * Revision 1.9  2005/04/25 03:52:01  walter
 *  - replace closing curly bracket. Removed it in last revision!
 *
 * Revision 1.8  2005/04/25 02:29:49  walter
 *  - added '$_transportType' and its getter/setter methods.
 *    for future use. NOT yet implemented.
 *  - in 'sendMsg()', added HOST validation check
 *  - added error check for initial Socket Connection
 *  - created new method 'socket_send_str()' to process socket
 *    communication in a unified means. Socket calls within
 *    'sendMsg()' have been modified to use this new method.
 *  - expanded comments in 'setConfig()'
 *  - added "error" check on PHP ini file properties. If these
 *    properties not set within the INI file, the default values
 *    will be used.
 *  - modified 'get_RCPT_list()' to reset itself each time it is called
 *  - modified 'setBodyContent()' to store data in a sub-array for better
 *    parsing within the 'getBodyContent()' method
 *  - modified 'getBodyContent()' to process contents array better.
 *    Also modified to handle attachements.
 *  - added 'setAttachement()' so files and other data can be attached
 *    to messages
 *  - added '_setErr()' and 'getErrors()' as an attempt to begin an error
 *    handling process within this class
 *
 * Revision 1.7  2005/04/13 15:23:50  walter
 *  - made 'CC' a conditional insert
 *  - made 'BCC' a conditional insert
 *  - fixed 'Message-ID'
 *  - corrected 'getSensitivity()'
 *  - modified '$_aryPriority[]' to proper values
 *  - updated 'setConfig()' to handle external Ini or 'php.ini'
 *
 * Revision 1.6  2005/03/15 17:34:06  walter
 *  - corrected Message Sensitivity property and method comments
 *  - added array to Message Sensitivity
 *  - added getSensitivity() method to use new Sensitivity array
 *  - created seters and getter for Priority with new Prioity value array property
 *  - changed config file include from 'include_once'
 *  - modified getHeader() to ustilize new Message Sensitivity and Priorty properties
 *
 * Revision 1.5  2005/03/14 22:25:27  walter
 *  - added references
 *  - added Message sensitivity as a property with Getter/Setter methods
 *  - boundary is now a property with Getter/Setter methods
 *  - added 'builtRCPTlist()'
 *  - 'sendMsg()' now uses Object properties and methods to build message
 *  - 'setConfig()' to load external file
 *  - 'setForm()' will "strip" the email address out of "address" string
 *  - modifed 'getFrom()' to handle "striping" the email address
 *  - '_buildArrayList()' creates a multi-dimensional array of addresses
 *    by domain, TO, CC & BCC and then by User Name.
 *  - '_strip_email()' pulls email address out of "full Address" string'
 *  - 'get_RCPT_list()' pulls out "bare" emaill address form address array
 *  - 'getHeader()' builds message Header from Object properties
 *  - 'getBodyContent()' builds full messsage body, even multi-part
 *
 * Revision 1.4  2005/03/02 20:53:35  walter
 *  - core Setters & Getters defined
 *  - added additional Class Properties
 *
 * Revision 1.3  2005/03/02 18:51:51  walter
 *  - added base 'Class Properties'
 *
 * Revision 1.2  2005/03/01 19:37:52  walter
 *  - CVS logging tags
 *  - more comments
 *  - more "shell"
 *  - some constants
 *
 * Revision 1.1  2005/03/01 19:22:49  walter
 *  - initial commit
 *  - basic shell with some commets
 *
 */

?>
Back to Top