vendor/zendframework/zend-mail/src/Protocol/Smtp/Auth/Login.php

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