Home > Tutorials > PHP Tutorials

PHP socket implementation of the POP3 class

Source: Internet
Author: User
Developer on Alibaba Coud: Build your first app with APIs, SDKs, and tutorials on the Alibaba Cloud. Read more ＞

  6. /**

  8. * PHP Socket POP3 class
  10. * by bbs.it-home.org
  12. */
  14. Class Socketpopclient
  16. {
  18. var $strMessage = ';
  20. var $intErrorNum = 0;
  22. var $bolDebug = false;

  24. var $strEmail = ';

  26. var $strPasswd = ';
  28. var $strHost = ';
  30. var $intPort = 110;
  32. var $intConnSecond = 30;
  34. var $intBuffSize = 8192;
  36. var $resHandler = NULL;
  38. var $bolIsLogin = false;
  40. var $strRequest = ';
  42. var $strResponse = ';
  44. var $arrRequest = array ();
  46. var $arrResponse = array ();

  48. //---------------

  50. Basic operations
  52. //---------------
  54. constructor function
  56. function Socketpop3client ($strLoginEmail, $strLoginPasswd, $strPopHost = ", $intPort =")
  58. {
  60. $this->stremail = Trim (Strtolower ($strLoginEmail));
  62. $this->strpasswd = Trim ($STRLOGINPASSWD);
  64. $this->strhost = Trim (Strtolower ($strPopHost));
  66. if ($this->stremail== "| | $this->strpasswd==")
  68. {
  70. $this->setmessage (' Email address or Passwd is empty ', 1001);
  72. return false;
  74. }
  76. if (! Preg_match ("/^[\w-]+ (\.[ \w-]+) *@[\w-]+ (\.[ \w-]+) +$/i ", $this->stremail))
  78. {
  80. $this->setmessage (' Email address invalid ', 1002);
  82. return false;
  84. }
  86. if ($this->strhost== ")
  88. {
  90. $this->strhost = substr (STRRCHR ($this->stremail, "@"), 1);
  92. }
  94. if ($intPort! = ")
  96. {
  98. $this->intport = $intPort;
  100. }
  102. $this->connecthost ();
  104. }

  106. Connecting to a server

  108. function Connecthost ()
  110. {
  112. if ($this->boldebug)
  114. {
  116. echo "Connection". $this->strhost. "... \ r \ n";
  118. }
  120. if (! $this->getisconnect ())
  122. {
  124. if ($this->strhost== "| | $this->intport==")
  126. {
  128. $this->setmessage (' POP3 host or Port is empty ', 1003);
  130. return false;
  132. }
  134. $this->reshandler = @fsockopen ($this->strhost, $this->intport, & $this->interrornum, & $this strmessage, $this->intconnsecond);
  136. if (! $this->reshandler)
  138. {
  140. $STRERRMSG = ' Connection POP3 host: '. $this->strhost. ' Failed ';
  142. $intErrNum = 2001;
  144. $this->setmessage ($STRERRMSG, $intErrNum);
  146. return false;
  148. }
  150. $this->getlineresponse ();
  152. if (! $this->getrestissucceed ())
  154. {
  156. return false;
  158. }
  160. }
  162. return true;
  164. }
  166. Close connection
  168. function Closehost ()
  170. {
  172. if ($this->reshandler)
  174. {
  176. Fclose ($this->reshandler);
  178. }
  180. return true;
  182. }
  184. Send instructions
  186. function SendCommand ($strCommand)
  188. {
  190. if ($this->boldebug)
  192. {
  194. if (!preg_match ("/pass/", $strCommand))
  196. {
  198. echo "Send Command:". $strCommand. " \ r \ n ";
  200. }
  202. Else
  204. {
  206. echo "Send command:pass ******\r\n";
  208. }
  210. }
  212. if (! $this->getisconnect ())
  214. {
  216. return false;
  218. }
  220. if (Trim ($strCommand) = = ")
  222. {
  224. $this->setmessage (' Request command is empty ', 1004);
  226. return false;
  228. }
  230. $this->strrequest = $strCommand. " \ r \ n ";
  232. $this->arrrequest[] = $strCommand;
  234. Fputs ($this->reshandler, $this->strrequest);
  236. return true;
  238. }
  240. Extract response information First line
  242. function Getlineresponse ()
  244. {
  246. if (! $this->getisconnect ())
  248. {
  250. return false;
  252. }
  254. $this->strresponse = fgets ($this->reshandler, $this->intbuffsize);
  256. $this->arrresponse[] = $this->strresponse;
  258. return $this->strresponse;
  260. }
  262. Extracts several response information, $intReturnType is a return value type, 1 is a string, 2 is an array
  264. function Getrespmessage ($intReturnType)
  266. {
  268. if (! $this->getisconnect ())
  270. {
  272. return false;
  274. }
  276. if ($intReturnType = = 1)
  278. {
  280. $strAllResponse = ";
  282. while (!feof ($this->reshandler))
  284. {
  286. $strLineResponse = $this->getlineresponse ();
  288. if (Preg_match ("/^\+ok/", $strLineResponse))
  290. {
  292. Continue
  294. }
  296. if (Trim ($strLineResponse) = = '. ')
  298. {
  300. Break
  302. }
  304. $strAllResponse. = $strLineResponse;
  306. }
  308. return $strAllResponse;
  310. }
  312. Else
  314. {
  316. $arrAllResponse = Array ();
  318. while (!feof ($this->reshandler))
  320. {
  322. $strLineResponse = $this->getlineresponse ();
  324. if (Preg_match ("/^\+ok/", $strLineResponse))
  326. {
  328. Continue
  330. }
  332. if (Trim ($strLineResponse) = = '. ')
  334. {
  336. Break
  338. }
  340. $arrAllResponse [] = $strLineResponse;
  342. }
  344. return $arrAllResponse;
  346. }
  348. }
  350. Whether the fetch request was successful
  352. function Getrestissucceed ($strRespMessage = ")
  354. {
  356. if (Trim ($responseMessage) = = ")
  358. {
  360. if ($this->strresponse== ")
  362. {
  364. $this->getlineresponse ();
  366. }
  368. $strRespMessage = $this->strresponse;
  370. }
  372. if (Trim ($strRespMessage) = = ")
  374. {
  376. $this->setmessage (' Response message is empty ', 2003);
  378. return false;
  380. }
  382. if (!preg_match ("/^\+ok/", $strRespMessage))
  384. {
  386. $this->setmessage ($strRespMessage, 2000);
  388. return false;
  390. }
  392. return true;
  394. }
  396. Gets whether the connection is connected
  398. function Getisconnect ()
  400. {
  402. if (! $this->reshandler)
  404. {
  406. $this->setmessage ("Nonexistent availability Connection Handler", 2002);
  408. return false;
  410. }
  412. return true;
  414. }

  416. Set Message

  418. function Setmessage ($strMessage, $intErrorNum)
  420. {
  422. if (Trim ($strMessage) = = "| | $intErrorNum = =")
  424. {
  426. return false;
  428. }
  430. $this->strmessage = $strMessage;
  432. $this->interrornum = $intErrorNum;
  434. return true;
  436. }
  438. Get message
  440. function GetMessage ()
  442. {
  444. return $this->strmessage;
  446. }
  448. Get error number
  450. function Geterrornum ()
  452. {
  454. return $this->interrornum;
  456. }
  458. GET request Information
  460. function Getrequest ()
  462. {
  464. return $this->strrequest;
  466. }
  468. Get response information
  470. function GetResponse ()
  472. {
  474. return $this->strresponse;
  476. }

  478. //---------------

  480. Mail Atomic operations
  482. //---------------
  484. Login Mailbox
  486. function Poplogin ()
  488. {
  490. if (! $this->getisconnect ())
  492. {
  494. return false;
  496. }
  498. $this->sendcommand ("USER". $this->stremail);
  500. $this->getlineresponse ();
  502. $bolUserRight = $this->getrestissucceed ();
  504. $this->sendcommand ("PASS". $this->strpasswd);
  506. $this->getlineresponse ();
  508. $bolPassRight = $this->getrestissucceed ();
  510. if (! $bolUserRight | |! $bolPassRight)
  512. {
  514. $this->setmessage ($this->strresponse, 2004);
  516. return false;
  518. }
  520. $this->bolislogin = true;
  522. return true;
  524. }
  526. Sign Out
  528. function Poplogout ()
  530. {
  532. if (! $this->getisconnect () && $this->bolislogin)
  534. {
  536. return false;
  538. }
  540. $this->sendcommand ("QUIT");
  542. $this->getlineresponse ();
  544. if (! $this->getrestissucceed ())
  546. {
  548. return false;
  550. }
  552. return true;
  554. }
  556. Gets whether online
  558. function Getisonline ()
  560. {
  562. if (! $this->getisconnect () && $this->bolislogin)
  564. {
  566. return false;
  568. }
  570. $this->sendcommand ("NOOP");
  572. $this->getlineresponse ();
  574. if (! $this->getrestissucceed ())
  576. {
  578. return false;
  580. }
  582. return true;
  584. }
  586. Get Message count and bytes (return array)
  588. function Getmailsum ($intReturnType =2)
  590. {
  592. if (! $this->getisconnect () && $this->bolislogin)
  594. {
  596. return false;
  598. }
  600. $this->sendcommand ("STAT");
  602. $strLineResponse = $this->getlineresponse ();
  604. if (! $this->getrestissucceed ())
  606. {
  608. return false;
  610. }
  612. if ($intReturnType ==1)
  614. {
  616. return $this->strresponse;
  618. }
  620. Else
  622. {
  624. $arrResponse = Explode ("", $this->strresponse);
  626. if (!is_array ($arrResponse) | | count ($arrResponse) <=0)
  628. {
  630. $this->setmessage (' STAT command response message is error ', 2006);
  632. return false;
  634. }
  636. return Array ($arrResponse [1], $arrResponse [2]);
  638. }
  640. }
  642. Gets the session Id of the specified message.
  644. function Getmailsessid ($intMailId, $intReturnType =2)
  646. {
  648. if (! $this->getisconnect () && $this->bolislogin)
  650. {
  652. return false;
  654. }
  656. if (! $intMailId = Intval ($intMailId))
  658. {
  660. $this->setmessage (' Mail Message ID invalid ', 1005);
  662. return false;
  664. }
  666. $this->sendcommand ("UIDL"). $INTMAILID);
  668. $this->getlineresponse ();
  670. if (! $this->getrestissucceed ())
  672. {
  674. return false;
  676. }
  678. if ($intReturnType = = 1)
  680. {
  682. return $this->strresponse;
  684. }
  686. Else
  688. {
  690. $arrResponse = Explode ("", $this->strresponse);
  692. if (!is_array ($arrResponse) | | count ($arrResponse) <=0)
  694. {
  696. $this->setmessage (' UIDL command response message is error ', 2006);
  698. return false;
  700. }
  702. return Array ($arrResponse [1], $arrResponse [2]);
  704. }
  706. }
  708. Get the size of a message
  710. function Getmailsize ($intMailId, $intReturnType =2)
  712. {
  714. if (! $this->getisconnect () && $this->bolislogin)
  716. {
  718. return false;
  720. }
  722. $this->sendcommand ("LIST". $intMailId);
  724. $this->getlineresponse ();
  726. if (! $this->getrestissucceed ())
  728. {
  730. return false;
  732. }
  734. if ($intReturnType = = 1)
  736. {
  738. return $this->strresponse;
  740. }
  742. Else
  744. {
  746. $arrMessage = Explode (' ', $this->strresponse);
  748. return Array ($arrMessage [1], $arrMessage [2]);
  750. }
  752. }
  754. Get the message base list array
  756. function getmailbaselist ($intReturnType =2)
  758. {
  760. if (! $this->getisconnect () && $this->bolislogin)
  762. {
  764. return false;
  766. }
  768. $this->sendcommand ("LIST");
  770. $this->getlineresponse ();
  772. if (! $this->getrestissucceed ())
  774. {
  776. return false;
  778. }
  780. return $this->getrespmessage ($intReturnType);
  782. }
  784. Gets all information for the specified message, Intreturntype is the return value type, 1 is a string, and 2 is an array
  786. function Getmailmessage ($intMailId, $intReturnType =1)
  788. {
  790. if (! $this->getisconnect () && $this->bolislogin)
  792. {
  794. return false;
  796. }
  798. if (! $intMailId = Intval ($intMailId))
  800. {
  802. $this->setmessage (' Mail Message ID invalid ', 1005);
  804. return false;
  806. }
  808. $this->sendcommand ("RETR"). $INTMAILID);
  810. $this->getlineresponse ();
  812. if (! $this->getrestissucceed ())
  814. {
  816. return false;
  818. }
  820. return $this->getrespmessage ($intReturnType);
  822. }
  824. Gets a message before the specified row, $intReturnType return a value type, 1 is a string, and 2 is an array
  826. function Getmailtopmessage ($intMailId, $intTopLines =10, $intReturnType =1)
  828. {
  830. if (! $this->getisconnect () && $this->bolislogin)
  832. {
  834. return false;
  836. }
  838. if (! $intMailId =intval ($intMailId) | |! $intTopLines =int ($intTopLines))
  840. {
  842. $this->setmessage (' Mail message ID or Top lines number invalid ', 1005);
  844. return false;
  846. }
  848. $this->sendcommand ("TOP". $intMailId. " ". $intTopLines);
  850. $this->getlineresponse ();
  852. if (! $this->getrestissucceed ())
  854. {
  856. return false;
  858. }
  860. return $this->getrespmessage ($intReturnType);
  862. }
  864. Delete message
  866. function Delmail ($intMailId)
  868. {
  870. if (! $this->getisconnect () && $this->bolislogin)
  872. {
  874. return false;
  876. }
  878. if (! $intMailId =intval ($intMailId))
  880. {
  882. $this->setmessage (' Mail Message ID invalid ', 1005);
  884. return false;
  886. }
  888. $this->sendcommand ("DELE". $intMailId);
  890. $this->getlineresponse ();
  892. if (! $this->getrestissucceed ())
  894. {
  896. return false;
  898. }
  900. return true;
  902. }
  904. Reset deleted messages marked as not deleted
  906. function Resetdelemail ()
  908. {
  910. if (! $this->getisconnect () && $this->bolislogin)
  912. {
  914. return false;
  916. }
  918. $this->sendcommand ("RSET");
  920. $this->getlineresponse ();
  922. if (! $this->getrestissucceed ())
  924. {
  926. return false;
  928. }
  930. return true;
  932. }
  934. //---------------
  936. Debugging operations
  938. //---------------
  940. Output object Information
  942. function PrintObject ()
  944. {
  946. Print_r ($this);
  948. Exit
  950. }
  952. Output error message
  954. function Printerror ()
  956. {
  958. echo "[Error MSG]: $strMessage
    \ n ";
  960. echo "[Error Num]: $intErrorNum
    \ n ";
  962. Exit
  964. }
  966. Output host Information
  968. function Printhost ()
  970. {
  972. echo "[Host]: $this->strhost
    \ n ";
  974. echo "[Port]: $this->intport
    \ n ";
  976. echo "[Email]: $this->stremail
    \ n ";
  978. echo "[PASSWD]: ********
    \ n ";
  980. Exit
  982. }
  984. Output connection Information
  986. function Printconnect ()
  988. {
  990. echo "[Connect]: $this->reshandler
    \ n ";
  992. echo "[Request]: $this->strrequest
    \ n ";
  994. echo "[Response]: $this->strresponse
    \ n ";
  996. Exit
  998. }
  1000. }
  1002. ?>

Copy Code

Invocation Example:

    2. Test code
    3. For example: $o = socketpop3client (' Email address ', ' password ', ' POP3 server ', ' POP3 Port ')
    4. /*
    5. Set_time_limit (0);
    6. $o = new Socketpopclient (' abc@126.com ', ' 123456 ', ' pop.126.com ', ' 110 ');
    7. $o->poplogin ();
    8. Print_r ($o->getmailbaselist ());
    9. Print_r ($o->getmailsum (1));
    10. Print_r ($o->getmailtopmessage (2, 2, 2));
    11. $o->poplogout ();
    12. $o->closehost ();
    13. $o->printobject ();
    14. */
    15. ?>
Copy Code

    • This article is an English version of an article which is originally in the Chinese language on aliyun.com and is provided for information purposes only. This website makes no representation or warranty of any kind, either expressed or implied, as to the accuracy, completeness ownership or reliability of the article or any translations thereof. If you have any concerns or complaints relating to the article, please send an email, providing a detailed description of the concern or complaint, to info-contact@alibabacloud.com. A staff member will contact you within 5 working days. Once verified, infringing content will be removed immediately.

    Contact Us

    The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

    If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    Get Started for Free

    • Sales Support

      1 on 1 presale consultation

      Chat Contact Sales

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

      Open a Ticket

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.

      Learn More