contenido\classes\class.phpmailer.php

Show:

inherited

Classes
- \PHPMailer

Table of Contents

Project: Contenido Content Management System

Description: PHP email class Class for sending email using either sendmail, PHP mail() or SMTP. Methods are based upon the standard AspEmail(tm) classes.

Requirements:

Author: Brent R. Matzelle
Con_php_req: 5.0
Copyright: Brent R. Matzelle
License: LGPL, see LICENSE
Package: Contenido Backend classes
Since: file available since contenido release <= 4.6 {@internal created 2001 modified 2006-07-30, HerrB, changes for contenido modified 2008-06-30, Frederic Schneider, add security fix modified 2009-11-06, Murat Purc, Workaround for invoking deprecated function in PHP 5.3 $Id: class.phpmailer.php 1094 2009-11-06 01:22:13Z xmurrix $: }}
Version: 1.0.1

\PHPMailer
jump to top

Package: PHPMailer

PHPMailer - PHP email transport class

Author: Brent R. Matzelle
Copyright: 2001 - 2003 Brent R. Matzelle

Properties

string $AltBody = ""

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.

Default value""Details

Type: string

string $Body = ""

Sets the Body of the message.

This can be either an HTML or text body. If HTML then run IsHTML(true).

Default value""Details

Type: string

string $CharSet = "iso-8859-1"

Sets the CharSet of the message.

Default value"iso-8859-1"Details

Type: string

string $ConfirmReadingTo = ""

Sets the email address that a reading confirmation will be sent.

Default value""Details

Type: string

string $ContentType = "text/plain"

Sets the Content-type of the message.

Default value"text/plain"Details

Type: string

$CustomHeader = array()

Default valuearray()Details

Type: n/a

string $Encoding = "8bit"

Sets the Encoding of the message.

Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".

Default value"8bit"Details

Type: string

string $ErrorInfo = ""

Holds the most recent mailer error message.

Default value""Details

Type: string

string $From = "root@localhost"

Sets the From email address for the message.

Default value"root@localhost"Details

Type: string

string $FromName = "Root User"

Sets the From name of the message.

Default value"Root User"Details

Type: string

$Helo = ""

Sets the SMTP HELO of the message (Default is $Hostname).

@var string

Default value""Details

Type: n/a

string $Host = "localhost"

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"). Hosts will be tried in order.

Default value"localhost"Details

Type: string

string $Hostname = ""

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'.

Default value""Details

Type: string

$LE = "\n"

Default value"\n"Details

Type: n/a

string $Mailer = "mail"

Method to send mail: ("mail", "sendmail", or "smtp").

Default value"mail"Details

Type: string

$Password = ""

Sets SMTP password.

@var string

Default value""Details

Type: n/a

string $PluginDir = ""

Path to PHPMailer plugins.

This is now only useful if the SMTP class is in a different directory than the PHP include path.

Default value""Details

Type: string

$Port = 25

Sets the default SMTP server port.

@var int

Default value25Details

Type: n/a

int $Priority = 3

Email priority (1 = High, 3 = Normal, 5 = low).

Default value3Details

Type: int

$ReplyTo = array()

Default valuearray()Details

Type: n/a

bool $SMTPAuth = false

Sets SMTP authentication.

Utilizes the Username and Password variables.

Default valuefalseDetails

Type: bool

$SMTPDebug = false

Sets SMTP class debugging on or off.

@var bool

Default valuefalseDetails

Type: n/a

bool $SMTPKeepAlive = false

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().

Default valuefalseDetails

Type: bool

string $Sender = ""

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.

Default value""Details

Type: string

string $Sendmail = "/usr/sbin/sendmail"

Sets the path of the sendmail program.

Default value"/usr/sbin/sendmail"Details

Type: string

string $Subject = ""

Sets the Subject of the message.

Default value""Details

Type: string

int $Timeout = 10

Sets the SMTP server timeout in seconds.

This function will not work with the win32 version.

Default value10Details

Type: int

$Username = ""

Sets SMTP username.

@var string

Default value""Details

Type: n/a

$Version = "1.73"

Holds PHPMailer version.

@var string

Default value"1.73"Details

Type: n/a

int $WordWrap = 0

Sets word wrapping on the body of the message to a given number of characters.

Default value0Details

Type: int

$attachment = array()

Default valuearray()Details

Type: n/a

$bcc = array()

Default valuearray()Details

Type: n/a

$boundary = array()

Default valuearray()Details

Type: n/a

$cc = array()

Default valuearray()Details

Type: n/a

$error_count = 0

Default value0Details

Type: n/a

$message_type = ""

Default value""Details

Type: n/a

$smtp = NULL

Default valueNULLDetails

Type: n/a

$to = array()

Default valuearray()Details

Type: n/a

Methods

AddAddress(string $address, string $name = "") : void

Adds a "To" address.

Parameters

Name	Type	Description
$address	string
$name	string

AddAttachment(string $path, string $name = "", string $encoding = "base64", string $type = "application/octet-stream") : bool

Adds an attachment from a path on the filesystem.

Returns false if the file could not be found or accessed.

Parameters

Name	Type	Description
$path	string	Path to the attachment.
$name	string	Overrides the attachment name.
$encoding	string	File encoding (see $Encoding).
$type	string	File extension (MIME) type.

Returns

Type	Description
bool

AddBCC(string $address, string $name = "") : void

Adds a "Bcc" address.

Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

Parameters

Name	Type	Description
$address	string
$name	string

AddCC(string $address, string $name = "") : void

Adds a "Cc" address.

Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

Parameters

Name	Type	Description
$address	string
$name	string

AddCustomHeader( $custom_header) : void

Adds a custom header.

Parameters

Name	Type	Description
$custom_header

AddEmbeddedImage(string $path, string $cid, string $name = "", string $encoding = "base64", string $type = "application/octet-stream") : bool

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".

Parameters

Name	Type	Description
$path	string	Path to the attachment.
$cid	string	Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
$name	string	Overrides the attachment name.
$encoding	string	File encoding (see $Encoding).
$type	string	File extension (MIME) type.

Returns

Type	Description
bool

AddReplyTo(string $address, string $name = "") : void

Adds a "Reply-to" address.

Parameters

Name	Type	Description
$address	string
$name	string

AddStringAttachment(string $string, string $filename, string $encoding = "base64", string $type = "application/octet-stream") : void

Adds a string or binary attachment (non-filesystem) to the list.

This method can be used to attach ascii or binary data, such as a BLOB record from a database.

Parameters

Name	Type	Description
$string	string	String attachment data.
$filename	string	Name of the attachment.
$encoding	string	File encoding (see $Encoding).
$type	string	File extension (MIME) type.

AddrAppend( $type, $addr) : string

Creates recipient headers.

Parameters

Name	Type	Description
$type
$addr

Returns

Type	Description
string

Details

Access: private

AddrFormat( $addr) : string

Formats an address correctly.

Parameters

Name	Type	Description
$addr

Returns

Type	Description
string

Details

Access: private

AttachAll() : string

Attaches all fs, string, and binary attachments to the message.

Returns an empty string on failure.

Returns

Type	Description
string

Details

Access: private

ClearAddresses() : void

Clears all recipients assigned in the TO array.

Returns void.

ClearAllRecipients() : void

Clears all recipients assigned in the TO, CC and BCC array.

Returns void.

ClearAttachments() : void

Clears all previously set filesystem, string, and binary attachments.

Returns void.

ClearBCCs() : void

Clears all recipients assigned in the BCC array.

Returns void.

ClearCCs() : void

Clears all recipients assigned in the CC array.

Returns void.

ClearCustomHeaders() : void

Clears all custom headers.

Returns void.

ClearReplyTos() : void

Clears all recipients assigned in the ReplyTo array.

Returns void.

CreateBody() : string

Assembles the message body.

Returns an empty string on failure.

Returns

Type	Description
string

Details

Access: private

CreateHeader() : string

Assembles message header.

Returns

Type	Description
string

Details

Access: private

EncodeFile( $path, $encoding = "base64") : string

Encodes attachment in requested format.

Returns an empty string on failure.

Parameters

Name	Type	Description
$path
$encoding

Returns

Type	Description
string

Details

Access: private

EncodeHeader( $str, $position = 'text') : string

Encode a header string to best of Q, B, quoted or none.

Parameters

Name	Type	Description
$str
$position

Returns

Type	Description
string

Details

Access: private

EncodeQ( $str, $position = "text") : string

Encode string to q encoding.

Parameters

Name	Type	Description
$str
$position

Returns

Type	Description
string

Details

Access: private

EncodeQP( $str) : string

Encode string to quoted-printable.

Parameters

Name	Type	Description
$str

Returns

Type	Description
string

Details

Access: private

EncodeString( $str, $encoding = "base64") : string

Encodes string to requested format.

Returns an empty string on failure.

Parameters

Name	Type	Description
$str
$encoding

Returns

Type	Description
string

Details

Access: private

EndBoundary( $boundary) : void

Returns the end of a message boundary.

Parameters

Name	Type	Description
$boundary

Details

Access: private

FixEOL( $str) : string

Changes every end of line from CR or LF to CRLF.

Parameters

Name	Type	Description
$str

Returns

Type	Description
string

Details

Access: private

GetBoundary( $boundary, $charSet, $contentType, $encoding) : void

Returns the start of a message boundary.

Parameters

Name	Type	Description
$boundary
$charSet
$contentType
$encoding

Details

Access: private

HeaderLine( $name, $value) : string

Returns a formatted header line.

Parameters

Name	Type	Description
$name
$value

Returns

Type	Description
string

Details

Access: private

InlineImageExists() : bool

Returns true if an inline attachment is present.

Returns

Type	Description
bool

Details

Access: private

IsError() : bool

Returns true if an error occurred.

Returns

Type	Description
bool

IsHTML(bool $bool) : void

Sets message type to HTML.

Parameters

Name	Type	Description
$bool	bool

IsMail() : void

Sets Mailer to send message using PHP mail() function.

IsQmail() : void

Sets Mailer to send message using the qmail MTA.

IsSMTP() : void

Sets Mailer to send message using SMTP.

IsSendmail() : void

Sets Mailer to send message using the $Sendmail program.

MailSend( $header, $body) : bool

Sends mail using the PHP mail() function.

Parameters

Name	Type	Description
$header
$body

Returns

Type	Description
bool

Details

Access: private

RFCDate() : string

Returns the proper RFC 822 formatted date.

Returns

Type	Description
string

Details

Access: private

Send() : bool

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.

Returns

Type	Description
bool

SendmailSend( $header, $body) : bool

Sends mail using the $Sendmail program.

Parameters

Name	Type	Description
$header
$body

Returns

Type	Description
bool

Details

Access: private

ServerHostname() : string

Returns the server hostname or 'localhost.localdomain' if unknown.

Returns

Type	Description
string

Details

Access: private

ServerVar( $varName) : mixed

Returns the appropriate server variable.

Should work with both PHP 4.1.0+ as well as older versions. Returns an empty string if nothing is found.

Parameters

Name	Type	Description
$varName

Returns

Type	Description
mixed

Details

Access: private

SetError( $msg) : void

Adds the error message to the error container.

Returns void.

Parameters

Name	Type	Description
$msg

Details

Access: private

SetMessageType() : void

Sets the message type.

Details

Access: private

SetWordWrap() : void

Set the body wrapping.

Details

Access: private

SmtpClose() : void

Closes the active SMTP session if one exists.

SmtpConnect() : bool

Initiates a connection to an SMTP server.

Returns false if the operation failed.

Returns

Type	Description
bool

Details

Access: private

SmtpSend( $header, $body) : bool

Sends mail via SMTP using PhpSMTP (Author: Chris Ryan).

Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.

Parameters

Name	Type	Description
$header
$body

Returns

Type	Description
bool

Details

Access: private

TextLine( $value) : string

Returns a formatted mail line.

Parameters

Name	Type	Description
$value

Returns

Type	Description
string

Details

Access: private

WrapText( $message, $length, $qp_mode = false) : string

Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.

Original written by philippe.

Parameters

Name	Type	Description
$message
$length
$qp_mode

Returns

Type	Description
string

Details

Access: private

contenido\classes\class.phpmailer.php

\PHPMailerjump to top

Properties

Methods

\PHPMailer
jump to top