51ff3226 |
1 | <?xml version="1.0" encoding="iso-8859-1"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml"> |
4 | <head> |
5 | <!-- template designed by Marco Von Ballmoos --> |
6 | <title></title> |
7 | <link rel="stylesheet" href="media/stylesheet.css" /> |
8 | <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 | </head> |
10 | <body> |
11 | <a name="top"></a> |
12 | <h2>[PHPMailer] element index</h2> |
13 | <a href="elementindex.html">All elements</a> |
14 | <br /> |
15 | <div class="index-letter-menu"> |
16 | <a class="index-letter" href="elementindex_PHPMailer.html#a">a</a> |
17 | <a class="index-letter" href="elementindex_PHPMailer.html#b">b</a> |
18 | <a class="index-letter" href="elementindex_PHPMailer.html#c">c</a> |
19 | <a class="index-letter" href="elementindex_PHPMailer.html#d">d</a> |
20 | <a class="index-letter" href="elementindex_PHPMailer.html#e">e</a> |
21 | <a class="index-letter" href="elementindex_PHPMailer.html#f">f</a> |
22 | <a class="index-letter" href="elementindex_PHPMailer.html#h">h</a> |
23 | <a class="index-letter" href="elementindex_PHPMailer.html#i">i</a> |
24 | <a class="index-letter" href="elementindex_PHPMailer.html#m">m</a> |
25 | <a class="index-letter" href="elementindex_PHPMailer.html#n">n</a> |
26 | <a class="index-letter" href="elementindex_PHPMailer.html#p">p</a> |
27 | <a class="index-letter" href="elementindex_PHPMailer.html#q">q</a> |
28 | <a class="index-letter" href="elementindex_PHPMailer.html#r">r</a> |
29 | <a class="index-letter" href="elementindex_PHPMailer.html#s">s</a> |
30 | <a class="index-letter" href="elementindex_PHPMailer.html#t">t</a> |
31 | <a class="index-letter" href="elementindex_PHPMailer.html#u">u</a> |
32 | <a class="index-letter" href="elementindex_PHPMailer.html#v">v</a> |
33 | <a class="index-letter" href="elementindex_PHPMailer.html#w">w</a> |
34 | </div> |
35 | |
36 | <a name="a"></a> |
37 | <div class="index-letter-section"> |
38 | <div style="float: left" class="index-letter-title">a</div> |
39 | <div style="float: right"><a href="#top">top</a></div> |
40 | <div style="clear: both"></div> |
41 | </div> |
42 | <dl> |
43 | <dt class="field"> |
44 | <span class="var-title">$AltBody</span> |
45 | </dt> |
46 | <dd class="index-item-body"> |
47 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$AltBody">PHPMailer::$AltBody</a> in class.phpmailer.php</div> |
48 | <div class="index-item-description">Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.</div> |
49 | </dd> |
50 | <dt class="field"> |
51 | <span class="method-title">AddAddress</span> |
52 | </dt> |
53 | <dd class="index-item-body"> |
54 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAddress">PHPMailer::AddAddress()</a> in class.phpmailer.php</div> |
55 | <div class="index-item-description">Adds a "To" address.</div> |
56 | </dd> |
57 | <dt class="field"> |
58 | <span class="method-title">AddAttachment</span> |
59 | </dt> |
60 | <dd class="index-item-body"> |
61 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAttachment">PHPMailer::AddAttachment()</a> in class.phpmailer.php</div> |
62 | <div class="index-item-description">Adds an attachment from a path on the filesystem.</div> |
63 | </dd> |
64 | <dt class="field"> |
65 | <span class="method-title">AddBCC</span> |
66 | </dt> |
67 | <dd class="index-item-body"> |
68 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddBCC">PHPMailer::AddBCC()</a> in class.phpmailer.php</div> |
69 | <div class="index-item-description">Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</div> |
70 | </dd> |
71 | <dt class="field"> |
72 | <span class="method-title">AddCC</span> |
73 | </dt> |
74 | <dd class="index-item-body"> |
75 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCC">PHPMailer::AddCC()</a> in class.phpmailer.php</div> |
76 | <div class="index-item-description">Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</div> |
77 | </dd> |
78 | <dt class="field"> |
79 | <span class="method-title">AddCustomHeader</span> |
80 | </dt> |
81 | <dd class="index-item-body"> |
82 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCustomHeader">PHPMailer::AddCustomHeader()</a> in class.phpmailer.php</div> |
83 | <div class="index-item-description">Adds a custom header.</div> |
84 | </dd> |
85 | <dt class="field"> |
86 | <span class="method-title">AddEmbeddedImage</span> |
87 | </dt> |
88 | <dd class="index-item-body"> |
89 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddEmbeddedImage">PHPMailer::AddEmbeddedImage()</a> in class.phpmailer.php</div> |
90 | <div class="index-item-description">Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif".</div> |
91 | </dd> |
92 | <dt class="field"> |
93 | <span class="method-title">AddReplyTo</span> |
94 | </dt> |
95 | <dd class="index-item-body"> |
96 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddReplyTo">PHPMailer::AddReplyTo()</a> in class.phpmailer.php</div> |
97 | <div class="index-item-description">Adds a "Reply-to" address.</div> |
98 | </dd> |
99 | <dt class="field"> |
100 | <span class="method-title">AddStringAttachment</span> |
101 | </dt> |
102 | <dd class="index-item-body"> |
103 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddStringAttachment">PHPMailer::AddStringAttachment()</a> in class.phpmailer.php</div> |
104 | <div class="index-item-description">Adds a string or binary attachment (non-filesystem) to the list.</div> |
105 | </dd> |
106 | <dt class="field"> |
107 | <span class="method-title">Authenticate</span> |
108 | </dt> |
109 | <dd class="index-item-body"> |
110 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodAuthenticate">SMTP::Authenticate()</a> in class.smtp.php</div> |
111 | <div class="index-item-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</div> |
112 | </dd> |
113 | </dl> |
114 | <a name="b"></a> |
115 | <div class="index-letter-section"> |
116 | <div style="float: left" class="index-letter-title">b</div> |
117 | <div style="float: right"><a href="#top">top</a></div> |
118 | <div style="clear: both"></div> |
119 | </div> |
120 | <dl> |
121 | <dt class="field"> |
122 | <span class="var-title">$Body</span> |
123 | </dt> |
124 | <dd class="index-item-body"> |
125 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Body">PHPMailer::$Body</a> in class.phpmailer.php</div> |
126 | <div class="index-item-description">Sets the Body of the message. This can be either an HTML or text body.</div> |
127 | </dd> |
128 | </dl> |
129 | <a name="c"></a> |
130 | <div class="index-letter-section"> |
131 | <div style="float: left" class="index-letter-title">c</div> |
132 | <div style="float: right"><a href="#top">top</a></div> |
133 | <div style="clear: both"></div> |
134 | </div> |
135 | <dl> |
136 | <dt class="field"> |
137 | <span class="var-title">$CharSet</span> |
138 | </dt> |
139 | <dd class="index-item-body"> |
140 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$CharSet">PHPMailer::$CharSet</a> in class.phpmailer.php</div> |
141 | <div class="index-item-description">Sets the CharSet of the message.</div> |
142 | </dd> |
143 | <dt class="field"> |
144 | <span class="var-title">$ConfirmReadingTo</span> |
145 | </dt> |
146 | <dd class="index-item-body"> |
147 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ConfirmReadingTo">PHPMailer::$ConfirmReadingTo</a> in class.phpmailer.php</div> |
148 | <div class="index-item-description">Sets the email address that a reading confirmation will be sent.</div> |
149 | </dd> |
150 | <dt class="field"> |
151 | <span class="var-title">$ContentType</span> |
152 | </dt> |
153 | <dd class="index-item-body"> |
154 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ContentType">PHPMailer::$ContentType</a> in class.phpmailer.php</div> |
155 | <div class="index-item-description">Sets the Content-type of the message.</div> |
156 | </dd> |
157 | <dt class="field"> |
158 | <span class="var-title">$CRLF</span> |
159 | </dt> |
160 | <dd class="index-item-body"> |
161 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$CRLF">SMTP::$CRLF</a> in class.smtp.php</div> |
162 | <div class="index-item-description">SMTP reply line ending</div> |
163 | </dd> |
164 | <dt class="field"> |
165 | <span class="include-title">class.phpmailer.php</span> |
166 | </dt> |
167 | <dd class="index-item-body"> |
168 | <div class="index-item-details"><a href="PHPMailer/_class_phpmailer_php.html">class.phpmailer.php</a> in class.phpmailer.php</div> |
169 | </dd> |
170 | <dt class="field"> |
171 | <span class="include-title">class.smtp.php</span> |
172 | </dt> |
173 | <dd class="index-item-body"> |
174 | <div class="index-item-details"><a href="PHPMailer/_class_smtp_php.html">class.smtp.php</a> in class.smtp.php</div> |
175 | </dd> |
176 | <dt class="field"> |
177 | <span class="method-title">ClearAddresses</span> |
178 | </dt> |
179 | <dd class="index-item-body"> |
180 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAddresses">PHPMailer::ClearAddresses()</a> in class.phpmailer.php</div> |
181 | <div class="index-item-description">Clears all recipients assigned in the TO array. Returns void.</div> |
182 | </dd> |
183 | <dt class="field"> |
184 | <span class="method-title">ClearAllRecipients</span> |
185 | </dt> |
186 | <dd class="index-item-body"> |
187 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAllRecipients">PHPMailer::ClearAllRecipients()</a> in class.phpmailer.php</div> |
188 | <div class="index-item-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</div> |
189 | </dd> |
190 | <dt class="field"> |
191 | <span class="method-title">ClearAttachments</span> |
192 | </dt> |
193 | <dd class="index-item-body"> |
194 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAttachments">PHPMailer::ClearAttachments()</a> in class.phpmailer.php</div> |
195 | <div class="index-item-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</div> |
196 | </dd> |
197 | <dt class="field"> |
198 | <span class="method-title">ClearBCCs</span> |
199 | </dt> |
200 | <dd class="index-item-body"> |
201 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearBCCs">PHPMailer::ClearBCCs()</a> in class.phpmailer.php</div> |
202 | <div class="index-item-description">Clears all recipients assigned in the BCC array. Returns void.</div> |
203 | </dd> |
204 | <dt class="field"> |
205 | <span class="method-title">ClearCCs</span> |
206 | </dt> |
207 | <dd class="index-item-body"> |
208 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCCs">PHPMailer::ClearCCs()</a> in class.phpmailer.php</div> |
209 | <div class="index-item-description">Clears all recipients assigned in the CC array. Returns void.</div> |
210 | </dd> |
211 | <dt class="field"> |
212 | <span class="method-title">ClearCustomHeaders</span> |
213 | </dt> |
214 | <dd class="index-item-body"> |
215 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCustomHeaders">PHPMailer::ClearCustomHeaders()</a> in class.phpmailer.php</div> |
216 | <div class="index-item-description">Clears all custom headers. Returns void.</div> |
217 | </dd> |
218 | <dt class="field"> |
219 | <span class="method-title">ClearReplyTos</span> |
220 | </dt> |
221 | <dd class="index-item-body"> |
222 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearReplyTos">PHPMailer::ClearReplyTos()</a> in class.phpmailer.php</div> |
223 | <div class="index-item-description">Clears all recipients assigned in the ReplyTo array. Returns void.</div> |
224 | </dd> |
225 | <dt class="field"> |
226 | <span class="method-title">Close</span> |
227 | </dt> |
228 | <dd class="index-item-body"> |
229 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodClose">SMTP::Close()</a> in class.smtp.php</div> |
230 | <div class="index-item-description">Closes the socket and cleans up the state of the class.</div> |
231 | </dd> |
232 | <dt class="field"> |
233 | <span class="method-title">Connect</span> |
234 | </dt> |
235 | <dd class="index-item-body"> |
236 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodConnect">SMTP::Connect()</a> in class.smtp.php</div> |
237 | <div class="index-item-description">Connect to the server specified on the port specified.</div> |
238 | </dd> |
239 | </dl> |
240 | <a name="d"></a> |
241 | <div class="index-letter-section"> |
242 | <div style="float: left" class="index-letter-title">d</div> |
243 | <div style="float: right"><a href="#top">top</a></div> |
244 | <div style="clear: both"></div> |
245 | </div> |
246 | <dl> |
247 | <dt class="field"> |
248 | <span class="var-title">$do_debug</span> |
249 | </dt> |
250 | <dd class="index-item-body"> |
251 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$do_debug">SMTP::$do_debug</a> in class.smtp.php</div> |
252 | <div class="index-item-description">Sets whether debugging is turned on</div> |
253 | </dd> |
254 | <dt class="field"> |
255 | <span class="method-title">Data</span> |
256 | </dt> |
257 | <dd class="index-item-body"> |
258 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodData">SMTP::Data()</a> in class.smtp.php</div> |
259 | <div class="index-item-description">Issues a data command and sends the msg_data to the server</div> |
260 | </dd> |
261 | </dl> |
262 | <a name="e"></a> |
263 | <div class="index-letter-section"> |
264 | <div style="float: left" class="index-letter-title">e</div> |
265 | <div style="float: right"><a href="#top">top</a></div> |
266 | <div style="clear: both"></div> |
267 | </div> |
268 | <dl> |
269 | <dt class="field"> |
270 | <span class="var-title">$Encoding</span> |
271 | </dt> |
272 | <dd class="index-item-body"> |
273 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Encoding">PHPMailer::$Encoding</a> in class.phpmailer.php</div> |
274 | <div class="index-item-description">Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".</div> |
275 | </dd> |
276 | <dt class="field"> |
277 | <span class="var-title">$ErrorInfo</span> |
278 | </dt> |
279 | <dd class="index-item-body"> |
280 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ErrorInfo">PHPMailer::$ErrorInfo</a> in class.phpmailer.php</div> |
281 | <div class="index-item-description">Holds the most recent mailer error message.</div> |
282 | </dd> |
283 | <dt class="field"> |
284 | <span class="method-title">Expand</span> |
285 | </dt> |
286 | <dd class="index-item-body"> |
287 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodExpand">SMTP::Expand()</a> in class.smtp.php</div> |
288 | <div class="index-item-description">Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.</div> |
289 | </dd> |
290 | </dl> |
291 | <a name="f"></a> |
292 | <div class="index-letter-section"> |
293 | <div style="float: left" class="index-letter-title">f</div> |
294 | <div style="float: right"><a href="#top">top</a></div> |
295 | <div style="clear: both"></div> |
296 | </div> |
297 | <dl> |
298 | <dt class="field"> |
299 | <span class="var-title">$From</span> |
300 | </dt> |
301 | <dd class="index-item-body"> |
302 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$From">PHPMailer::$From</a> in class.phpmailer.php</div> |
303 | <div class="index-item-description">Sets the From email address for the message.</div> |
304 | </dd> |
305 | <dt class="field"> |
306 | <span class="var-title">$FromName</span> |
307 | </dt> |
308 | <dd class="index-item-body"> |
309 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$FromName">PHPMailer::$FromName</a> in class.phpmailer.php</div> |
310 | <div class="index-item-description">Sets the From name of the message.</div> |
311 | </dd> |
312 | </dl> |
313 | <a name="h"></a> |
314 | <div class="index-letter-section"> |
315 | <div style="float: left" class="index-letter-title">h</div> |
316 | <div style="float: right"><a href="#top">top</a></div> |
317 | <div style="clear: both"></div> |
318 | </div> |
319 | <dl> |
320 | <dt class="field"> |
321 | <span class="var-title">$Helo</span> |
322 | </dt> |
323 | <dd class="index-item-body"> |
324 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Helo">PHPMailer::$Helo</a> in class.phpmailer.php</div> |
325 | <div class="index-item-description">Sets the SMTP HELO of the message (Default is $Hostname).</div> |
326 | </dd> |
327 | <dt class="field"> |
328 | <span class="var-title">$Host</span> |
329 | </dt> |
330 | <dd class="index-item-body"> |
331 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Host">PHPMailer::$Host</a> in class.phpmailer.php</div> |
332 | <div class="index-item-description">Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com").</div> |
333 | </dd> |
334 | <dt class="field"> |
335 | <span class="var-title">$Hostname</span> |
336 | </dt> |
337 | <dd class="index-item-body"> |
338 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Hostname">PHPMailer::$Hostname</a> in class.phpmailer.php</div> |
339 | <div class="index-item-description">Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.</div> |
340 | </dd> |
341 | <dt class="field"> |
342 | <span class="method-title">Hello</span> |
343 | </dt> |
344 | <dd class="index-item-body"> |
345 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHello">SMTP::Hello()</a> in class.smtp.php</div> |
346 | <div class="index-item-description">Sends the HELO command to the smtp server.</div> |
347 | </dd> |
348 | <dt class="field"> |
349 | <span class="method-title">Help</span> |
350 | </dt> |
351 | <dd class="index-item-body"> |
352 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHelp">SMTP::Help()</a> in class.smtp.php</div> |
353 | <div class="index-item-description">Gets help information on the keyword specified. If the keyword</div> |
354 | </dd> |
355 | </dl> |
356 | <a name="i"></a> |
357 | <div class="index-letter-section"> |
358 | <div style="float: left" class="index-letter-title">i</div> |
359 | <div style="float: right"><a href="#top">top</a></div> |
360 | <div style="clear: both"></div> |
361 | </div> |
362 | <dl> |
363 | <dt class="field"> |
364 | <span class="method-title">IsError</span> |
365 | </dt> |
366 | <dd class="index-item-body"> |
367 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsError">PHPMailer::IsError()</a> in class.phpmailer.php</div> |
368 | <div class="index-item-description">Returns true if an error occurred.</div> |
369 | </dd> |
370 | <dt class="field"> |
371 | <span class="method-title">IsHTML</span> |
372 | </dt> |
373 | <dd class="index-item-body"> |
374 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsHTML">PHPMailer::IsHTML()</a> in class.phpmailer.php</div> |
375 | <div class="index-item-description">Sets message type to HTML.</div> |
376 | </dd> |
377 | <dt class="field"> |
378 | <span class="method-title">IsMail</span> |
379 | </dt> |
380 | <dd class="index-item-body"> |
381 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsMail">PHPMailer::IsMail()</a> in class.phpmailer.php</div> |
382 | <div class="index-item-description">Sets Mailer to send message using PHP mail() function.</div> |
383 | </dd> |
384 | <dt class="field"> |
385 | <span class="method-title">IsQmail</span> |
386 | </dt> |
387 | <dd class="index-item-body"> |
388 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsQmail">PHPMailer::IsQmail()</a> in class.phpmailer.php</div> |
389 | <div class="index-item-description">Sets Mailer to send message using the qmail MTA.</div> |
390 | </dd> |
391 | <dt class="field"> |
392 | <span class="method-title">IsSendmail</span> |
393 | </dt> |
394 | <dd class="index-item-body"> |
395 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSendmail">PHPMailer::IsSendmail()</a> in class.phpmailer.php</div> |
396 | <div class="index-item-description">Sets Mailer to send message using the $Sendmail program.</div> |
397 | </dd> |
398 | <dt class="field"> |
399 | <span class="method-title">IsSMTP</span> |
400 | </dt> |
401 | <dd class="index-item-body"> |
402 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSMTP">PHPMailer::IsSMTP()</a> in class.phpmailer.php</div> |
403 | <div class="index-item-description">Sets Mailer to send message using SMTP.</div> |
404 | </dd> |
405 | </dl> |
406 | <a name="m"></a> |
407 | <div class="index-letter-section"> |
408 | <div style="float: left" class="index-letter-title">m</div> |
409 | <div style="float: right"><a href="#top">top</a></div> |
410 | <div style="clear: both"></div> |
411 | </div> |
412 | <dl> |
413 | <dt class="field"> |
414 | <span class="var-title">$Mailer</span> |
415 | </dt> |
416 | <dd class="index-item-body"> |
417 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Mailer">PHPMailer::$Mailer</a> in class.phpmailer.php</div> |
418 | <div class="index-item-description">Method to send mail: ("mail", "sendmail", or "smtp").</div> |
419 | </dd> |
420 | <dt class="field"> |
421 | <span class="method-title">Mail</span> |
422 | </dt> |
423 | <dd class="index-item-body"> |
424 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodMail">SMTP::Mail()</a> in class.smtp.php</div> |
425 | <div class="index-item-description">Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.</div> |
426 | </dd> |
427 | </dl> |
428 | <a name="n"></a> |
429 | <div class="index-letter-section"> |
430 | <div style="float: left" class="index-letter-title">n</div> |
431 | <div style="float: right"><a href="#top">top</a></div> |
432 | <div style="clear: both"></div> |
433 | </div> |
434 | <dl> |
435 | <dt class="field"> |
436 | <span class="method-title">Noop</span> |
437 | </dt> |
438 | <dd class="index-item-body"> |
439 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodNoop">SMTP::Noop()</a> in class.smtp.php</div> |
440 | <div class="index-item-description">Sends the command NOOP to the SMTP server.</div> |
441 | </dd> |
442 | </dl> |
443 | <a name="p"></a> |
444 | <div class="index-letter-section"> |
445 | <div style="float: left" class="index-letter-title">p</div> |
446 | <div style="float: right"><a href="#top">top</a></div> |
447 | <div style="clear: both"></div> |
448 | </div> |
449 | <dl> |
450 | <dt class="field"> |
451 | <span class="var-title">$Password</span> |
452 | </dt> |
453 | <dd class="index-item-body"> |
454 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Password">PHPMailer::$Password</a> in class.phpmailer.php</div> |
455 | <div class="index-item-description">Sets SMTP password.</div> |
456 | </dd> |
457 | <dt class="field"> |
458 | <span class="var-title">$PluginDir</span> |
459 | </dt> |
460 | <dd class="index-item-body"> |
461 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$PluginDir">PHPMailer::$PluginDir</a> in class.phpmailer.php</div> |
462 | <div class="index-item-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</div> |
463 | </dd> |
464 | <dt class="field"> |
465 | <span class="var-title">$Port</span> |
466 | </dt> |
467 | <dd class="index-item-body"> |
468 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Port">PHPMailer::$Port</a> in class.phpmailer.php</div> |
469 | <div class="index-item-description">Sets the default SMTP server port.</div> |
470 | </dd> |
471 | <dt class="field"> |
472 | <span class="var-title">$Priority</span> |
473 | </dt> |
474 | <dd class="index-item-body"> |
475 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Priority">PHPMailer::$Priority</a> in class.phpmailer.php</div> |
476 | <div class="index-item-description">Email priority (1 = High, 3 = Normal, 5 = low).</div> |
477 | </dd> |
478 | <dt class="field"> |
479 | PHPMailer |
480 | </dt> |
481 | <dd class="index-item-body"> |
482 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html">PHPMailer</a> in class.phpmailer.php</div> |
483 | <div class="index-item-description">PHPMailer - PHP email transport class</div> |
484 | </dd> |
485 | </dl> |
486 | <a name="q"></a> |
487 | <div class="index-letter-section"> |
488 | <div style="float: left" class="index-letter-title">q</div> |
489 | <div style="float: right"><a href="#top">top</a></div> |
490 | <div style="clear: both"></div> |
491 | </div> |
492 | <dl> |
493 | <dt class="field"> |
494 | <span class="method-title">Quit</span> |
495 | </dt> |
496 | <dd class="index-item-body"> |
497 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodQuit">SMTP::Quit()</a> in class.smtp.php</div> |
498 | <div class="index-item-description">Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.</div> |
499 | </dd> |
500 | </dl> |
501 | <a name="r"></a> |
502 | <div class="index-letter-section"> |
503 | <div style="float: left" class="index-letter-title">r</div> |
504 | <div style="float: right"><a href="#top">top</a></div> |
505 | <div style="clear: both"></div> |
506 | </div> |
507 | <dl> |
508 | <dt class="field"> |
509 | <span class="method-title">Recipient</span> |
510 | </dt> |
511 | <dd class="index-item-body"> |
512 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodRecipient">SMTP::Recipient()</a> in class.smtp.php</div> |
513 | <div class="index-item-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</div> |
514 | </dd> |
515 | <dt class="field"> |
516 | <span class="method-title">Reset</span> |
517 | </dt> |
518 | <dd class="index-item-body"> |
519 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodReset">SMTP::Reset()</a> in class.smtp.php</div> |
520 | <div class="index-item-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</div> |
521 | </dd> |
522 | </dl> |
523 | <a name="s"></a> |
524 | <div class="index-letter-section"> |
525 | <div style="float: left" class="index-letter-title">s</div> |
526 | <div style="float: right"><a href="#top">top</a></div> |
527 | <div style="clear: both"></div> |
528 | </div> |
529 | <dl> |
530 | <dt class="field"> |
531 | <span class="var-title">$Sender</span> |
532 | </dt> |
533 | <dd class="index-item-body"> |
534 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sender">PHPMailer::$Sender</a> in class.phpmailer.php</div> |
535 | <div class="index-item-description">Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.</div> |
536 | </dd> |
537 | <dt class="field"> |
538 | <span class="var-title">$Sendmail</span> |
539 | </dt> |
540 | <dd class="index-item-body"> |
541 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sendmail">PHPMailer::$Sendmail</a> in class.phpmailer.php</div> |
542 | <div class="index-item-description">Sets the path of the sendmail program.</div> |
543 | </dd> |
544 | <dt class="field"> |
545 | <span class="var-title">$SMTPAuth</span> |
546 | </dt> |
547 | <dd class="index-item-body"> |
548 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPAuth">PHPMailer::$SMTPAuth</a> in class.phpmailer.php</div> |
549 | <div class="index-item-description">Sets SMTP authentication. Utilizes the Username and Password variables.</div> |
550 | </dd> |
551 | <dt class="field"> |
552 | <span class="var-title">$SMTPDebug</span> |
553 | </dt> |
554 | <dd class="index-item-body"> |
555 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPDebug">PHPMailer::$SMTPDebug</a> in class.phpmailer.php</div> |
556 | <div class="index-item-description">Sets SMTP class debugging on or off.</div> |
557 | </dd> |
558 | <dt class="field"> |
559 | <span class="var-title">$SMTPKeepAlive</span> |
560 | </dt> |
561 | <dd class="index-item-body"> |
562 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPKeepAlive">PHPMailer::$SMTPKeepAlive</a> in class.phpmailer.php</div> |
563 | <div class="index-item-description">Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().</div> |
564 | </dd> |
565 | <dt class="field"> |
566 | <span class="var-title">$SMTP_PORT</span> |
567 | </dt> |
568 | <dd class="index-item-body"> |
569 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$SMTP_PORT">SMTP::$SMTP_PORT</a> in class.smtp.php</div> |
570 | <div class="index-item-description">SMTP server port</div> |
571 | </dd> |
572 | <dt class="field"> |
573 | <span class="var-title">$Subject</span> |
574 | </dt> |
575 | <dd class="index-item-body"> |
576 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Subject">PHPMailer::$Subject</a> in class.phpmailer.php</div> |
577 | <div class="index-item-description">Sets the Subject of the message.</div> |
578 | </dd> |
579 | <dt class="field"> |
580 | <span class="method-title">Send</span> |
581 | </dt> |
582 | <dd class="index-item-body"> |
583 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSend">SMTP::Send()</a> in class.smtp.php</div> |
584 | <div class="index-item-description">Starts a mail transaction from the email address specified in</div> |
585 | </dd> |
586 | <dt class="field"> |
587 | <span class="method-title">Send</span> |
588 | </dt> |
589 | <dd class="index-item-body"> |
590 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSend">PHPMailer::Send()</a> in class.phpmailer.php</div> |
591 | <div class="index-item-description">Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.</div> |
592 | </dd> |
593 | <dt class="field"> |
594 | <span class="method-title">SendAndMail</span> |
595 | </dt> |
596 | <dd class="index-item-body"> |
597 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendAndMail">SMTP::SendAndMail()</a> in class.smtp.php</div> |
598 | <div class="index-item-description">Starts a mail transaction from the email address specified in</div> |
599 | </dd> |
600 | <dt class="field"> |
601 | <span class="method-title">SendOrMail</span> |
602 | </dt> |
603 | <dd class="index-item-body"> |
604 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendOrMail">SMTP::SendOrMail()</a> in class.smtp.php</div> |
605 | <div class="index-item-description">Starts a mail transaction from the email address specified in</div> |
606 | </dd> |
607 | <dt class="field"> |
608 | <span class="method-title">SetLanguage</span> |
609 | </dt> |
610 | <dd class="index-item-body"> |
611 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSetLanguage">PHPMailer::SetLanguage()</a> in class.phpmailer.php</div> |
612 | <div class="index-item-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</div> |
613 | </dd> |
614 | <dt class="field"> |
615 | <span class="method-title">SMTP</span> |
616 | </dt> |
617 | <dd class="index-item-body"> |
618 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSMTP">SMTP::SMTP()</a> in class.smtp.php</div> |
619 | <div class="index-item-description">Initialize the class so that the data is in a known state.</div> |
620 | </dd> |
621 | <dt class="field"> |
622 | SMTP |
623 | </dt> |
624 | <dd class="index-item-body"> |
625 | <div class="index-item-details"><a href="PHPMailer/SMTP.html">SMTP</a> in class.smtp.php</div> |
626 | <div class="index-item-description">SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.</div> |
627 | </dd> |
628 | <dt class="field"> |
629 | <span class="method-title">SmtpClose</span> |
630 | </dt> |
631 | <dd class="index-item-body"> |
632 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSmtpClose">PHPMailer::SmtpClose()</a> in class.phpmailer.php</div> |
633 | <div class="index-item-description">Closes the active SMTP session if one exists.</div> |
634 | </dd> |
635 | </dl> |
636 | <a name="t"></a> |
637 | <div class="index-letter-section"> |
638 | <div style="float: left" class="index-letter-title">t</div> |
639 | <div style="float: right"><a href="#top">top</a></div> |
640 | <div style="clear: both"></div> |
641 | </div> |
642 | <dl> |
643 | <dt class="field"> |
644 | <span class="var-title">$Timeout</span> |
645 | </dt> |
646 | <dd class="index-item-body"> |
647 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Timeout">PHPMailer::$Timeout</a> in class.phpmailer.php</div> |
648 | <div class="index-item-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</div> |
649 | </dd> |
650 | <dt class="field"> |
651 | <span class="method-title">Turn</span> |
652 | </dt> |
653 | <dd class="index-item-body"> |
654 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodTurn">SMTP::Turn()</a> in class.smtp.php</div> |
655 | <div class="index-item-description">This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future</div> |
656 | </dd> |
657 | </dl> |
658 | <a name="u"></a> |
659 | <div class="index-letter-section"> |
660 | <div style="float: left" class="index-letter-title">u</div> |
661 | <div style="float: right"><a href="#top">top</a></div> |
662 | <div style="clear: both"></div> |
663 | </div> |
664 | <dl> |
665 | <dt class="field"> |
666 | <span class="var-title">$Username</span> |
667 | </dt> |
668 | <dd class="index-item-body"> |
669 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Username">PHPMailer::$Username</a> in class.phpmailer.php</div> |
670 | <div class="index-item-description">Sets SMTP username.</div> |
671 | </dd> |
672 | </dl> |
673 | <a name="v"></a> |
674 | <div class="index-letter-section"> |
675 | <div style="float: left" class="index-letter-title">v</div> |
676 | <div style="float: right"><a href="#top">top</a></div> |
677 | <div style="clear: both"></div> |
678 | </div> |
679 | <dl> |
680 | <dt class="field"> |
681 | <span class="var-title">$Version</span> |
682 | </dt> |
683 | <dd class="index-item-body"> |
684 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Version">PHPMailer::$Version</a> in class.phpmailer.php</div> |
685 | <div class="index-item-description">Holds PHPMailer version.</div> |
686 | </dd> |
687 | <dt class="field"> |
688 | <span class="method-title">Verify</span> |
689 | </dt> |
690 | <dd class="index-item-body"> |
691 | <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodVerify">SMTP::Verify()</a> in class.smtp.php</div> |
692 | <div class="index-item-description">Verifies that the name is recognized by the server.</div> |
693 | </dd> |
694 | </dl> |
695 | <a name="w"></a> |
696 | <div class="index-letter-section"> |
697 | <div style="float: left" class="index-letter-title">w</div> |
698 | <div style="float: right"><a href="#top">top</a></div> |
699 | <div style="clear: both"></div> |
700 | </div> |
701 | <dl> |
702 | <dt class="field"> |
703 | <span class="var-title">$WordWrap</span> |
704 | </dt> |
705 | <dd class="index-item-body"> |
706 | <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$WordWrap">PHPMailer::$WordWrap</a> in class.phpmailer.php</div> |
707 | <div class="index-item-description">Sets word wrapping on the body of the message to a given number of characters.</div> |
708 | </dd> |
709 | </dl> |
710 | |
711 | <div class="index-letter-menu"> |
712 | <a class="index-letter" href="elementindex_PHPMailer.html#a">a</a> |
713 | <a class="index-letter" href="elementindex_PHPMailer.html#b">b</a> |
714 | <a class="index-letter" href="elementindex_PHPMailer.html#c">c</a> |
715 | <a class="index-letter" href="elementindex_PHPMailer.html#d">d</a> |
716 | <a class="index-letter" href="elementindex_PHPMailer.html#e">e</a> |
717 | <a class="index-letter" href="elementindex_PHPMailer.html#f">f</a> |
718 | <a class="index-letter" href="elementindex_PHPMailer.html#h">h</a> |
719 | <a class="index-letter" href="elementindex_PHPMailer.html#i">i</a> |
720 | <a class="index-letter" href="elementindex_PHPMailer.html#m">m</a> |
721 | <a class="index-letter" href="elementindex_PHPMailer.html#n">n</a> |
722 | <a class="index-letter" href="elementindex_PHPMailer.html#p">p</a> |
723 | <a class="index-letter" href="elementindex_PHPMailer.html#q">q</a> |
724 | <a class="index-letter" href="elementindex_PHPMailer.html#r">r</a> |
725 | <a class="index-letter" href="elementindex_PHPMailer.html#s">s</a> |
726 | <a class="index-letter" href="elementindex_PHPMailer.html#t">t</a> |
727 | <a class="index-letter" href="elementindex_PHPMailer.html#u">u</a> |
728 | <a class="index-letter" href="elementindex_PHPMailer.html#v">v</a> |
729 | <a class="index-letter" href="elementindex_PHPMailer.html#w">w</a> |
730 | </div> </body> |
731 | </html> |