~titan-phpdevshell/phpdevshell/main

Located in <a class="field" href="_legacy---phpmailer---class.phpmailer.php.html">/legacy/phpmailer/class.phpmailer.php</a> (line <span class="field">43</span>)

</p>

</div>

<div class="info-box-title">Direct descendents</div>

<a href="#sec-description">Description</a> |

<span class="disabled">Descendents</span>

| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)

</div>

<tr>

<th class="class-table-header">Class</th>

<th class="class-table-header">Description</th>

</tr>

<tr>

<td style="padding-right: 2em"><a href="../PHPDevShell/email.html">email</a></td>

<td>

Contains methods to handle emails appropriate.

</td>

</tr>

</table>

</div>

<div class="info-box-title">Class Constant Summary</span></div>

<a href="#sec-description">Description</a> |

<a href="#sec-descendents">Descendants</a> |

<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)

<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

</div>

<a href="#STOP_CONTINUE" title="details" class="const-name">STOP_CONTINUE</a> = <span class="var-type"> 1</span>

</div>

<a href="#STOP_CRITICAL" title="details" class="const-name">STOP_CRITICAL</a> = <span class="var-type"> 2</span>

100

</div>

101

102

103

<a href="#STOP_MESSAGE" title="details" class="const-name">STOP_MESSAGE</a> = <span class="var-type"> 0</span>

104

105

</div>

106

</div>

107

</div>

108

</div>

109

110

111

112

<div class="info-box-title">Variable Summary</span></div>

113

114

<a href="#sec-description">Description</a> |

115

<a href="#sec-descendents">Descendents</a> |

116

<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)

117

118

<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

119

120

<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)

121

122

</div>

123

124

125

126

<span class="var-type">string</span>

127

<a href="#$AltBody" title="details" class="var-name">$AltBody</a>

128

</div>

129

130

<span class="var-type">string</span>

131

132

</div>

133

134

<span class="var-type">string</span>

135

<a href="#$CharSet" title="details" class="var-name">$CharSet</a>

136

</div>

137

138

<span class="var-type">string</span>

139

<a href="#$ConfirmReadingTo" title="details" class="var-name">$ConfirmReadingTo</a>

140

</div>

141

142

<span class="var-type">string</span>

143

<a href="#$ContentType" title="details" class="var-name">$ContentType</a>

144

</div>

145

146

<span class="var-type">string</span>

147

<a href="#$Encoding" title="details" class="var-name">$Encoding</a>

148

</div>

149

150

<span class="var-type">string</span>

151

<a href="#$ErrorInfo" title="details" class="var-name">$ErrorInfo</a>

152

</div>

153

154

<span class="var-type">string</span>

155

156

</div>

157

158

<span class="var-type">string</span>

159

<a href="#$FromName" title="details" class="var-name">$FromName</a>

160

</div>

161

162

<span class="var-type">string</span>

163

164

</div>

165

166

<span class="var-type">string</span>

167

168

</div>

169

170

<span class="var-type">string</span>

171

<a href="#$Hostname" title="details" class="var-name">$Hostname</a>

172

</div>

173

174

<span class="var-type">mixed</span>

175

<a href="#$language" title="details" class="var-name">$language</a>

176

</div>

177

178

<span class="var-type">string</span>

179

180

</div>

181

182

<span class="var-type">string</span>

183

<a href="#$Mailer" title="details" class="var-name">$Mailer</a>

184

</div>

185

186

<span class="var-type">string</span>

187

<a href="#$MessageID" title="details" class="var-name">$MessageID</a>

188

</div>

189

190

<span class="var-type">string</span>

191

<a href="#$Password" title="details" class="var-name">$Password</a>

192

</div>

193

194

<span class="var-type">string</span>

195

<a href="#$PluginDir" title="details" class="var-name">$PluginDir</a>

196

</div>

197

198

199

200

</div>

201

202

203

<a href="#$Priority" title="details" class="var-name">$Priority</a>

204

</div>

205

206

<span class="var-type">string</span>

207

<a href="#$Sender" title="details" class="var-name">$Sender</a>

208

</div>

209

210

<span class="var-type">string</span>

211

<a href="#$Sendmail" title="details" class="var-name">$Sendmail</a>

212

</div>

213

214

215

<a href="#$SingleTo" title="details" class="var-name">$SingleTo</a>

216

</div>

217

218

219

<a href="#$SMTPAuth" title="details" class="var-name">$SMTPAuth</a>

220

</div>

221

222

223

<a href="#$SMTPDebug" title="details" class="var-name">$SMTPDebug</a>

224

</div>

225

226

227

<a href="#$SMTPKeepAlive" title="details" class="var-name">$SMTPKeepAlive</a>

228

</div>

229

230

<span class="var-type">string</span>

231

<a href="#$SMTPSecure" title="details" class="var-name">$SMTPSecure</a>

232

</div>

233

234

<span class="var-type">string</span>

235

<a href="#$Subject" title="details" class="var-name">$Subject</a>

236

</div>

237

238

239

<a href="#$Timeout" title="details" class="var-name">$Timeout</a>

240

</div>

241

242

<span class="var-type">string</span>

243

<a href="#$Username" title="details" class="var-name">$Username</a>

244

</div>

245

246

<span class="var-type">string</span>

247

<a href="#$Version" title="details" class="var-name">$Version</a>

248

</div>

249

250

251

<a href="#$WordWrap" title="details" class="var-name">$WordWrap</a>

252

</div>

253

</div>

254

</div>

255

</div>

256

257

258

259

<div class="info-box-title">Method Summary</span></div>

260

261

<a href="#sec-description">Description</a> |

262

<a href="#sec-descendents">Descendents</a> |

263

<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)

264

265

<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

266

267

268

<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)

269

</div>

270

271

272

273

static <span class="method-result">string</span>

274

<a href="#RFCDate" title="details" class="method-name">RFCDate</a>

275

()

276

</div>

277

278

static <span class="method-result">boolean</span>

279

<a href="#ValidateAddress" title="details" class="method-name">ValidateAddress</a>

280

(<span class="var-type">string</span> <span class="var-name">$address</span>)

281

</div>

282

283

static <span class="method-result">string</span>

284

<a href="#_mime_types" title="details" class="method-name">_mime_types</a>

285

([<span class="var-type">string</span> <span class="var-name">$ext</span> = <span class="var-default">''</span>])

286

</div>

287

288

289

<span class="method-result">PHPMailer</span>

290

<a href="#__construct" title="details" class="method-name">__construct</a>

291

([<span class="var-type">boolean</span> <span class="var-name">$exceptions</span> = <span class="var-default">true</span>])

292

</div>

293

294

<span class="method-result">boolean</span>

295

<a href="#AddAddress" title="details" class="method-name">AddAddress</a>

296

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

297

</div>

298

299

300

<a href="#AddAttachment" title="details" class="method-name">AddAttachment</a>

301

(<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">'base64'</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">'application/octet-stream'</span>])

302

</div>

303

304

<span class="method-result">boolean</span>

305

<a href="#AddBCC" title="details" class="method-name">AddBCC</a>

306

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

307

</div>

308

309

<span class="method-result">boolean</span>

310

<a href="#AddCC" title="details" class="method-name">AddCC</a>

311

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

312

</div>

313

314

315

<a href="#AddCustomHeader" title="details" class="method-name">AddCustomHeader</a>

316

(<span class="var-type"></span> <span class="var-name">$custom_header</span>)

317

</div>

318

319

320

<a href="#AddEmbeddedImage" title="details" class="method-name">AddEmbeddedImage</a>

321

(<span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">string</span> <span class="var-name">$cid</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">'base64'</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">'application/octet-stream'</span>])

322

</div>

323

324

<span class="method-result">string</span>

325

<a href="#AddrAppend" title="details" class="method-name">AddrAppend</a>

326

(<span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$addr</span>)

327

</div>

328

329

<span class="method-result">boolean</span>

330

<a href="#AddReplyTo" title="details" class="method-name">AddReplyTo</a>

331

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

332

</div>

333

334

<span class="method-result">string</span>

335

<a href="#AddrFormat" title="details" class="method-name">AddrFormat</a>

336

(<span class="var-type"></span> <span class="var-name">$addr</span>)

337

</div>

338

339

340

<a href="#AddStringAttachment" title="details" class="method-name">AddStringAttachment</a>

341

(<span class="var-type">string</span> <span class="var-name">$string</span>, <span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">'base64'</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">'application/octet-stream'</span>])

342

</div>

343

344

<span class="method-result">string</span>

345

<a href="#Base64EncodeWrapMB" title="details" class="method-name">Base64EncodeWrapMB</a>

346

(<span class="var-type">string</span> <span class="var-name">$str</span>)

347

</div>

348

349

350

<a href="#ClearAddresses" title="details" class="method-name">ClearAddresses</a>

351

()

352

</div>

353

354

355

<a href="#ClearAllRecipients" title="details" class="method-name">ClearAllRecipients</a>

356

()

357

</div>

358

359

360

<a href="#ClearAttachments" title="details" class="method-name">ClearAttachments</a>

361

()

362

</div>

363

364

365

<a href="#ClearBCCs" title="details" class="method-name">ClearBCCs</a>

366

()

367

</div>

368

369

370

<a href="#ClearCCs" title="details" class="method-name">ClearCCs</a>

371

()

372

</div>

373

374

375

<a href="#ClearCustomHeaders" title="details" class="method-name">ClearCustomHeaders</a>

376

()

377

</div>

378

379

380

<a href="#ClearReplyTos" title="details" class="method-name">ClearReplyTos</a>

381

()

382

</div>

383

384

<span class="method-result">string</span>

385

<a href="#CreateBody" title="details" class="method-name">CreateBody</a>

386

()

387

</div>

388

389

<span class="method-result">string</span>

390

<a href="#CreateHeader" title="details" class="method-name">CreateHeader</a>

391

()

392

</div>

393

394

<span class="method-result">string</span>

395

<a href="#EncodeHeader" title="details" class="method-name">EncodeHeader</a>

396

(<span class="var-type"></span> <span class="var-name">$str</span>, [<span class="var-type"></span> <span class="var-name">$position</span> = <span class="var-default">'text'</span>])

397

</div>

398

399

<span class="method-result">string</span>

400

<a href="#EncodeQ" title="details" class="method-name">EncodeQ</a>

401

(<span class="var-type">string</span> <span class="var-name">$str</span>, [<span class="var-type">string</span> <span class="var-name">$position</span> = <span class="var-default">'text'</span>])

402

</div>

403

404

<span class="method-result">string</span>

405

<a href="#EncodeQP" title="details" class="method-name">EncodeQP</a>

406

(<span class="var-type">string</span> <span class="var-name">$string</span>, [<span class="var-type">integer</span> <span class="var-name">$line_max</span> = <span class="var-default">76</span>], [<span class="var-type">boolean</span> <span class="var-name">$space_conv</span> = <span class="var-default">false</span>])

407

</div>

408

409

<span class="method-result">string</span>

410

<a href="#EncodeQPphp" title="details" class="method-name">EncodeQPphp</a>

411

([<span class="var-type"></span> <span class="var-name">$input</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span> <span class="var-name">$line_max</span> = <span class="var-default">76</span>], [<span class="var-type"></span> <span class="var-name">$space_conv</span> = <span class="var-default">false</span>], <span class="var-type">string</span> <span class="var-name">$string</span>)

412

</div>

413

414

<span class="method-result">string</span>

415

<a href="#EncodeString" title="details" class="method-name">EncodeString</a>

416

(<span class="var-type">string</span> <span class="var-name">$str</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">'base64'</span>])

417

</div>

418

419

<span class="method-result">array</span>

420

<a href="#GetAttachments" title="details" class="method-name">GetAttachments</a>

421

()

422

</div>

423

424

<span class="method-result">string</span>

425

<a href="#GetMailMIME" title="details" class="method-name">GetMailMIME</a>

426

()

427

</div>

428

429

<span class="method-result">array</span>

430

<a href="#GetTranslations" title="details" class="method-name">GetTranslations</a>

431

()

432

</div>

433

434

435

<a href="#HasMultiBytes" title="details" class="method-name">HasMultiBytes</a>

436

(<span class="var-type">string</span> <span class="var-name">$str</span>)

437

</div>

438

439

<span class="method-result">string</span>

440

<a href="#HeaderLine" title="details" class="method-name">HeaderLine</a>

441

(<span class="var-type"></span> <span class="var-name">$name</span>, <span class="var-type"></span> <span class="var-name">$value</span>)

442

</div>

443

444

445

<a href="#InlineImageExists" title="details" class="method-name">InlineImageExists</a>

446

()

447

</div>

448

449

450

<a href="#IsError" title="details" class="method-name">IsError</a>

451

()

452

</div>

453

454

455

<a href="#IsHTML" title="details" class="method-name">IsHTML</a>

456

([<span class="var-type">bool</span> <span class="var-name">$ishtml</span> = <span class="var-default">true</span>])

457

</div>

458

459

460

<a href="#IsMail" title="details" class="method-name">IsMail</a>

461

()

462

</div>

463

464

465

<a href="#IsQmail" title="details" class="method-name">IsQmail</a>

466

()

467

</div>

468

469

470

<a href="#IsSendmail" title="details" class="method-name">IsSendmail</a>

471

()

472

</div>

473

474

475

<a href="#IsSMTP" title="details" class="method-name">IsSMTP</a>

476

()

477

</div>

478

479

480

<a href="#MailSend" title="details" class="method-name">MailSend</a>

481

(<span class="var-type">string</span> <span class="var-name">$header</span>, <span class="var-type">string</span> <span class="var-name">$body</span>)

482

</div>

483

484

<span class="method-result">$message</span>

485

<a href="#MsgHTML" title="details" class="method-name">MsgHTML</a>

486

(<span class="var-type"></span> <span class="var-name">$message</span>, [<span class="var-type"></span> <span class="var-name">$basedir</span> = <span class="var-default">''</span>])

487

</div>

488

489

<span class="method-result">string</span>

490

<a href="#SecureHeader" title="details" class="method-name">SecureHeader</a>

491

(<span class="var-type">string</span> <span class="var-name">$str</span>)

492

</div>

493

494

495

496

()

497

</div>

498

499

500

<a href="#SendmailSend" title="details" class="method-name">SendmailSend</a>

501

(<span class="var-type">string</span> <span class="var-name">$header</span>, <span class="var-type">string</span> <span class="var-name">$body</span>)

502

</div>

503

504

505

506

(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$value</span> = <span class="var-default">''</span>])

507

</div>

508

509

510

<a href="#SetError" title="details" class="method-name">SetError</a>

511

(<span class="var-type"></span> <span class="var-name">$msg</span>)

512

</div>

513

514

<span class="method-result">boolean</span>

515

<a href="#SetFrom" title="details" class="method-name">SetFrom</a>

516

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

517

</div>

518

519

520

<a href="#SetLanguage" title="details" class="method-name">SetLanguage</a>

521

([<span class="var-type">string</span> <span class="var-name">$langcode</span> = <span class="var-default">'en'</span>], [<span class="var-type">string</span> <span class="var-name">$lang_path</span> = <span class="var-default">'language/'</span>])

522

</div>

523

524

525

<a href="#SetWordWrap" title="details" class="method-name">SetWordWrap</a>

526

()

527

</div>

528

529

530

531

(<span class="var-type"></span> <span class="var-name">$cert_filename</span>, <span class="var-type">string</span> <span class="var-name">$key_filename</span>, <span class="var-type">string</span> <span class="var-name">$key_pass</span>)

532

</div>

533

534

535

<a href="#SmtpClose" title="details" class="method-name">SmtpClose</a>

536

()

537

</div>

538

539

540

<a href="#SmtpConnect" title="details" class="method-name">SmtpConnect</a>

541

()

542

</div>

543

544

545

<a href="#SmtpSend" title="details" class="method-name">SmtpSend</a>

546

(<span class="var-type">string</span> <span class="var-name">$header</span>, <span class="var-type">string</span> <span class="var-name">$body</span>)

547

</div>

548

549

<span class="method-result">string</span>

550

<a href="#TextLine" title="details" class="method-name">TextLine</a>

551

(<span class="var-type"></span> <span class="var-name">$value</span>)

552

</div>

553

554

555

<a href="#UTF8CharBoundary" title="details" class="method-name">UTF8CharBoundary</a>

556

(<span class="var-type">string</span> <span class="var-name">$encodedText</span>, <span class="var-type">int</span> <span class="var-name">$maxLength</span>)

557

</div>

558

559

<span class="method-result">string</span>

560

<a href="#WrapText" title="details" class="method-name">WrapText</a>

561

(<span class="var-type">string</span> <span class="var-name">$message</span>, <span class="var-type">integer</span> <span class="var-name">$length</span>, [<span class="var-type">boolean</span> <span class="var-name">$qp_mode</span> = <span class="var-default">false</span>])

562

</div>

563

</div>

564

</div>

565

</div>

566

567

568

569

<div class="info-box-title">Variables</div>

570

571

<a href="#sec-description">Description</a> |

572

<a href="#sec-descendents">Descendents</a> |

573

<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)

574

575

576

<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)

577

578

579

<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

580

581

</div>

582

583

584

585

586

587

588

<span class="var-type">string</span>

589

<span class="var-name">$AltBody</span>

590

= <span class="var-default"> ''</span> (line <span class="line-number">119</span>)

591

</span>

592

</div>

593

594

595

<p class="short-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.</p>

596

597

<li><span class="field">access:</span> public</li>

598

</ul>

599

600

601

602

603

604

</div>

605

606

607

608

609

610

<span class="var-type">string</span>

611

612

= <span class="var-default"> ''</span> (line <span class="line-number">110</span>)

613

</span>

614

</div>

615

616

617

<p class="short-description">Sets the Body of the message. This can be either an HTML or text body.</p>

618

<p class="description"><p>If HTML then run IsHTML(true).</p></p>

619

620

<li><span class="field">access:</span> public</li>

621

</ul>

622

623

624

625

626

627

</div>

628

629

630

631

632

633

<span class="var-type">string</span>

634

<span class="var-name">$CharSet</span>

635

= <span class="var-default"> 'iso-8859-1'</span> (line <span class="line-number">59</span>)

636

</span>

637

</div>

638

639

640

<p class="short-description">Sets the CharSet of the message.</p>

641

642

<li><span class="field">access:</span> public</li>

643

</ul>

644

645

646

647

648

649

</div>

650

651

652

653

654

655

<span class="var-type">string</span>

656

<span class="var-name">$ConfirmReadingTo</span>

657

= <span class="var-default"> ''</span> (line <span class="line-number">151</span>)

658

</span>

659

</div>

660

661

662

<p class="short-description">Sets the email address that a reading confirmation will be sent.</p>

663

664

<li><span class="field">access:</span> public</li>

665

</ul>

666

667

668

669

670

671

</div>

672

673

674

675

676

677

<span class="var-type">string</span>

678

<span class="var-name">$ContentType</span>

679

= <span class="var-default"> 'text/plain'</span> (line <span class="line-number">65</span>)

680

</span>

681

</div>

682

683

684

<p class="short-description">Sets the Content-type of the message.</p>

685

686

<li><span class="field">access:</span> public</li>

687

</ul>

688

689

690

691

692

693

</div>

694

695

696

697

698

699

<span class="var-type">string</span>

700

<span class="var-name">$Encoding</span>

701

= <span class="var-default"> '8bit'</span> (line <span class="line-number">72</span>)

702

</span>

703

</div>

704

705

706

<p class="short-description">Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".</p>

707

708

<li><span class="field">access:</span> public</li>

709

</ul>

710

711

712

713

714

715

</div>

716

717

718

719

720

721

<span class="var-type">string</span>

722

<span class="var-name">$ErrorInfo</span>

723

= <span class="var-default"> ''</span> (line <span class="line-number">78</span>)

724

</span>

725

</div>

726

727

728

<p class="short-description">Holds the most recent mailer error message.</p>

729

730

<li><span class="field">access:</span> public</li>

731

</ul>

732

733

734

735

736

737

</div>

738

739

740

741

742

743

<span class="var-type">string</span>

744

745

= <span class="var-default"> ''</span> (line <span class="line-number">84</span>)

746

</span>

747

</div>

748

749

750

<p class="short-description">Sets the From email address for the message.</p>

751

752

<li><span class="field">access:</span> public</li>

753

</ul>

754

755

756

757

758

759

</div>

760

761

762

763

764

765

<span class="var-type">string</span>

766

<span class="var-name">$FromName</span>

767

= <span class="var-default"> ''</span> (line <span class="line-number">90</span>)

768

</span>

769

</div>

770

771

772

<p class="short-description">Sets the From name of the message.</p>

773

774

<li><span class="field">access:</span> public</li>

775

</ul>

776

777

778

779

780

781

</div>

782

783

784

785

786

787

<span class="var-type">string</span>

788

789

= <span class="var-default"> ''</span> (line <span class="line-number">192</span>)

790

</span>

791

</div>

792

793

794

<p class="short-description">Sets the SMTP HELO of the message (Default is $Hostname).</p>

795

796

<li><span class="field">access:</span> public</li>

797

</ul>

798

799

800

801

802

803

</div>

804

805

806

807

808

809

<span class="var-type">string</span>

810

811

= <span class="var-default"> 'localhost'</span> (line <span class="line-number">180</span>)

812

</span>

813

</div>

814

815

816

<p class="short-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").</p>

817

<p class="description"><p>Hosts will be tried in order.</p></p>

818

819

<li><span class="field">access:</span> public</li>

820

</ul>

821

822

823

824

825

826

</div>

827

828

829

830

831

832

<span class="var-type">string</span>

833

<span class="var-name">$Hostname</span>

834

= <span class="var-default"> ''</span> (line <span class="line-number">159</span>)

835

</span>

836

</div>

837

838

839

<p class="short-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'.</p>

840

841

<li><span class="field">access:</span> public</li>

842

</ul>

843

844

845

846

847

848

</div>

849

850

851

852

853

854

<span class="var-type">mixed</span>

855

<span class="var-name">$language</span>

856

= <span class="var-default">array()</span> (line <span class="line-number">273</span>)

857

</span>

858

</div>

859

860

861

862

<li><span class="field">access:</span> protected</li>

863

</ul>

864

865

866

867

868

869

</div>

870

871

872

873

874

875

<span class="var-type">string</span>

876

877

= <span class="var-default"> "\n"</span> (line <span class="line-number">251</span>)

878

</span>

879

</div>

880

881

882

<p class="short-description">Provides the ability to change the line ending</p>

883

884

<li><span class="field">access:</span> public</li>

885

</ul>

886

887

888

889

890

891

</div>

892

893

894

895

896

897

<span class="var-type">string</span>

898

<span class="var-name">$Mailer</span>

899

= <span class="var-default"> 'mail'</span> (line <span class="line-number">132</span>)

900

</span>

901

</div>

902

903

904

<p class="short-description">Method to send mail: ("mail", "sendmail", or "smtp").</p>

905

906

<li><span class="field">access:</span> public</li>

907

</ul>

908

909

910

911

912

913

</div>

914

915

916

917

918

919

<span class="var-type">string</span>

920

<span class="var-name">$MessageID</span>

921

= <span class="var-default"> ''</span> (line <span class="line-number">166</span>)

922

</span>

923

</div>

924

925

926

<p class="short-description">Sets the message ID to be used in the Message-Id header.</p>

927

<p class="description"><p>If empty, a unique id will be generated.</p></p>

928

929

<li><span class="field">access:</span> public</li>

930

</ul>

931

932

933

934

935

936

</div>

937

938

939

940

941

942

<span class="var-type">string</span>

943

<span class="var-name">$Password</span>

944

= <span class="var-default"> ''</span> (line <span class="line-number">217</span>)

945

</span>

946

</div>

947

948

949

<p class="short-description">Sets SMTP password.</p>

950

951

<li><span class="field">access:</span> public</li>

952

</ul>

953

954

955

956

957

958

</div>

959

960

961

962

963

964

<span class="var-type">string</span>

965

<span class="var-name">$PluginDir</span>

966

= <span class="var-default"> ''</span> (line <span class="line-number">145</span>)

967

</span>

968

</div>

969

970

971

<p class="short-description">Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.</p>

972

973

<li><span class="field">access:</span> public</li>

974

</ul>

975

976

977

978

979

980

</div>

981

982

983

984

985

986

987

988

= <span class="var-default"> 25</span> (line <span class="line-number">186</span>)

989

</span>

990

</div>

991

992

993

<p class="short-description">Sets the default SMTP server port.</p>

994

995

<li><span class="field">access:</span> public</li>

996

</ul>

997

998

999

1000

1001

1002

</div>

1003

1004

1005

1006

1007

1008

1009

<span class="var-name">$Priority</span>

1010

= <span class="var-default"> 3</span> (line <span class="line-number">53</span>)

1011

</span>

1012

</div>

1013

1014

1015

<p class="short-description">Email priority (1 = High, 3 = Normal, 5 = low).</p>

1016

1017

<li><span class="field">access:</span> public</li>

1018

</ul>

1019

1020

1021

1022

1023

1024

</div>

1025

1026

1027

1028

1029

1030

<span class="var-type">string</span>

1031

<span class="var-name">$Sender</span>

1032

= <span class="var-default"> ''</span> (line <span class="line-number">97</span>)

1033

</span>

1034

</div>

1035

1036

1037

<p class="short-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.</p>

1038

1039

<li><span class="field">access:</span> public</li>

1040

</ul>

1041

1042

1043

1044

1045

1046

</div>

1047

1048

1049

1050

1051

1052

<span class="var-type">string</span>

1053

<span class="var-name">$Sendmail</span>

1054

= <span class="var-default"> '/usr/sbin/sendmail'</span> (line <span class="line-number">138</span>)

1055

</span>

1056

</div>

1057

1058

1059

<p class="short-description">Sets the path of the sendmail program.</p>

1060

1061

<li><span class="field">access:</span> public</li>

1062

</ul>

1063

1064

1065

1066

1067

1068

</div>

1069

1070

1071

1072

1073

1074

1075

<span class="var-name">$SingleTo</span>

1076

= <span class="var-default"> false</span> (line <span class="line-number">245</span>)

1077

</span>

1078

</div>

1079

1080

1081

<p class="short-description">Provides the ability to have the TO field process individual</p>

1082

<p class="description"><p>emails, instead of sending to entire TO addresses</p></p>

1083

1084

<li><span class="field">access:</span> public</li>

1085

</ul>

1086

1087

1088

1089

1090

1091

</div>

1092

1093

1094

1095

1096

1097

1098

<span class="var-name">$SMTPAuth</span>

1099

= <span class="var-default"> false</span> (line <span class="line-number">205</span>)

1100

</span>

1101

</div>

1102

1103

1104

<p class="short-description">Sets SMTP authentication. Utilizes the Username and Password variables.</p>

1105

1106

<li><span class="field">access:</span> public</li>

1107

</ul>

1108

1109

1110

1111

1112

1113

</div>

1114

1115

1116

1117

1118

1119

1120

<span class="var-name">$SMTPDebug</span>

1121

= <span class="var-default"> false</span> (line <span class="line-number">230</span>)

1122

</span>

1123

</div>

1124

1125

1126

<p class="short-description">Sets SMTP class debugging on or off.</p>

1127

1128

<li><span class="field">access:</span> public</li>

1129

</ul>

1130

1131

1132

1133

1134

1135

</div>

1136

1137

1138

1139

1140

1141

1142

<span class="var-name">$SMTPKeepAlive</span>

1143

= <span class="var-default"> false</span> (line <span class="line-number">238</span>)

1144

</span>

1145

</div>

1146

1147

1148

<p class="short-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().</p>

1149

1150

<li><span class="field">access:</span> public</li>

1151

</ul>

1152

1153

1154

1155

1156

1157

</div>

1158

1159

1160

1161

1162

1163

<span class="var-type">string</span>

1164

<span class="var-name">$SMTPSecure</span>

1165

= <span class="var-default"> ''</span> (line <span class="line-number">199</span>)

1166

</span>

1167

</div>

1168

1169

1170

<p class="short-description">Sets connection prefix.</p>

1171

<p class="description"><p>Options are "", "ssl" or "tls"</p></p>

1172

1173

<li><span class="field">access:</span> public</li>

1174

</ul>

1175

1176

1177

1178

1179

1180

</div>

1181

1182

1183

1184

1185

1186

<span class="var-type">string</span>

1187

<span class="var-name">$Subject</span>

1188

= <span class="var-default"> ''</span> (line <span class="line-number">103</span>)

1189

</span>

1190

</div>

1191

1192

1193

<p class="short-description">Sets the Subject of the message.</p>

1194

1195

<li><span class="field">access:</span> public</li>

1196

</ul>

1197

1198

1199

1200

1201

1202

</div>

1203

1204

1205

1206

1207

1208

1209

<span class="var-name">$Timeout</span>

1210

= <span class="var-default"> 10</span> (line <span class="line-number">224</span>)

1211

</span>

1212

</div>

1213

1214

1215

<p class="short-description">Sets the SMTP server timeout in seconds.</p>

1216

<p class="description"><p>This function will not work with the win32 version.</p></p>

1217

1218

<li><span class="field">access:</span> public</li>

1219

</ul>

1220

1221

1222

1223

1224

1225

</div>

1226

1227

1228

1229

1230

1231

<span class="var-type">string</span>

1232

<span class="var-name">$Username</span>

1233

= <span class="var-default"> ''</span> (line <span class="line-number">211</span>)

1234

</span>

1235

</div>

1236

1237

1238

<p class="short-description">Sets SMTP username.</p>

1239

1240

<li><span class="field">access:</span> public</li>

1241

</ul>

1242

1243

1244

1245

1246

1247

</div>

1248

1249

1250

1251

1252

1253

<span class="var-type">string</span>

1254

<span class="var-name">$Version</span>

1255

= <span class="var-default"> '5.0.2'</span> (line <span class="line-number">257</span>)

1256

</span>

1257

</div>

1258

1259

1260

<p class="short-description">Sets the PHPMailer Version number</p>

1261

1262

<li><span class="field">access:</span> public</li>

1263

</ul>

1264

1265

1266

1267

1268

1269

</div>

1270

1271

1272

1273

1274

1275

1276

<span class="var-name">$WordWrap</span>

1277

= <span class="var-default"> 0</span> (line <span class="line-number">126</span>)

1278

</span>

1279

</div>

1280

1281

1282

<p class="short-description">Sets word wrapping on the body of the message to a given number of characters.</p>

1283

1284

<li><span class="field">access:</span> public</li>

1285

</ul>

1286

1287

1288

1289

1290

1291

</div>

1292

1293

</div>

1294

</div>

1295

1296

1297

1298

<div class="info-box-title">Methods</div>

1299

1300

<a href="#sec-description">Description</a> |

1301

<a href="#sec-descendents">Descendents</a> |

1302

<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

1303

<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)

1304

1305

<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

1306

1307

</div>

1308

1309

1310

1311

1312

1313

1314

<span class="method-title">static method RFCDate</span> (line <span class="line-number">1803</span>)

1315

</div>

1316

1317

1318

<p class="short-description">Returns the proper RFC 822 formatted date.</p>

1319

1320

<li><span class="field">access:</span> public</li>

1321

</ul>

1322

1323

1324

static

1325

<span class="method-result">string</span>

1326

1327

RFCDate

1328

</span>

1329

()

1330

</div>

1331

1332

1333

1334

</div>

1335

1336

1337

1338

1339

<span class="method-title">static method ValidateAddress</span> (line <span class="line-number">469</span>)

1340

</div>

1341

1342

1343

<p class="short-description">Check that a string looks roughly like an email address should</p>

1344

<p class="description"><p>Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822</p></p>

1345

1346

<li><span class="field">link:</span> <a href="http://www.hexillion.com/samples/#Regex">Original pattern found here</a></li>

1347

<li><span class="field">access:</span> public</li>

1348

</ul>

1349

1350

1351

static

1352

<span class="method-result">boolean</span>

1353

1354

ValidateAddress

1355

</span>

1356

(<span class="var-type">string</span> <span class="var-name">$address</span>)

1357

</div>

1358

1359

1360

<li>

1361

<span class="var-type">string</span>

1362

<span class="var-name">$address</span><span class="var-description">: The email address to check</span> </li>

1363

</ul>

1364

1365

1366

</div>

1367

1368

1369

1370

1371

<span class="method-title">static method _mime_types</span> (line <span class="line-number">1920</span>)

1372

</div>

1373

1374

1375

<p class="short-description">Gets the MIME type of the embedded or inline image</p>

1376

1377

<li><span class="field">return:</span> MIME type of ext</li>

1378

<li><span class="field">access:</span> public</li>

1379

</ul>

1380

1381

1382

static

1383

<span class="method-result">string</span>

1384

1385

_mime_types

1386

</span>

1387

([<span class="var-type">string</span> <span class="var-name">$ext</span> = <span class="var-default">''</span>])

1388

</div>

1389

1390

1391

<li>

1392

<span class="var-type">string</span>

1393

<span class="var-name">$ext</span><span class="var-description">: File extension</span> </li>

1394

</ul>

1395

1396

1397

</div>

1398

1399

1400

1401

1402

1403

<span class="method-title">Constructor __construct</span> (line <span class="line-number">296</span>)

1404

</div>

1405

1406

1407

<p class="short-description">Constructor</p>

1408

1409

<li><span class="field">access:</span> public</li>

1410

</ul>

1411

1412

1413

<span class="method-result">PHPMailer</span>

1414

1415

__construct

1416

</span>

1417

([<span class="var-type">boolean</span> <span class="var-name">$exceptions</span> = <span class="var-default">true</span>])

1418

</div>

1419

1420

1421

<li>

1422

<span class="var-type">boolean</span>

1423

<span class="var-name">$exceptions</span><span class="var-description">: Should we throw external exceptions?</span> </li>

1424

</ul>

1425

1426

1427

</div>

1428

1429

1430

1431

1432

<span class="method-title">AddAddress</span> (line <span class="line-number">361</span>)

1433

</div>

1434

1435

1436

<p class="short-description">Adds a "To" address.</p>

1437

1438

<li><span class="field">return:</span> true on success, false if address already used</li>

1439

<li><span class="field">access:</span> public</li>

1440

</ul>

1441

1442

1443

<span class="method-result">boolean</span>

1444

1445

AddAddress

1446

</span>

1447

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

1448

</div>

1449

1450

1451

<li>

1452

<span class="var-type">string</span>

1453

<span class="var-name">$address</span> </li>

1454

<li>

1455

<span class="var-type">string</span>

1456

1457

</ul>

1458

1459

1460

</div>

1461

1462

1463

1464

1465

<span class="method-title">AddAttachment</span> (line <span class="line-number">1223</span>)

1466

</div>

1467

1468

1469

<p class="short-description">Adds an attachment from a path on the filesystem.</p>

1470

<p class="description"><p>Returns false if the file could not be found or accessed.</p></p>

1471

1472

<li><span class="field">access:</span> public</li>

1473

</ul>

1474

1475

1476

1477

1478

AddAttachment

1479

</span>

1480

1481

</div>

1482

1483

1484

<li>

1485

<span class="var-type">string</span>

1486

<span class="var-name">$path</span><span class="var-description">: Path to the attachment.</span> </li>

1487

<li>

1488

<span class="var-type">string</span>

1489

<span class="var-name">$name</span><span class="var-description">: Overrides the attachment name.</span> </li>

1490

<li>

1491

<span class="var-type">string</span>

1492

<span class="var-name">$encoding</span><span class="var-description">: File encoding (see $Encoding).</span> </li>

1493

<li>

1494

<span class="var-type">string</span>

1495

<span class="var-name">$type</span><span class="var-description">: File extension (MIME) type.</span> </li>

1496

</ul>

1497

1498

1499

</div>

1500

1501

1502

1503

1504

<span class="method-title">AddBCC</span> (line <span class="line-number">383</span>)

1505

</div>

1506

1507

1508

<p class="short-description">Adds a "Bcc" address.</p>

1509

<p class="description"><p>Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</p></p>

1510

1511

<li><span class="field">return:</span> true on success, false if address already used</li>

1512

<li><span class="field">access:</span> public</li>

1513

</ul>

1514

1515

1516

<span class="method-result">boolean</span>

1517

1518

AddBCC

1519

</span>

1520

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

1521

</div>

1522

1523

1524

<li>

1525

<span class="var-type">string</span>

1526

<span class="var-name">$address</span> </li>

1527

<li>

1528

<span class="var-type">string</span>

1529

1530

</ul>

1531

1532

1533

</div>

1534

1535

1536

1537

1538

<span class="method-title">AddCC</span> (line <span class="line-number">372</span>)

1539

</div>

1540

1541

1542

<p class="short-description">Adds a "Cc" address.</p>

1543

<p class="description"><p>Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</p></p>

1544

1545

<li><span class="field">return:</span> true on success, false if address already used</li>

1546

<li><span class="field">access:</span> public</li>

1547

</ul>

1548

1549

1550

<span class="method-result">boolean</span>

1551

1552

AddCC

1553

</span>

1554

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

1555

</div>

1556

1557

1558

<li>

1559

<span class="var-type">string</span>

1560

<span class="var-name">$address</span> </li>

1561

<li>

1562

<span class="var-type">string</span>

1563

1564

</ul>

1565

1566

1567

</div>

1568

1569

1570

1571

1572

<span class="method-title">AddCustomHeader</span> (line <span class="line-number">1873</span>)

1573

</div>

1574

1575

1576

<p class="short-description">Adds a custom header.</p>

1577

1578

<li><span class="field">access:</span> public</li>

1579

</ul>

1580

1581

1582

1583

1584

AddCustomHeader

1585

</span>

1586

(<span class="var-type"></span> <span class="var-name">$custom_header</span>)

1587

</div>

1588

1589

1590

<li>

1591

1592

<span class="var-name">$custom_header</span> </li>

1593

</ul>

1594

1595

1596

</div>

1597

1598

1599

1600

1601

<span class="method-title">AddEmbeddedImage</span> (line <span class="line-number">1662</span>)

1602

</div>

1603

1604

1605

<p class="short-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".</p>

1606

1607

<li><span class="field">access:</span> public</li>

1608

</ul>

1609

1610

1611

1612

1613

AddEmbeddedImage

1614

</span>

1615

1616

</div>

1617

1618

1619

<li>

1620

<span class="var-type">string</span>

1621

<span class="var-name">$path</span><span class="var-description">: Path to the attachment.</span> </li>

1622

<li>

1623

<span class="var-type">string</span>

1624

<span class="var-name">$cid</span><span class="var-description">: Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.</span> </li>

1625

<li>

1626

<span class="var-type">string</span>

1627

<span class="var-name">$name</span><span class="var-description">: Overrides the attachment name.</span> </li>

1628

<li>

1629

<span class="var-type">string</span>

1630

<span class="var-name">$encoding</span><span class="var-description">: File encoding (see $Encoding).</span> </li>

1631

<li>

1632

<span class="var-type">string</span>

1633

<span class="var-name">$type</span><span class="var-description">: File extension (MIME) type.</span> </li>

1634

</ul>

1635

1636

1637

</div>

1638

1639

1640

1641

1642

<span class="method-title">AddrAppend</span> (line <span class="line-number">782</span>)

1643

</div>

1644

1645

1646

<p class="short-description">Creates recipient headers.</p>

1647

1648

<li><span class="field">access:</span> public</li>

1649

</ul>

1650

1651

1652

<span class="method-result">string</span>

1653

1654

AddrAppend

1655

</span>

1656

(<span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$addr</span>)

1657

</div>

1658

1659

1660

<li>

1661

1662

1663

<li>

1664

1665

1666

</ul>

1667

1668

1669

</div>

1670

1671

1672

1673

1674

<span class="method-title">AddReplyTo</span> (line <span class="line-number">393</span>)

1675

</div>

1676

1677

1678

<p class="short-description">Adds a "Reply-to" address.</p>

1679

1680

<li><span class="field">access:</span> public</li>

1681

</ul>

1682

1683

1684

<span class="method-result">boolean</span>

1685

1686

AddReplyTo

1687

</span>

1688

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

1689

</div>

1690

1691

1692

<li>

1693

<span class="var-type">string</span>

1694

<span class="var-name">$address</span> </li>

1695

<li>

1696

<span class="var-type">string</span>

1697

1698

</ul>

1699

1700

1701

</div>

1702

1703

1704

1705

1706

<span class="method-title">AddrFormat</span> (line <span class="line-number">799</span>)

1707

</div>

1708

1709

1710

<p class="short-description">Formats an address correctly.</p>

1711

1712

<li><span class="field">access:</span> public</li>

1713

</ul>

1714

1715

1716

<span class="method-result">string</span>

1717

1718

AddrFormat

1719

</span>

1720

(<span class="var-type"></span> <span class="var-name">$addr</span>)

1721

</div>

1722

1723

1724

<li>

1725

1726

1727

</ul>

1728

1729

1730

</div>

1731

1732

1733

1734

1735

<span class="method-title">AddStringAttachment</span> (line <span class="line-number">1635</span>)

1736

</div>

1737

1738

1739

<p class="short-description">Adds a string or binary attachment (non-filesystem) to the list.</p>

1740

<p class="description"><p>This method can be used to attach ascii or binary data, such as a BLOB record from a database.</p></p>

1741

1742

<li><span class="field">access:</span> public</li>

1743

</ul>

1744

1745

1746

1747

1748

AddStringAttachment

1749

</span>

1750

1751

</div>

1752

1753

1754

<li>

1755

<span class="var-type">string</span>

1756

<span class="var-name">$string</span><span class="var-description">: String attachment data.</span> </li>

1757

<li>

1758

<span class="var-type">string</span>

1759

<span class="var-name">$filename</span><span class="var-description">: Name of the attachment.</span> </li>

1760

<li>

1761

<span class="var-type">string</span>

1762

<span class="var-name">$encoding</span><span class="var-description">: File encoding (see $Encoding).</span> </li>

1763

<li>

1764

<span class="var-type">string</span>

1765

<span class="var-name">$type</span><span class="var-description">: File extension (MIME) type.</span> </li>

1766

</ul>

1767

1768

1769

</div>

1770

1771

1772

1773

1774

<span class="method-title">Base64EncodeWrapMB</span> (line <span class="line-number">1478</span>)

1775

</div>

1776

1777

1778

<p class="short-description">Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.</p>

1779

<p class="description"><p>Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php</p></p>

1780

1781

<li><span class="field">access:</span> public</li>

1782

</ul>

1783

1784

1785

<span class="method-result">string</span>

1786

1787

Base64EncodeWrapMB

1788

</span>

1789

(<span class="var-type">string</span> <span class="var-name">$str</span>)

1790

</div>

1791

1792

1793

<li>

1794

<span class="var-type">string</span>

1795

<span class="var-name">$str</span><span class="var-description">: multi-byte text to wrap encode</span> </li>

1796

</ul>

1797

1798

1799

</div>

1800

1801

1802

1803

1804

<span class="method-title">ClearAddresses</span> (line <span class="line-number">1711</span>)

1805

</div>

1806

1807

1808

<p class="short-description">Clears all recipients assigned in the TO array. Returns void.</p>

1809

1810

<li><span class="field">access:</span> public</li>

1811

</ul>

1812

1813

1814

1815

1816

ClearAddresses

1817

</span>

1818

()

1819

</div>

1820

1821

1822

1823

</div>

1824

1825

1826

1827

1828

<span class="method-title">ClearAllRecipients</span> (line <span class="line-number">1753</span>)

1829

</div>

1830

1831

1832

<p class="short-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</p>

1833

1834

<li><span class="field">access:</span> public</li>

1835

</ul>

1836

1837

1838

1839

1840

ClearAllRecipients

1841

</span>

1842

()

1843

</div>

1844

1845

1846

1847

</div>

1848

1849

1850

1851

1852

<span class="method-title">ClearAttachments</span> (line <span class="line-number">1765</span>)

1853

</div>

1854

1855

1856

<p class="short-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</p>

1857

1858

<li><span class="field">access:</span> public</li>

1859

</ul>

1860

1861

1862

1863

1864

ClearAttachments

1865

</span>

1866

()

1867

</div>

1868

1869

1870

1871

</div>

1872

1873

1874

1875

1876

<span class="method-title">ClearBCCs</span> (line <span class="line-number">1733</span>)

1877

</div>

1878

1879

1880

<p class="short-description">Clears all recipients assigned in the BCC array. Returns void.</p>

1881

1882

<li><span class="field">access:</span> public</li>

1883

</ul>

1884

1885

1886

1887

1888

ClearBCCs

1889

</span>

1890

()

1891

</div>

1892

1893

1894

1895

</div>

1896

1897

1898

1899

1900

<span class="method-title">ClearCCs</span> (line <span class="line-number">1722</span>)

1901

</div>

1902

1903

1904

<p class="short-description">Clears all recipients assigned in the CC array. Returns void.</p>

1905

1906

<li><span class="field">access:</span> public</li>

1907

</ul>

1908

1909

1910

1911

1912

ClearCCs

1913

</span>

1914

()

1915

</div>

1916

1917

1918

1919

</div>

1920

1921

1922

1923

1924

<span class="method-title">ClearCustomHeaders</span> (line <span class="line-number">1773</span>)

1925

</div>

1926

1927

1928

<p class="short-description">Clears all custom headers. Returns void.</p>

1929

1930

<li><span class="field">access:</span> public</li>

1931

</ul>

1932

1933

1934

1935

1936

ClearCustomHeaders

1937

</span>

1938

()

1939

</div>

1940

1941

1942

1943

</div>

1944

1945

1946

1947

1948

<span class="method-title">ClearReplyTos</span> (line <span class="line-number">1744</span>)

1949

</div>

1950

1951

1952

<p class="short-description">Clears all recipients assigned in the ReplyTo array. Returns void.</p>

1953

1954

<li><span class="field">access:</span> public</li>

1955

</ul>

1956

1957

1958

1959

1960

ClearReplyTos

1961

</span>

1962

()

1963

</div>

1964

1965

1966

1967

</div>

1968

1969

1970

1971

1972

<span class="method-title">CreateBody</span> (line <span class="line-number">1069</span>)

1973

</div>

1974

1975

1976

<p class="short-description">Assembles the message body. Returns an empty string on failure.</p>

1977

1978

<li><span class="field">return:</span> The assembled message body</li>

1979

<li><span class="field">access:</span> public</li>

1980

</ul>

1981

1982

1983

<span class="method-result">string</span>

1984

1985

CreateBody

1986

</span>

1987

()

1988

</div>

1989

1990

1991

1992

</div>

1993

1994

1995

1996

1997

<span class="method-title">CreateHeader</span> (line <span class="line-number">958</span>)

1998

</div>

1999

2000

2001

<p class="short-description">Assembles message header.</p>

2002

2003

<li><span class="field">return:</span> The assembled header</li>

2004

<li><span class="field">access:</span> public</li>

2005

</ul>

2006

2007

2008

<span class="method-result">string</span>

2009

2010

CreateHeader

2011

</span>

2012

()

2013

</div>

2014

2015

2016

2017

</div>

2018

2019

2020

2021

2022

<span class="method-title">EncodeHeader</span> (line <span class="line-number">1401</span>)

2023

</div>

2024

2025

2026

<p class="short-description">Encode a header string to best (shortest) of Q, B, quoted or none.</p>

2027

2028

<li><span class="field">access:</span> public</li>

2029

</ul>

2030

2031

2032

<span class="method-result">string</span>

2033

2034

EncodeHeader

2035

</span>

2036

(<span class="var-type"></span> <span class="var-name">$str</span>, [<span class="var-type"></span> <span class="var-name">$position</span> = <span class="var-default">'text'</span>])

2037

</div>

2038

2039

2040

<li>

2041

2042

2043

<li>

2044

2045

<span class="var-name">$position</span> </li>

2046

</ul>

2047

2048

2049

</div>

2050

2051

2052

2053

2054

<span class="method-title">EncodeQ</span> (line <span class="line-number">1600</span>)

2055

</div>

2056

2057

2058

<p class="short-description">Encode string to q encoding.</p>

2059

2060

<li><span class="field">link:</span> <a href="http://tools.ietf.org/html/rfc2047">http://tools.ietf.org/html/rfc2047</a></li>

2061

<li><span class="field">access:</span> public</li>

2062

</ul>

2063

2064

2065

<span class="method-result">string</span>

2066

2067

EncodeQ

2068

</span>

2069

(<span class="var-type">string</span> <span class="var-name">$str</span>, [<span class="var-type">string</span> <span class="var-name">$position</span> = <span class="var-default">'text'</span>])

2070

</div>

2071

2072

2073

<li>

2074

<span class="var-type">string</span>

2075

<span class="var-name">$str</span><span class="var-description">: the text to encode</span> </li>

2076

<li>

2077

<span class="var-type">string</span>

2078

<span class="var-name">$position</span><span class="var-description">: Where the text is going to be used, see the RFC for what that means</span> </li>

2079

</ul>

2080

2081

2082

</div>

2083

2084

2085

2086

2087

<span class="method-title">EncodeQP</span> (line <span class="line-number">1571</span>)

2088

</div>

2089

2090

2091

<p class="short-description">Encode string to RFC2045 (6.7) quoted-printable format</p>

2092

<p class="description"><p>Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding</p></p>

2093

2094

<li><span class="field">author:</span> Marcus Bointon</li>

2095

<li><span class="field">see:</span> <a href="../PHPMailer/PHPMailer.html#methodEncodeQPphp">PHPMailer::EncodeQPphp()</a></li>

2096

<li><span class="field">access:</span> public</li>

2097

</ul>

2098

2099

2100

<span class="method-result">string</span>

2101

2102

EncodeQP

2103

</span>

2104

2105

</div>

2106

2107

2108

<li>

2109

<span class="var-type">string</span>

2110

<span class="var-name">$string</span><span class="var-description">: the text to encode</span> </li>

2111

<li>

2112

<span class="var-type">integer</span>

2113

<span class="var-name">$line_max</span><span class="var-description">: Number of chars allowed on a line before wrapping</span> </li>

2114

<li>

2115

<span class="var-type">boolean</span>

2116

<span class="var-name">$space_conv</span><span class="var-description">: Dummy param for compatibility with existing EncodeQP function</span> </li>

2117

</ul>

2118

2119

2120

</div>

2121

2122

2123

2124

2125

<span class="method-title">EncodeQPphp</span> (line <span class="line-number">1518</span>)

2126

</div>

2127

2128

2129

<p class="short-description">Encode string to quoted-printable.</p>

2130

<p class="description"><p>Only uses standard PHP, slow, but will always work</p></p>

2131

2132

<li><span class="field">access:</span> public</li>

2133

</ul>

2134

2135

2136

<span class="method-result">string</span>

2137

2138

EncodeQPphp

2139

</span>

2140

2141

</div>

2142

2143

2144

<li>

2145

<span class="var-type">string</span>

2146

<span class="var-name">$string</span><span class="var-description">: the text to encode</span> </li>

2147

<li>

2148

<span class="var-type">integer</span>

2149

<span class="var-name">$line_max</span><span class="var-description">: Number of chars allowed on a line before wrapping</span> </li>

2150

<li>

2151

2152

<span class="var-name">$input</span> </li>

2153

<li>

2154

2155

<span class="var-name">$space_conv</span> </li>

2156

</ul>

2157

2158

2159

</div>

2160

2161

2162

2163

2164

<span class="method-title">EncodeString</span> (line <span class="line-number">1370</span>)

2165

</div>

2166

2167

2168

<p class="short-description">Encodes string to requested format.</p>

2169

<p class="description"><p>Returns an empty string on failure.</p></p>

2170

2171

<li><span class="field">access:</span> public</li>

2172

</ul>

2173

2174

2175

<span class="method-result">string</span>

2176

2177

EncodeString

2178

</span>

2179

(<span class="var-type">string</span> <span class="var-name">$str</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">'base64'</span>])

2180

</div>

2181

2182

2183

<li>

2184

<span class="var-type">string</span>

2185

<span class="var-name">$str</span><span class="var-description">: The text to encode</span> </li>

2186

<li>

2187

<span class="var-type">string</span>

2188

<span class="var-name">$encoding</span><span class="var-description">: The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'</span> </li>

2189

</ul>

2190

2191

2192

</div>

2193

2194

2195

2196

2197

<span class="method-title">GetAttachments</span> (line <span class="line-number">1261</span>)

2198

</div>

2199

2200

2201

<p class="short-description">Return the current array of attachments</p>

2202

2203

<li><span class="field">access:</span> public</li>

2204

</ul>

2205

2206

2207

<span class="method-result">array</span>

2208

2209

GetAttachments

2210

</span>

2211

()

2212

</div>

2213

2214

2215

2216

</div>

2217

2218

2219

2220

2221

<span class="method-title">GetMailMIME</span> (line <span class="line-number">1035</span>)

2222

</div>

2223

2224

2225

<p class="short-description">Returns the message MIME.</p>

2226

2227

<li><span class="field">access:</span> public</li>

2228

</ul>

2229

2230

2231

<span class="method-result">string</span>

2232

2233

GetMailMIME

2234

</span>

2235

()

2236

</div>

2237

2238

2239

2240

</div>

2241

2242

2243

2244

2245

<span class="method-title">GetTranslations</span> (line <span class="line-number">769</span>)

2246

</div>

2247

2248

2249

<p class="short-description">Return the current array of language strings</p>

2250

2251

<li><span class="field">access:</span> public</li>

2252

</ul>

2253

2254

2255

<span class="method-result">array</span>

2256

2257

GetTranslations

2258

</span>

2259

()

2260

</div>

2261

2262

2263

2264

</div>

2265

2266

2267

2268

2269

<span class="method-title">HasMultiBytes</span> (line <span class="line-number">1462</span>)

2270

</div>

2271

2272

2273

<p class="short-description">Checks if a string contains multibyte characters.</p>

2274

2275

<li><span class="field">access:</span> public</li>

2276

</ul>

2277

2278

2279

2280

2281

HasMultiBytes

2282

</span>

2283

(<span class="var-type">string</span> <span class="var-name">$str</span>)

2284

</div>

2285

2286

2287

<li>

2288

<span class="var-type">string</span>

2289

<span class="var-name">$str</span><span class="var-description">: multi-byte text to wrap encode</span> </li>

2290

</ul>

2291

2292

2293

</div>

2294

2295

2296

2297

2298

<span class="method-title">HeaderLine</span> (line <span class="line-number">1196</span>)

2299

</div>

2300

2301

2302

<p class="short-description">Returns a formatted header line.</p>

2303

2304

<li><span class="field">access:</span> public</li>

2305

</ul>

2306

2307

2308

<span class="method-result">string</span>

2309

2310

HeaderLine

2311

</span>

2312

(<span class="var-type"></span> <span class="var-name">$name</span>, <span class="var-type"></span> <span class="var-name">$value</span>)

2313

</div>

2314

2315

2316

<li>

2317

2318

2319

<li>

2320

2321

<span class="var-name">$value</span> </li>

2322

</ul>

2323

2324

2325

</div>

2326

2327

2328

2329

2330

<span class="method-title">InlineImageExists</span> (line <span class="line-number">1694</span>)

2331

</div>

2332

2333

2334

<p class="short-description">Returns true if an inline attachment is present.</p>

2335

2336

<li><span class="field">access:</span> public</li>

2337

</ul>

2338

2339

2340

2341

2342

InlineImageExists

2343

</span>

2344

()

2345

</div>

2346

2347

2348

2349

</div>

2350

2351

2352

2353

2354

<span class="method-title">IsError</span> (line <span class="line-number">1852</span>)

2355

</div>

2356

2357

2358

<p class="short-description">Returns true if an error occurred.</p>

2359

2360

<li><span class="field">access:</span> public</li>

2361

</ul>

2362

2363

2364

2365

2366

IsError

2367

</span>

2368

()

2369

</div>

2370

2371

2372

2373

</div>

2374

2375

2376

2377

2378

<span class="method-title">IsHTML</span> (line <span class="line-number">305</span>)

2379

</div>

2380

2381

2382

<p class="short-description">Sets message type to HTML.</p>

2383

2384

<li><span class="field">access:</span> public</li>

2385

</ul>

2386

2387

2388

2389

2390

IsHTML

2391

</span>

2392

([<span class="var-type">bool</span> <span class="var-name">$ishtml</span> = <span class="var-default">true</span>])

2393

</div>

2394

2395

2396

<li>

2397

2398

<span class="var-name">$ishtml</span> </li>

2399

</ul>

2400

2401

2402

</div>

2403

2404

2405

2406

2407

<span class="method-title">IsMail</span> (line <span class="line-number">325</span>)

2408

</div>

2409

2410

2411

<p class="short-description">Sets Mailer to send message using PHP mail() function.</p>

2412

2413

<li><span class="field">access:</span> public</li>

2414

</ul>

2415

2416

2417

2418

2419

IsMail

2420

</span>

2421

()

2422

</div>

2423

2424

2425

2426

</div>

2427

2428

2429

2430

2431

<span class="method-title">IsQmail</span> (line <span class="line-number">344</span>)

2432

</div>

2433

2434

2435

<p class="short-description">Sets Mailer to send message using the qmail MTA.</p>

2436

2437

<li><span class="field">access:</span> public</li>

2438

</ul>

2439

2440

2441

2442

2443

IsQmail

2444

</span>

2445

()

2446

</div>

2447

2448

2449

2450

</div>

2451

2452

2453

2454

2455

<span class="method-title">IsSendmail</span> (line <span class="line-number">333</span>)

2456

</div>

2457

2458

2459

<p class="short-description">Sets Mailer to send message using the $Sendmail program.</p>

2460

2461

<li><span class="field">access:</span> public</li>

2462

</ul>

2463

2464

2465

2466

2467

IsSendmail

2468

</span>

2469

()

2470

</div>

2471

2472

2473

2474

</div>

2475

2476

2477

2478

2479

<span class="method-title">IsSMTP</span> (line <span class="line-number">317</span>)

2480

</div>

2481

2482

2483

<p class="short-description">Sets Mailer to send message using SMTP.</p>

2484

2485

<li><span class="field">access:</span> public</li>

2486

</ul>

2487

2488

2489

2490

2491

IsSMTP

2492

</span>

2493

()

2494

</div>

2495

2496

2497

2498

</div>

2499

2500

2501

2502

2503

<span class="method-title">MailSend</span> (line <span class="line-number">564</span>)

2504

</div>

2505

2506

2507

<p class="short-description">Sends mail using the PHP mail() function.</p>

2508

2509

<li><span class="field">access:</span> protected</li>

2510

</ul>

2511

2512

2513

2514

2515

MailSend

2516

</span>

2517

(<span class="var-type">string</span> <span class="var-name">$header</span>, <span class="var-type">string</span> <span class="var-name">$body</span>)

2518

</div>

2519

2520

2521

<li>

2522

<span class="var-type">string</span>

2523

<span class="var-name">$header</span><span class="var-description">: The message headers</span> </li>

2524

<li>

2525

<span class="var-type">string</span>

2526

<span class="var-name">$body</span><span class="var-description">: The message body</span> </li>

2527

</ul>

2528

2529

2530

</div>

2531

2532

2533

2534

2535

<span class="method-title">MsgHTML</span> (line <span class="line-number">1882</span>)

2536

</div>

2537

2538

2539

<p class="short-description">Evaluates the message and returns modifications for inline images and backgrounds</p>

2540

2541

<li><span class="field">access:</span> public</li>

2542

</ul>

2543

2544

2545

<span class="method-result">$message</span>

2546

2547

MsgHTML

2548

</span>

2549

(<span class="var-type"></span> <span class="var-name">$message</span>, [<span class="var-type"></span> <span class="var-name">$basedir</span> = <span class="var-default">''</span>])

2550

</div>

2551

2552

2553

<li>

2554

2555

<span class="var-name">$message</span> </li>

2556

<li>

2557

2558

<span class="var-name">$basedir</span> </li>

2559

</ul>

2560

2561

2562

</div>

2563

2564

2565

2566

2567

<span class="method-title">SecureHeader</span> (line <span class="line-number">2047</span>)

2568

</div>

2569

2570

2571

<p class="short-description">Strips newlines to prevent header injection.</p>

2572

2573

<li><span class="field">access:</span> public</li>

2574

</ul>

2575

2576

2577

<span class="method-result">string</span>

2578

2579

SecureHeader

2580

</span>

2581

(<span class="var-type">string</span> <span class="var-name">$str</span>)

2582

</div>

2583

2584

2585

<li>

2586

<span class="var-type">string</span>

2587

<span class="var-name">$str</span><span class="var-description">: String</span> </li>

2588

</ul>

2589

2590

2591

</div>

2592

2593

2594

2595

2596

<span class="method-title">Send</span> (line <span class="line-number">491</span>)

2597

</div>

2598

2599

2600

<p class="short-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.</p>

2601

2602

<li><span class="field">access:</span> public</li>

2603

</ul>

2604

2605

2606

2607

2608

Send

2609

</span>

2610

()

2611

</div>

2612

2613

2614

2615

</div>

2616

2617

2618

2619

2620

<span class="method-title">SendmailSend</span> (line <span class="line-number">539</span>)

2621

</div>

2622

2623

2624

<p class="short-description">Sends mail using the $Sendmail program.</p>

2625

2626

<li><span class="field">access:</span> protected</li>

2627

</ul>

2628

2629

2630

2631

2632

SendmailSend

2633

</span>

2634

(<span class="var-type">string</span> <span class="var-name">$header</span>, <span class="var-type">string</span> <span class="var-name">$body</span>)

2635

</div>

2636

2637

2638

<li>

2639

<span class="var-type">string</span>

2640

<span class="var-name">$header</span><span class="var-description">: The message headers</span> </li>

2641

<li>

2642

<span class="var-type">string</span>

2643

<span class="var-name">$body</span><span class="var-description">: The message body</span> </li>

2644

</ul>

2645

2646

2647

</div>

2648

2649

2650

2651

2652

<span class="method-title">set</span> (line <span class="line-number">2025</span>)

2653

</div>

2654

2655

2656

<p class="short-description">Set (or reset) Class Objects (variables)</p>

2657

<p class="description"><p>Usage Example: $page->set('X-Priority', '3');</p></p>

2658

2659

<li><span class="field">todo:</span> Should this not be using __set() magic function?</li>

2660

<li><span class="field">access:</span> public</li>

2661

</ul>

2662

2663

2664

2665

2666

set

2667

</span>

2668

(<span class="var-type">string</span> <span class="var-name">$name</span>, [<span class="var-type">mixed</span> <span class="var-name">$value</span> = <span class="var-default">''</span>])

2669

</div>

2670

2671

2672

<li>

2673

<span class="var-type">string</span>

2674

<span class="var-name">$name</span><span class="var-description">: Parameter Name</span> </li>

2675

<li>

2676

<span class="var-type">mixed</span>

2677

<span class="var-name">$value</span><span class="var-description">: Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset</span> </li>

2678

</ul>

2679

2680

2681

</div>

2682

2683

2684

2685

2686

<span class="method-title">SetError</span> (line <span class="line-number">1786</span>)

2687

</div>

2688

2689

2690

<p class="short-description">Adds the error message to the error container.</p>

2691

2692

<li><span class="field">access:</span> protected</li>

2693

</ul>

2694

2695

2696

2697

2698

SetError

2699

</span>

2700

(<span class="var-type"></span> <span class="var-name">$msg</span>)

2701

</div>

2702

2703

2704

<li>

2705

2706

2707

</ul>

2708

2709

2710

</div>

2711

2712

2713

2714

2715

<span class="method-title">SetFrom</span> (line <span class="line-number">442</span>)

2716

</div>

2717

2718

2719

<p class="short-description">Set the From and FromName properties</p>

2720

2721

<li><span class="field">access:</span> public</li>

2722

</ul>

2723

2724

2725

<span class="method-result">boolean</span>

2726

2727

SetFrom

2728

</span>

2729

(<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">''</span>])

2730

</div>

2731

2732

2733

<li>

2734

<span class="var-type">string</span>

2735

<span class="var-name">$address</span> </li>

2736

<li>

2737

<span class="var-type">string</span>

2738

2739

</ul>

2740

2741

2742

</div>

2743

2744

2745

2746

2747

<span class="method-title">SetLanguage</span> (line <span class="line-number">735</span>)

2748

</div>

2749

2750

2751

<p class="short-description">Sets the language for all class error messages.</p>

2752

<p class="description"><p>Returns false if it cannot load the language file. The default language is English.</p></p>

2753

2754

<li><span class="field">access:</span> public</li>

2755

</ul>

2756

2757

2758

2759

2760

SetLanguage

2761

</span>

2762

2763

</div>

2764

2765

2766

<li>

2767

<span class="var-type">string</span>

2768

<span class="var-name">$langcode</span><span class="var-description">: ISO 639-1 2-character language code (e.g. Portuguese: "br")</span> </li>

2769

<li>

2770

<span class="var-type">string</span>

2771

<span class="var-name">$lang_path</span><span class="var-description">: Path to the language file directory</span> </li>

2772

</ul>

2773

2774

2775

</div>

2776

2777

2778

2779

2780

<span class="method-title">SetWordWrap</span> (line <span class="line-number">937</span>)

2781

</div>

2782

2783

2784

<p class="short-description">Set the body wrapping.</p>

2785

2786

<li><span class="field">access:</span> public</li>

2787

</ul>

2788

2789

2790

2791

2792

SetWordWrap

2793

</span>

2794

()

2795

</div>

2796

2797

2798

2799

</div>

2800

2801

2802

2803

2804

<span class="method-title">Sign</span> (line <span class="line-number">2060</span>)

2805

</div>

2806

2807

2808

<p class="short-description">Set the private key file and password to sign the message.</p>

2809

2810

<li><span class="field">access:</span> public</li>

2811

</ul>

2812

2813

2814

2815

2816

Sign

2817

</span>

2818

2819

</div>

2820

2821

2822

<li>

2823

<span class="var-type">string</span>

2824

<span class="var-name">$key_filename</span><span class="var-description">: Parameter File Name</span> </li>

2825

<li>

2826

<span class="var-type">string</span>

2827

<span class="var-name">$key_pass</span><span class="var-description">: Password for private key</span> </li>

2828

<li>

2829

2830

<span class="var-name">$cert_filename</span> </li>

2831

</ul>

2832

2833

2834

</div>

2835

2836

2837

2838

2839

<span class="method-title">SmtpClose</span> (line <span class="line-number">719</span>)

2840

</div>

2841

2842

2843

<p class="short-description">Closes the active SMTP session if one exists.</p>

2844

2845

<li><span class="field">access:</span> public</li>

2846

</ul>

2847

2848

2849

2850

2851

SmtpClose

2852

</span>

2853

()

2854

</div>

2855

2856

2857

2858

</div>

2859

2860

2861

2862

2863

<span class="method-title">SmtpConnect</span> (line <span class="line-number">657</span>)

2864

</div>

2865

2866

2867

<p class="short-description">Initiates a connection to an SMTP server.</p>

2868

<p class="description"><p>Returns false if the operation failed.</p></p>

2869

2870

<li><span class="field">access:</span> public</li>

2871

2872

</ul>

2873

2874

2875

2876

2877

SmtpConnect

2878

</span>

2879

()

2880

</div>

2881

2882

2883

2884

</div>

2885

2886

2887

2888

2889

<span class="method-title">SmtpSend</span> (line <span class="line-number">609</span>)

2890

</div>

2891

2892

2893

<p class="short-description">Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.</p>

2894

2895

<li><span class="field">access:</span> protected</li>

2896

2897

</ul>

2898

2899

2900

2901

2902

SmtpSend

2903

</span>

2904

(<span class="var-type">string</span> <span class="var-name">$header</span>, <span class="var-type">string</span> <span class="var-name">$body</span>)

2905

</div>

2906

2907

2908

<li>

2909

<span class="var-type">string</span>

2910

<span class="var-name">$header</span><span class="var-description">: The message headers</span> </li>

2911

<li>

2912

<span class="var-type">string</span>

2913

<span class="var-name">$body</span><span class="var-description">: The message body</span> </li>

2914

</ul>

2915

2916

2917

</div>

2918

2919

2920

2921

2922

<span class="method-title">TextLine</span> (line <span class="line-number">1205</span>)

2923

</div>

2924

2925

2926

<p class="short-description">Returns a formatted mail line.</p>

2927

2928

<li><span class="field">access:</span> public</li>

2929

</ul>

2930

2931

2932

<span class="method-result">string</span>

2933

2934

TextLine

2935

</span>

2936

(<span class="var-type"></span> <span class="var-name">$value</span>)

2937

</div>

2938

2939

2940

<li>

2941

2942

<span class="var-name">$value</span> </li>

2943

</ul>

2944

2945

2946

</div>

2947

2948

2949

2950

2951

<span class="method-title">UTF8CharBoundary</span> (line <span class="line-number">899</span>)

2952

</div>

2953

2954

2955

<p class="short-description">Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.</p>

2956

<p class="description"><p>Original written by Colin Brown.</p></p>

2957

2958

<li><span class="field">access:</span> public</li>

2959

</ul>

2960

2961

2962

2963

2964

UTF8CharBoundary

2965

</span>

2966

(<span class="var-type">string</span> <span class="var-name">$encodedText</span>, <span class="var-type">int</span> <span class="var-name">$maxLength</span>)

2967

</div>

2968

2969

2970

<li>

2971

<span class="var-type">string</span>

2972

<span class="var-name">$encodedText</span><span class="var-description">: utf-8 QP text</span> </li>

2973

<li>

2974

2975

<span class="var-name">$maxLength</span><span class="var-description">: find last character boundary prior to this length</span> </li>

2976

</ul>

2977

2978

2979

</div>

2980

2981

2982

2983

2984

<span class="method-title">WrapText</span> (line <span class="line-number">817</span>)

2985

</div>

2986

2987

2988

<p class="short-description">Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.</p>

2989

<p class="description"><p>Original written by philippe.</p></p>

2990

2991

<li><span class="field">access:</span> public</li>

2992

</ul>

2993

2994

2995

<span class="method-result">string</span>

2996

2997

WrapText

2998

</span>

2999

3000

</div>

3001

3002

3003

<li>

3004

<span class="var-type">string</span>

3005

<span class="var-name">$message</span><span class="var-description">: The message to wrap</span> </li>

3006

<li>

3007

<span class="var-type">integer</span>

3008

<span class="var-name">$length</span><span class="var-description">: The line length to wrap to</span> </li>

3009

<li>

3010

<span class="var-type">boolean</span>

3011

<span class="var-name">$qp_mode</span><span class="var-description">: Whether to run in Quoted-Printable mode</span> </li>

3012

</ul>

3013

3014

3015

</div>

3016

3017

</div>

3018

</div>

3019

3020

3021

3022

<div class="info-box-title">Class Constants</div>

3023

3024

<a href="#sec-description">Description</a> |

3025

<a href="#sec-descendents">Descendants</a> |

3026

<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)

3027

3028

3029

<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

3030

3031

<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

3032

3033

</div>

3034

3035

3036

3037

3038

3039

3040

3041

<span class="const-name">STOP_CONTINUE</span>

3042

= <span class="const-default"> 1</span>

3043

(line <span class="line-number">285</span>)

3044

</span>

3045

</div>

3046

3047

3048

3049

3050

</div>

3051

3052

3053

3054

3055

3056

3057

<span class="const-name">STOP_CRITICAL</span>

3058

= <span class="const-default"> 2</span>

3059

(line <span class="line-number">286</span>)

3060

</span>

3061

</div>

3062

3063

3064

3065

3066

</div>

3067

3068

3069

3070

3071

3072

3073

<span class="const-name">STOP_MESSAGE</span>

3074

= <span class="const-default"> 0</span>

3075

(line <span class="line-number">284</span>)

3076

</span>

3077

</div>

3078

3079

3080

3081

3082

</div>

3083

3084

</div>

3085

</div>

3086

3087

3088

Documentation generated on Tue, 09 Aug 2011 09:04:43 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>

3089

</p>

3090

</div></body>

3091

</html>

b'\\ No newline at end of file'

Older »