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