PHP का उपयोग करके Gmail के साथ काम करें

अच्छे दिन, सहकर्मियों। इस लेख में, मैं Gmail API का उपयोग करके अपने अनुभव के बारे में बात करूँगा। जैसा कि यह निकला, यह विषय इंटरनेट पर बहुत कवर नहीं है, और प्रलेखन आदर्श से बहुत दूर है।

हाल ही में, मेरे पास एक कार्य था: उपयोगकर्ता के जीमेल मेलबॉक्स पर संदेशों की खोज के लिए एक PHP एप्लिकेशन लिखना। इसके अलावा, यह केवल एक खोज नहीं है, बल्कि मापदंडों द्वारा की गई खोज है, क्योंकि जीमेल में एक अच्छा खोज बार है जो आपको कुछ लिखने की अनुमति देता है जैसे ": बाद भेजा जाता है: 2012/08/10"। हां, और API के पास IMAP प्रोटोकॉल X-GM- * के एक्सटेंशन हैं

इसलिए, हमें उपयोगकर्ताओं को अधिकृत करने और संदेशों को खोजने के लिए एक इंटरफ़ेस लागू करने की आवश्यकता है। इन उद्देश्यों के लिए, मैंने Zend फ्रेमवर्क का उपयोग किया, क्योंकि प्रोजेक्ट Zend फ्रेमवर्क में लिखा गया है, और Google एपीआई के साथ काम करने के लिए इसका उपयोग करने की सिफारिश करता है।

हम इंटरफ़ेस की रूपरेखा तैयार करते हैं:

class Model_OAuth_Gmail { //   OAuth public function Connect( $callback ); //    Access Token (     ) public function getConnection($accessToken); //      const MODE_NONE = 0; const MODE_MESSAGES = 1; const MODE_THREAD = 2; //  :  (  getConnection ),     public function searchMessages($imapConnection, $params, $mode = 0); } 

मैंने प्रत्येक विधि टिप्पणियों में क्या लिखा है।
नोट: हाँ, मुझे पता है कि एक सिंगलटन क्या है और इस वर्ग को इस तरह लागू किया जाना चाहिए, लेकिन यह बात नहीं है!

तो, चलिए शुरू करते हैं:

कनेक्ट

  public function Connect( $callback ) { $this -> urls['callbackUrl'] = $callback; $session = new Zend_Session_Namespace('OAuth'); $OAuth_Consumer = new Zend_Oauth_Consumer(array_merge($this->config, $this->urls)); try { if (!isset($session -> accessToken)) { if (!isset($session -> requestToken)) { $session -> requestToken = $OAuth_Consumer -> getRequestToken(array('scope' => $this -> scopes), "GET"); $OAuth_Consumer -> redirect(); } else { $session -> accessToken = $OAuth_Consumer -> getAccessToken($_GET, $session -> requestToken); } } $accessToken = $session -> accessToken; $session -> unsetAll(); unset($session); return $accessToken; } catch( exception $e) { $session -> unsetAll(); throw new Zend_Exception("Error occurred. try to reload this page", 5); } } 

यह काफी सरल है: हम सत्र शुरू करते हैं, इसे ग्रांट एक्सेस बटन पर क्लिक करने और एक्सेस टोकन प्राप्त करने के लिए Google पर फेंकें, हमारे द्वारा निवेदन किए गए अनुरोध टोकन का उपयोग करें

मुख्य बात यह है कि ट्राइ-कैच ब्लॉक बनाने के लिए मत भूलना, क्योंकि यदि, उदाहरण के लिए, उपयोगकर्ता वापस क्लिक करता है, तब और अधिक, जब तक सत्र समाप्त नहीं हो जाता, तब तक वह लॉग इन नहीं कर पाएगा (अनुरोध टोकन पहले चरण में सहेजा गया है)!

खैर, मैं लगभग विन्यास भूल गया:

  protected $config = array( 'requestScheme' => Zend_Oauth::REQUEST_SCHEME_HEADER, 'version' => '1.0', 'consumerKey' => 'anonymous', 'signatureMethod' => 'HMAC-SHA1', 'consumerSecret' => 'anonymous', ); protected $urls = array('callbackUrl' => "", 'requestTokenUrl' => 'https://www.google.com/accounts/OAuthGetRequestToken', 'userAuthorizationUrl' => 'https://www.google.com/accounts/OAuthAuthorizeToken', 'accessTokenUrl' => 'https://www.google.com/accounts/OAuthGetAccessToken' ); protected $scopes = 'https://mail.google.com/ https://www.googleapis.com/auth/userinfo#email'; 

getConnection

  public function getConnection($accessToken) { $config = new Zend_Oauth_Config(); $config -> setOptions($this::config); $config -> setToken(unserialize($user::accessToken)); $config -> setRequestMethod('GET'); $url = 'https://mail.google.com/mail/b/' . $user -> email . '/imap/'; $urlWithXoauth = $url . '?xoauth_requestor_id=' . urlencode($user -> email); $httpUtility = new Zend_Oauth_Http_Utility(); /** * Get an unsorted array of oauth params, * including the signature based off those params. */ $params = $httpUtility -> assembleParams($url, $config, array('xoauth_requestor_id' => $user -> email)); /** * Sort parameters based on their names, as required * by OAuth. */ ksort($params); /** * Construct a comma-deliminated,ordered,quoted list of * OAuth params as required by XOAUTH. * * Example: oauth_param1="foo",oauth_param2="bar" */ $first = true; $oauthParams = ''; foreach ($params as $key => $value) { // only include standard oauth params if (strpos($key, 'oauth_') === 0) { if (!$first) { $oauthParams .= ','; } $oauthParams .= $key . '="' . urlencode($value) . '"'; $first = false; } } /** * Generate SASL client request, using base64 encoded * OAuth params */ $initClientRequest = 'GET ' . $urlWithXoauth . ' ' . $oauthParams; $initClientRequestEncoded = base64_encode($initClientRequest); /** * Make the IMAP connection and send the auth request */ $imap = new Zend_Mail_Protocol_Imap('imap.gmail.com', '993', true); $authenticateParams = array('XOAUTH', $initClientRequestEncoded); $imap -> requestAndResponse('AUTHENTICATE', $authenticateParams); return $imap; } 

यह विधि Google द्वारा उपयोग के उदाहरण में है, यह "जैसा है" दस्तावेज और काम करता है। इसके अलावा, यह काफी सरल है।

खैर, चलो सबसे दिलचस्प पर चलते हैं :

searchMessages

प्रारंभ में, क्रियाओं का एल्गोरिथ्म:

1. हम मापदंडों के आधार पर एक खोज बार बनाते हैं
2. संदेश आईडी मिलान स्थितियों का पता लगाएं
3. $ मोड के आधार पर उन्हें परिवर्तित करें
4. लाभ! :)

आइटम 1:

  $searchString = 'X-GM-RAW "'; foreach ($params as $key => $value) switch ($key) { // this is dates case "before" : case "after" : $searchString .= $key . ":" . date("Y/m/d", $value) . " "; break; // this is simple strings default : $searchString .= $key . ":" . $value . " "; break; } $searchString = trim($searchString) . '"'; 

हम मापदंडों के साथ सरणी के माध्यम से जाते हैं और उन्हें एक स्ट्रिंग में परिवर्तित करते हैं। एकमात्र अपवाद तारीखें हैं, जो हम खुद को परिवर्तित करेंगे।

आइटम 2:

  $messages = $imapConnection -> search(array($searchString)); 

बस सही है? लेकिन जैसा कि यह निकला, यह समाधान बिल्कुल भी काम नहीं करता है। सर्वर एक त्रुटि देगा, क्योंकि हमने EXAMINE "INBOX" कमांड निष्पादित नहीं की। खैर:

  if (isset($params['in'])){ $imapConnection->examine(strtoupper(($params['in']))); } else { $imapConnection->examine("INBOX"); } $messages = $imapConnection -> search(array($searchString)); 

यह समाधान पहले से ही काम कर रहा है, और लगभग सही ढंग से काम कर रहा है। लेकिन, जैसे ही हमें आउटगोइंग (भेजे गए) में देखना होगा, हमें गलत उत्तर मिल जाएगा। मैंने इस समस्या के साथ खुदाई करने में बहुत समय बिताया और एक उत्तर मिला।

यह पता चला कि जीमेल के फ़ोल्डरों का नाम SENT, INBOX, ... नहीं है, लेकिन इसमें लोकेल-डिपेंडेंट नाम (oO) हैं। मुझे फ़ोल्डर नामों को परिवर्तित करने के लिए एक सरल विधि बनानी पड़ी:

  protected function getFolder($imap, $folder) { $response = $imap -> requestAndResponse('XLIST "" "*"'); $folders = array(); foreach ($response AS $item) { if ($item[0] != "XLIST") { continue; } $folders[strtoupper(str_replace('\\', '', end($item[1])))] = $item[3]; } return $folders[$folder]; } 

बस फ़ोल्डरों की सूची का पता लगाएं और आपको जिसकी आवश्यकता है उसे ढूंढें। लेकिन यह, जैसा कि यह निकला, यह सब नहीं है। परीक्षा अभी भी आपको समस्या से नहीं बचाती है, लेकिन आपको खोज करने से पहले एक फ़ोल्डर का चयन करने के लिए चयन विधि को कॉल करने की आवश्यकता है।

  if (isset($params['in'])) $imapConnection -> select($this -> getFolder($imapConnection, strtoupper($params['in']))); $messages = $imapConnection -> search(array($searchString)); 

अब हमारे पास संदेशों की आईडी है, छोटी बात यह है कि संदेशों के प्रकार को कैसे बदलना है।

  switch ( $mode ) { case $this::MODE_NONE : return $messages; case $this::MODE_MESSAGES : // fetching (get content of messages) $messages = $imapConnection -> requestAndResponse("FETCH " . implode(',', $messages) . " (X-GM-THRID)"); return $messages; case $this::MODE_THREAD : $messages = $imapConnection -> requestAndResponse("FETCH " . implode(',', $messages) . " (X-GM-THRID)"); $storage = new Zend_Mail_Storage_Imap($imapConnection); $storage -> selectFolder( $this -> getFolder($imapConnection, strtoupper($params['in'])) ); $threads = array(); if ($messages) foreach ($messages AS $message) { if (isset($message[2][1])) { $thread_id = $message[2][1]; if (!isset($threads[$thread_id])) { $threads[$thread_id] = array('all' => $imapConnection -> requestAndResponse("SEARCH X-GM-THRID $thread_id"), 'my' => array()); unset($threads[$thread_id]['all'][0][0]); } $threads[$thread_id]['my'][] = $message[0]; } } $result = array(); foreach ($threads as $thread) if (!array_slice($thread['all'], array_search(max($thread['my']), $thread['all']) + 1)) $result[$storage -> getUniqueId(max($thread['my']))] = $storage -> getMessage(max($thread['my'])); return array_reverse($result); // for right order } 

पहले मामले में, हम पहचानकर्ताओं की एक सरणी लौटाएंगे, दूसरे में हम स्वयं संदेश प्राप्त करेंगे, लेकिन सबसे दिलचस्प तीसरा मामला।

यहाँ हम Zend_Mail_Message के रूप में संदेश प्राप्त करने के लिए Zend_Mail_Storage_Imap का उपयोग करते हैं।

यह मत भूलो कि Zend_Mail_Storage_Imap ने हमारे द्वारा चुने गए फ़ोल्डर के बारे में कुछ भी नहीं जाना है (हमारे पास संदेशों की एक और नंबरिंग है), इसलिए हम चयन फ़ोल्डर विधि को कॉल करना नहीं भूलेंगे।

रूपांतरण प्रक्रिया सरल है: हमें संदेश धागा मिलता है, इसे रूप में परिवर्तित करें: [सभी संदेश, मेरे संदेश]। इसके बाद, थ्रेड के अंतिम संदेश का चयन करें और परिणाम बनाएं।

इसके अलावा, यह मत भूलो कि परिणाम को चालू करना होगा, क्योंकि सर्वर पर नंबरिंग पुराने से नए में जाती है, लेकिन हमें दूसरे तरीके से उपयोग किया जाता है।

वह सब है! ध्यान देने के लिए आप सभी का धन्यवाद। मुझे उम्मीद है कि आपको यह लेख उपयोगी लगा होगा।