This repository has been archived by the owner on Jan 30, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 111
/
SmtpOptions.php
200 lines (183 loc) · 4.8 KB
/
SmtpOptions.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Mail
* @subpackage Transport
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Mail\Transport;
use Zend\Mail\Exception,
Zend\Stdlib\AbstractOptions;
/**
* @category Zend
* @package Zend_Mail
* @subpackage Transport
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class SmtpOptions extends AbstractOptions
{
/**
* @var string Local client hostname
*/
protected $name = 'localhost';
/**
* @var string
*/
protected $connectionClass = 'smtp';
/**
* Connection configuration (passed to the underlying Protocol class)
*
* @var array
*/
protected $connectionConfig = array();
/**
* @var string Remote SMTP hostname or IP
*/
protected $host = '127.0.0.1';
/**
* @var int
*/
protected $port = 25;
/**
* Return the local client hostname
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Set the local client hostname or IP
*
* @todo hostname/IP validation
* @param string $name
* @throws \Zend\Mail\Exception\InvalidArgumentException
* @return SmtpOptions
*/
public function setName($name)
{
if (!is_string($name) && $name !== null) {
throw new Exception\InvalidArgumentException(sprintf(
'Name must be a string or null; argument of type "%s" provided',
(is_object($name) ? get_class($name) : gettype($name))
));
}
$this->name = $name;
return $this;
}
/**
* Get connection class
*
* This should be either the class Zend\Mail\Protocol\Smtp or a class
* extending it -- typically a class in the Zend\Mail\Protocol\Smtp\Auth
* namespace.
*
* @return string
*/
public function getConnectionClass()
{
return $this->connectionClass;
}
/**
* Set connection class
*
* @param string $connectionClass the value to be set
* @throws \Zend\Mail\Exception\InvalidArgumentException
* @return SmtpOptions
*/
public function setConnectionClass($connectionClass)
{
if (!is_string($connectionClass) && $connectionClass !== null) {
throw new Exception\InvalidArgumentException(sprintf(
'Connection class must be a string or null; argument of type "%s" provided',
(is_object($connectionClass) ? get_class($connectionClass) : gettype($connectionClass))
));
}
$this->connectionClass = $connectionClass;
return $this;
}
/**
* Get connection configuration array
*
* @return array
*/
public function getConnectionConfig()
{
return $this->connectionConfig;
}
/**
* Set connection configuration array
*
* @param array $connectionConfig
* @return SmtpOptions
*/
public function setConnectionConfig(array $connectionConfig)
{
$this->connectionConfig = $connectionConfig;
return $this;
}
/**
* Get the host name
*
* @return string
*/
public function getHost()
{
return $this->host;
}
/**
* Set the SMTP host
*
* @todo hostname/IP validation
* @param string $host
* @return SmtpOptions
*/
public function setHost($host)
{
$this->host = (string) $host;
return $this;
}
/**
* Get the port the SMTP server runs on
*
* @return int
*/
public function getPort()
{
return $this->port;
}
/**
* Set the port the SMTP server runs on
*
* @param int $port
* @throws \Zend\Mail\Exception\InvalidArgumentException
* @return SmtpOptions
*/
public function setPort($port)
{
$port = (int) $port;
if ($port < 1) {
throw new Exception\InvalidArgumentException(sprintf(
'Port must be greater than 1; received "%d"',
$port
));
}
$this->port = $port;
return $this;
}
}