Git Product home page Git Product logo

vivoauthimap's Introduction

VivOAuthIMAP

####Version: 1.0

##Overview VivOAuthIMAP is a library to support OAuth for IMAP.
PHP's default library imap_open doesn't have support for OAuth.
So a quiick solution will be this library.

###Features

  • Connect to IMAP using OAuth
  • Count Total Mails
  • Fetch Mails Headers
  • Fetch Mails Body
  • List folders of mailbox
  • Swtich to folders easily

###Usage

$imap = new VivOAuthIMAP();

$imap->host = 'ssl://imap.gmail.com';
$imap->port = 993;

//Using Username And Password
$imap->username = '[email protected]';
$imap->password = 'changeMe';
//Or you can use access token
//$imap->accessToken = 'tokenreceivedbyoauthlibrary'

if ($imap->login()) {       
    
    /*
    $header = $imap->getHeader(1); //Returns mail header array
    
    $mails = $imap->getMessage(1); //Returns mails array

    $headers = $imap->getHeaders(1,10); //Returns mail headers array

    $mails = $imap->getMessage(2); //Returns mails array

    $total = $imap->totalMails(); //By default inbox is selected
     
    $total = $imap->totalMails('Folder Name'); //Any folder which exist can be passed as folder name

    $folders = $imap->listFolders(); //Lists all folders of mailbox

    $imap->selectFolder('Folder Name'); // Default is INBOX autoselected after login
    */
    $mails = $imap->getMessages(1, 20);

    foreach ($mails as $mail) {

        //Using mime_parser you can parse the rfc822 format mail or can write own parser
        //Here in example used a mime_parser_class 

        $mime = new mime_parser_class();
        $parameters = array('Data' => $mail);
        $mime->Decode($parameters, $decoded);

        /*
          //See how much variables you can access
          echo "<pre>";
          print_r($decoded);
          echo "</pre>";
         */

        echo "<b>From :</b> " . $decoded[0]['ExtractedAddresses']['from:'][0]['address'] . "   ";
        echo "<b>Subject :</b> " . $decoded[0]['Headers']['subject:'] . "<br>";
        echo "======================================================== <br>";
    }

}

##Requirement

  • PHP Version > PHP 5.3+
  • PHP Extensions needs to enable
    • php_openssl
    • php_curl
    • php_sockets

##License

The MIT License (MIT)

Copyright (c) 2013 Vivek Muthal

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author : Vivek Muthal
Email : [email protected]
Website : www.vivsoftware.in

vivoauthimap's People

Contributors

vmuthal avatar integrii avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.