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