Graphe d'héritage de PHPMailer:

Fonctions membres publiques

IsHTML ($bool)
IsSMTP ()
IsMail ()
IsSendmail ()
IsQmail ()
AddAddress ($address, $name= '')
AddCC ($address, $name= '')
AddBCC ($address, $name= '')
AddReplyTo ($address, $name= '')
Send ()
SendmailSend ($header, $body)
MailSend ($header, $body)
SmtpSend ($header, $body)
SmtpConnect ()
SmtpClose ()
SetLanguage ($lang_type, $lang_path= 'language/')
AddrAppend ($type, $addr)
AddrFormat ($addr)
WrapText ($message, $length, $qp_mode=false)
UTF8CharBoundary ($encodedText, $maxLength)
SetWordWrap ()
CreateHeader ()
GetMailMIME ()
CreateBody ()
GetBoundary ($boundary, $charSet, $contentType, $encoding)
EndBoundary ($boundary)
SetMessageType ()
HeaderLine ($name, $value)
TextLine ($value)
AddAttachment ($path, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
AttachAll ()
EncodeFile ($path, $encoding= 'base64')
EncodeString ($str, $encoding= 'base64')
EncodeHeader ($str, $position= 'text')
HasMultiBytes ($str)
Base64EncodeWrapMB ($str)
EncodeQP ($input= '', $line_max=76, $space_conv=false)
EncodeQ ($str, $position= 'text')
AddStringAttachment ($string, $filename, $encoding= 'base64', $type= 'application/octet-stream')
AddEmbeddedImage ($path, $cid, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
InlineImageExists ()
ClearAddresses ()
ClearCCs ()
ClearBCCs ()
ClearReplyTos ()
ClearAllRecipients ()
ClearAttachments ()
ClearCustomHeaders ()
SetError ($msg)
RFCDate ()
ServerVar ($varName)
ServerHostname ()
Lang ($key)
IsError ()
FixEOL ($str)
AddCustomHeader ($custom_header)
MsgHTML ($message, $basedir='')
_mime_types ($ext= '')
set ($name, $value= '')
getFile ($filename)
SecureHeader ($str)
Sign ($cert_filename, $key_filename, $key_pass)

Attributs publics

$Priority = 3
$CharSet = 'utf-8'
$ContentType = 'text/plain'
$Encoding = '8bit'
$ErrorInfo = ''
$From = 'root@localhost'
$FromName = 'Root User'
$Sender = ''
$Subject = ''
$Body = ''
$AltBody = ''
$WordWrap = 0
$Mailer = 'mail'
$Sendmail = '/usr/sbin/sendmail'
$PluginDir = ''
$Version = "2.0.4"
$ConfirmReadingTo = ''
$Hostname = ''
$MessageID = ''
$Host = 'localhost'
$Port = 25
$Helo = ''
$SMTPSecure = ""
$SMTPAuth = false
$Username = ''
$Password = ''
$Timeout = 10
$SMTPDebug = false
$SMTPKeepAlive = false
$SingleTo = false
$smtp = NULL
$to = array()
$cc = array()
$bcc = array()
$ReplyTo = array()
$attachment = array()
$CustomHeader = array()
$message_type = ''
$boundary = array()
$language = array()
$error_count = 0
$LE = "\n"
$sign_cert_file = ""
$sign_key_file = ""
$sign_key_pass = ""

Documentation des fonctions membres

PHPMailer::_mime_types ( $ ext = '' )

Gets the mime type of the embedded or inline image private

Renvoie:: mime type of ext

Références $ext.

PHPMailer::AddAddress	(	$	address,
		$	name = `''`
	)

Adds a "To" address.

Paramètres:

string	$address
string	$name

Renvoie:: void

PHPMailer::AddAttachment	(	$	path,
		$	name = `''`,
		$	encoding = `'base64'`,
		$	type = `'application/octet-stream'`
	)

Adds an attachment from a path on the filesystem. Returns false if the file could not be found or accessed.

Paramètres:

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

Renvoie:: bool

Références $filename, $name, $path, et $type.

PHPMailer::AddBCC	(	$	address,
		$	name = `''`
	)

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

Paramètres:

string	$address
string	$name

Renvoie:: void

PHPMailer::AddCC	(	$	address,
		$	name = `''`
	)

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

Paramètres:

string	$address
string	$name

Renvoie:: void

PHPMailer::AddCustomHeader ( $ custom_header )

Adds a custom header.

Renvoie:: void

PHPMailer::AddEmbeddedImage	(	$	path,
		$	cid,
		$	name = `''`,
		$	encoding = `'base64'`,
		$	type = `'application/octet-stream'`
	)

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

Paramètres:

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

Renvoie:: bool

Références $cid, $filename, $name, $path, et $type.

PHPMailer::AddrAppend	(	$	type,
		$	addr
	)

Creates recipient headers. private

Renvoie:: string

Références $i, et $type.

PHPMailer::AddReplyTo	(	$	address,
		$	name = `''`
	)

Adds a "Reply-To" address.

Paramètres:

string	$address
string	$name

Renvoie:: void

PHPMailer::AddrFormat ( $ addr )

Formats an address correctly. private

Renvoie:: string

PHPMailer::AddStringAttachment	(	$	string,
		$	filename,
		$	encoding = `'base64'`,
		$	type = `'application/octet-stream'`
	)

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.

Paramètres:

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

Renvoie:: void

Références $filename, et $type.

PHPMailer::AttachAll ( )

Attaches all fs, string, and binary attachments to the message. Returns an empty string on failure. private

Renvoie:: string

Références $cid, $filename, $i, $name, $path, et $type.

PHPMailer::Base64EncodeWrapMB ( $ str )

Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php private

Paramètres:

string $str multi-byte text to wrap encode

Renvoie:: string

Références $i, et $start.

PHPMailer::ClearAddresses ( )

Clears all recipients assigned in the TO array. Returns void.

Renvoie:: void

PHPMailer::ClearAllRecipients ( )

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

Renvoie:: void

PHPMailer::ClearAttachments ( )

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

Renvoie:: void

PHPMailer::ClearBCCs ( )

Clears all recipients assigned in the BCC array. Returns void.

Renvoie:: void

PHPMailer::ClearCCs ( )

Clears all recipients assigned in the CC array. Returns void.

Renvoie:: void

PHPMailer::ClearCustomHeaders ( )

Clears all custom headers. Returns void.

Renvoie:: void

PHPMailer::ClearReplyTos ( )

Clears all recipients assigned in the ReplyTo array. Returns void.

Renvoie:: void

PHPMailer::CreateBody ( )

Assembles the message body. Returns an empty string on failure. private

Renvoie:: string

Références $file.

PHPMailer::CreateHeader ( )

Assembles message header. private

Renvoie:: string

Références elseif.

PHPMailer::EncodeFile	(	$	path,
		$	encoding = `'base64'`
	)

Encodes attachment in requested format. Returns an empty string on failure. private

Renvoie:: string

Références $path.

PHPMailer::EncodeHeader	(	$	str,
		$	position = `'text'`
	)

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

Renvoie:: string

PHPMailer::EncodeQ	(	$	str,
		$	position = `'text'`
	)

Encode string to q encoding. private

Renvoie:: string

PHPMailer::EncodeQP	(	$	input = `''`,
		$	line_max = `76`,
		$	space_conv = `false`
	)

Encode string to quoted-printable. private

Renvoie:: string

Références $i, $output, et elseif.

PHPMailer::EncodeString	(	$	str,
		$	encoding = `'base64'`
	)

Encodes string to requested format. Returns an empty string on failure. private

Renvoie:: string

PHPMailer::EndBoundary ( $ boundary )

Returns the end of a message boundary. private

PHPMailer::FixEOL ( $ str )

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

Renvoie:: string

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

Returns the start of a message boundary. private

PHPMailer::getFile ( $ filename )

Read a file from a supplied filename and return it.

public

Paramètres:

string $filename Parameter File Name

Références $filename, et $return.

PHPMailer::GetMailMIME ( )

Returns the message MIME. private

Renvoie:: string

PHPMailer::HasMultiBytes ( $ str )

Checks if a string contains multibyte characters. private

Paramètres:

string $str multi-byte text to wrap encode

Renvoie:: bool

PHPMailer::HeaderLine	(	$	name,
		$	value
	)

Références $name.

PHPMailer::InlineImageExists ( )

Returns true if an inline attachment is present. private

Renvoie:: bool

Références $i.

PHPMailer::IsError ( )

Returns true if an error occurred.

Renvoie:: bool

PHPMailer::IsHTML ( $ bool )

Sets message type to HTML.

Paramètres:

bool $bool

Renvoie:: void

PHPMailer::IsMail ( )

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

Renvoie:: void

PHPMailer::IsQmail ( )

Sets Mailer to send message using the qmail MTA.

Renvoie:: void

PHPMailer::IsSendmail ( )

Sets Mailer to send message using the $Sendmail program.

Renvoie:: void

PHPMailer::IsSMTP ( )

Sets Mailer to send message using SMTP.

Renvoie:: void

PHPMailer::Lang ( $ key )

Returns a message in the appropriate language. private

Renvoie:: string

PHPMailer::MailSend	(	$	header,
		$	body
	)

Sends mail using the PHP mail() function. private

Renvoie:: bool

Références $i, et $params.

PHPMailer::MsgHTML	(	$	message,
		$	basedir = `''`
	)

Evaluates the message and returns modifications for inline images and backgrounds public

Renvoie:: $message

Références $cid, $ext, $filename, $i, $images, et $url.

PHPMailer::RFCDate ( )

Returns the proper RFC 822 formatted date. private

Renvoie:: string

PHPMailer::SecureHeader ( $ str )

Strips newlines to prevent header injection. private

Paramètres:

string $str String

Renvoie:: string

PHPMailer::Send ( )

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.

Renvoie:: bool

Réimplémentée dans JMail.

PHPMailer::SendmailSend	(	$	header,
		$	body
	)

Sends mail using the $Sendmail program. private

Renvoie:: bool

PHPMailer::ServerHostname ( )

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

Renvoie:: string

Références elseif.

PHPMailer::ServerVar ( $ varName )

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

Renvoie:: mixed

PHPMailer::set	(	$	name,
		$	value = `''`
	)

Set (or reset) Class Objects (variables)

Usage Example: $page->set('X-Priority', '3');

public

Paramètres:

string	$name	Parameter Name
mixed	$value	Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset

Références $name.

PHPMailer::SetError ( $ msg )

Adds the error message to the error container. Returns void. private

Renvoie:: void

PHPMailer::SetLanguage	(	$	lang_type,
		$	lang_path = `'language/'`
	)

Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.

Paramètres:

string	$lang_type	Type of language (e.g. Portuguese: "br")
string	$lang_path	Path to the language file directory public

Renvoie:: bool

Références $PHPMAILER_LANG, et elseif.

PHPMailer::SetMessageType ( )

Sets the message type. private

Renvoie:: void

PHPMailer::SetWordWrap ( )

Set the body wrapping. private

Renvoie:: void

PHPMailer::Sign	(	$	cert_filename,
		$	key_filename,
		$	key_pass
	)

Set the private key file and password to sign the message.

public

Paramètres:

string	$key_filename	Parameter File Name
string	$key_pass	Password for private key

PHPMailer::SmtpClose ( )

Closes the active SMTP session if one exists.

Renvoie:: void

PHPMailer::SmtpConnect ( )

Initiates a connection to an SMTP server. Returns false if the operation failed. private

Renvoie:: bool

Références $host.

PHPMailer::SmtpSend	(	$	header,
		$	body
	)

Sends mail via SMTP using PhpSMTP (Author: Chris Ryan). Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input. private

Renvoie:: bool

Références $error, et $i.

PHPMailer::TextLine ( $ value )

Returns a formatted mail line. private

Renvoie:: string

PHPMailer::UTF8CharBoundary	(	$	encodedText,
		$	maxLength
	)

Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string. Original written by Colin Brown. private

Paramètres:

string	$encodedText	utf-8 QP text
int	$maxLength	find last character boundary prior to this length

Renvoie:: int

Références elseif.

PHPMailer::WrapText	(	$	message,
		$	length,
		$	qp_mode = `false`
	)

Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable. Original written by philippe. private

Renvoie:: string

Références $i, et elseif.

Documentation des données membres

PHPMailer::$AltBody = ''

PHPMailer::$attachment = array()

PHPMailer::$bcc = array()

PHPMailer::$Body = ''

PHPMailer::$boundary = array()

PHPMailer::$cc = array()

PHPMailer::$CharSet = 'utf-8'

PHPMailer::$ConfirmReadingTo = ''

PHPMailer::$ContentType = 'text/plain'

PHPMailer::$CustomHeader = array()

PHPMailer::$Encoding = '8bit'

PHPMailer::$error_count = 0

PHPMailer::$ErrorInfo = ''

PHPMailer::$From = 'root@localhost'

PHPMailer::$FromName = 'Root User'

PHPMailer::$Helo = ''

PHPMailer::$Host = 'localhost'

PHPMailer::$Hostname = ''

PHPMailer::$language = array()

PHPMailer::$LE = "\n"

PHPMailer::$Mailer = 'mail'

PHPMailer::$message_type = ''

PHPMailer::$MessageID = ''

PHPMailer::$Password = ''

PHPMailer::$PluginDir = ''

PHPMailer::$Port = 25

PHPMailer::$Priority = 3

PHPMailer::$ReplyTo = array()

PHPMailer::$Sender = ''

PHPMailer::$Sendmail = '/usr/sbin/sendmail'

PHPMailer::$sign_cert_file = ""

PHPMailer::$sign_key_file = ""

PHPMailer::$sign_key_pass = ""

PHPMailer::$SingleTo = false

PHPMailer::$smtp = NULL

PHPMailer::$SMTPAuth = false

PHPMailer::$SMTPDebug = false

PHPMailer::$SMTPKeepAlive = false

PHPMailer::$SMTPSecure = ""

PHPMailer::$Subject = ''

PHPMailer::$Timeout = 10

PHPMailer::$to = array()

PHPMailer::$Username = ''

PHPMailer::$Version = "2.0.4"

PHPMailer::$WordWrap = 0

La documentation de cette classe a été générée à partir du fichier suivant :

phpmailer.php

Référence de la classe PHPMailer

Fonctions membres publiques

Attributs publics

Documentation des fonctions membres

Documentation des données membres