vendor/zendframework/zend-mail/src/Transport/SmtpOptions.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\Transport;
   9
  10 use Zend\Mail\Exception;
  11 use Zend\Stdlib\AbstractOptions;
  12
  13 class SmtpOptions extends AbstractOptions
  14 {
  15     /**
  16      * @var string Local client hostname
  17      */
  18     protected $name = 'localhost';
  19
  20     /**
  21      * @var string
  22      */
  23     protected $connectionClass = 'smtp';
  24
  25     /**
  26      * Connection configuration (passed to the underlying Protocol class)
  27      *
  28      * @var array
  29      */
  30     protected $connectionConfig = [];
  31
  32     /**
  33      * @var string Remote SMTP hostname or IP
  34      */
  35     protected $host = '127.0.0.1';
  36
  37     /**
  38      * @var int
  39      */
  40     protected $port = 25;
  41
  42     /**
  43      * The timeout in seconds for the SMTP connection
  44      * (Use null to disable it)
  45      *
  46      * @var int|null
  47      */
  48     protected $connectionTimeLimit;
  49
  50     /**
  51      * Return the local client hostname
  52      *
  53      * @return string
  54      */
  55     public function getName()
  56     {
  57         return $this->name;
  58     }
  59
  60     /**
  61      * Set the local client hostname or IP
  62      *
  63      * @todo   hostname/IP validation
  64      * @param  string $name
  65      * @throws \Zend\Mail\Exception\InvalidArgumentException
  66      * @return SmtpOptions
  67      */
  68     public function setName($name)
  69     {
  70         if (! is_string($name) && $name !== null) {
  71             throw new Exception\InvalidArgumentException(sprintf(
  72                 'Name must be a string or null; argument of type "%s" provided',
  73                 (is_object($name) ? get_class($name) : gettype($name))
  74             ));
  75         }
  76         $this->name = $name;
  77         return $this;
  78     }
  79
  80     /**
  81      * Get connection class
  82      *
  83      * This should be either the class Zend\Mail\Protocol\Smtp or a class
  84      * extending it -- typically a class in the Zend\Mail\Protocol\Smtp\Auth
  85      * namespace.
  86      *
  87      * @return string
  88      */
  89     public function getConnectionClass()
  90     {
  91         return $this->connectionClass;
  92     }
  93
  94     /**
  95      * Set connection class
  96      *
  97      * @param  string $connectionClass the value to be set
  98      * @throws \Zend\Mail\Exception\InvalidArgumentException
  99      * @return SmtpOptions
 100      */
 101     public function setConnectionClass($connectionClass)
 102     {
 103         if (! is_string($connectionClass) && $connectionClass !== null) {
 104             throw new Exception\InvalidArgumentException(sprintf(
 105                 'Connection class must be a string or null; argument of type "%s" provided',
 106                 (is_object($connectionClass) ? get_class($connectionClass) : gettype($connectionClass))
 107             ));
 108         }
 109         $this->connectionClass = $connectionClass;
 110         return $this;
 111     }
 112
 113     /**
 114      * Get connection configuration array
 115      *
 116      * @return array
 117      */
 118     public function getConnectionConfig()
 119     {
 120         return $this->connectionConfig;
 121     }
 122
 123     /**
 124      * Set connection configuration array
 125      *
 126      * @param  array $connectionConfig
 127      * @return SmtpOptions
 128      */
 129     public function setConnectionConfig(array $connectionConfig)
 130     {
 131         $this->connectionConfig = $connectionConfig;
 132         return $this;
 133     }
 134
 135     /**
 136      * Get the host name
 137      *
 138      * @return string
 139      */
 140     public function getHost()
 141     {
 142         return $this->host;
 143     }
 144
 145     /**
 146      * Set the SMTP host
 147      *
 148      * @todo   hostname/IP validation
 149      * @param  string $host
 150      * @return SmtpOptions
 151      */
 152     public function setHost($host)
 153     {
 154         $this->host = (string) $host;
 155         return $this;
 156     }
 157
 158     /**
 159      * Get the port the SMTP server runs on
 160      *
 161      * @return int
 162      */
 163     public function getPort()
 164     {
 165         return $this->port;
 166     }
 167
 168     /**
 169      * Set the port the SMTP server runs on
 170      *
 171      * @param  int $port
 172      * @throws \Zend\Mail\Exception\InvalidArgumentException
 173      * @return SmtpOptions
 174      */
 175     public function setPort($port)
 176     {
 177         $port = (int) $port;
 178         if ($port < 1) {
 179             throw new Exception\InvalidArgumentException(sprintf(
 180                 'Port must be greater than 1; received "%d"',
 181                 $port
 182             ));
 183         }
 184         $this->port = $port;
 185         return $this;
 186     }
 187
 188     /**
 189      * @return int|null
 190      */
 191     public function getConnectionTimeLimit()
 192     {
 193         return $this->connectionTimeLimit;
 194     }
 195
 196     /**
 197      * @param int|null $seconds
 198      * @return self
 199      */
 200     public function setConnectionTimeLimit($seconds)
 201     {
 202         $this->connectionTimeLimit = $seconds === null
 203             ? null
 204             : (int) $seconds;
 205
 206         return $this;
 207     }
 208 }