interface/modules/zend_modules/library/Zend/Mail/Protocol/Smtp/Auth/Plain.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Mail\Protocol\Smtp\Auth;
  11
  12 use Zend\Mail\Protocol\Smtp;
  13
  14 /**
  15  * Performs PLAIN authentication
  16  */
  17 class Plain extends Smtp
  18 {
  19     /**
  20      * PLAIN username
  21      *
  22      * @var string
  23      */
  24     protected $username;
  25
  26
  27     /**
  28      * PLAIN password
  29      *
  30      * @var string
  31      */
  32     protected $password;
  33
  34
  35     /**
  36      * Constructor.
  37      *
  38      * @param  string $host   (Default: 127.0.0.1)
  39      * @param  int    $port   (Default: null)
  40      * @param  array  $config Auth-specific parameters
  41      */
  42     public function __construct($host = '127.0.0.1', $port = null, $config = null)
  43     {
  44         // Did we receive a configuration array?
  45         $origConfig = $config;
  46         if (is_array($host)) {
  47             // Merge config array with principal array, if provided
  48             if (is_array($config)) {
  49                 $config = array_replace_recursive($host, $config);
  50             } else {
  51                 $config = $host;
  52             }
  53         }
  54
  55         if (is_array($config)) {
  56             if (isset($config['username'])) {
  57                 $this->setUsername($config['username']);
  58             }
  59             if (isset($config['password'])) {
  60                 $this->setPassword($config['password']);
  61             }
  62         }
  63
  64         // Call parent with original arguments
  65         parent::__construct($host, $port, $origConfig);
  66     }
  67
  68
  69     /**
  70      * Perform PLAIN authentication with supplied credentials
  71      *
  72      */
  73     public function auth()
  74     {
  75         // Ensure AUTH has not already been initiated.
  76         parent::auth();
  77
  78         $this->_send('AUTH PLAIN');
  79         $this->_expect(334);
  80         $this->_send(base64_encode("\0" . $this->getUsername() . "\0" . $this->getPassword()));
  81         $this->_expect(235);
  82         $this->auth = true;
  83     }
  84
  85     /**
  86      * Set value for username
  87      *
  88      * @param  string $username
  89      * @return Plain
  90      */
  91     public function setUsername($username)
  92     {
  93         $this->username = $username;
  94         return $this;
  95     }
  96
  97     /**
  98      * Get username
  99      *
 100      * @return string
 101      */
 102     public function getUsername()
 103     {
 104         return $this->username;
 105     }
 106
 107     /**
 108      * Set value for password
 109      *
 110      * @param  string $password
 111      * @return Plain
 112      */
 113     public function setPassword($password)
 114     {
 115         $this->password = $password;
 116         return $this;
 117     }
 118
 119     /**
 120      * Get password
 121      *
 122      * @return string
 123      */
 124     public function getPassword()
 125     {
 126         return $this->password;
 127     }
 128 }