PHPMailer Class Reference

List of all members.

---

Detailed Description

Definition at line 35 of file class.phpmailer.php.

Public Member Functions
	_mime_types ($ext= '')
	Gets the mime type of the embedded or inline image public.
	AddAddress ($address, $name= '')
	Adds a "To" address.
	AddAttachment ($path, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
	Adds an attachment from a path on the filesystem.
	AddBCC ($address, $name= '')
	Adds a "Bcc" address.
	AddCC ($address, $name= '')
	Adds a "Cc" address.
	AddCustomHeader ($custom_header)
	Adds a custom header.
	AddEmbeddedImage ($path, $cid, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
	Adds an embedded attachment.
	AddrAppend ($type, $addr)
	Creates recipient headers.
	AddReplyTo ($address, $name= '')
	Adds a "Reply-to" address.
	AddrFormat ($addr)
	Formats an address correctly.
	AddStringAttachment ($string, $filename, $encoding= 'base64', $type= 'application/octet-stream')
	Adds a string or binary attachment (non-filesystem) to the list.
	AttachAll ()
	Attaches all fs, string, and binary attachments to the message.
	Base64EncodeWrapMB ($str)
	Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
	ClearAddresses ()
	Clears all recipients assigned in the TO array.
	ClearAllRecipients ()
	Clears all recipients assigned in the TO, CC and BCC array.
	ClearAttachments ()
	Clears all previously set filesystem, string, and binary attachments.
	ClearBCCs ()
	Clears all recipients assigned in the BCC array.
	ClearCCs ()
	Clears all recipients assigned in the CC array.
	ClearCustomHeaders ()
	Clears all custom headers.
	ClearReplyTos ()
	Clears all recipients assigned in the ReplyTo array.
	CreateBody ()
	Assembles the message body.
	CreateHeader ()
	Assembles message header.
	EncodeFile ($path, $encoding= 'base64')
	Encodes attachment in requested format.
	EncodeHeader ($str, $position= 'text')
	Encode a header string to best of Q, B, quoted or none.
	EncodeQ ($str, $position= 'text')
	Encode string to q encoding.
	EncodeQP ($input= '', $line_max=76, $space_conv=false)
	Encode string to quoted-printable.
	EncodeString ($str, $encoding= 'base64')
	Encodes string to requested format.
	EndBoundary ($boundary)
	Returns the end of a message boundary.
	GetBoundary ($boundary, $charSet, $contentType, $encoding)
	Returns the start of a message boundary.
	getFile ($filename)
	Read a file from a supplied filename and return it.
	GetMailMIME ()
	Returns the message MIME.
	HasMultiBytes ($str)
	Checks if a string contains multibyte characters.
	HeaderLine ($name, $value)
	InlineImageExists ()
	Returns true if an inline attachment is present.
	IsError ()
	Returns true if an error occurred.
	IsHTML ($bool)
	Sets message type to HTML.
	IsMail ()
	Sets Mailer to send message using PHP mail() function.
	IsQmail ()
	Sets Mailer to send message using the qmail MTA.
	IsSendmail ()
	Sets Mailer to send message using the $Sendmail program.
	IsSMTP ()
	Sets Mailer to send message using SMTP.
	MailSend ($header, $body)
	Sends mail using the PHP mail() function.
	MsgHTML ($message, $basedir='')
	Evaluates the message and returns modifications for inline images and backgrounds public.
	SecureHeader ($str)
	Strips newlines to prevent header injection.
	Send ()
	Creates message and assigns Mailer.
	SendmailSend ($header, $body)
	Sends mail using the $Sendmail program.
	set ($name, $value= '')
	Set (or reset) Class Objects (variables).
	SetLanguage ($lang_type= 'en', $lang_path= 'language/')
	Sets the language for all class error messages.
	SetMessageType ()
	Sets the message type.
	SetWordWrap ()
	Set the body wrapping.
	Sign ($key_filename, $key_pass)
	Set the private key file and password to sign the message.
	SmtpClose ()
	Closes the active SMTP session if one exists.
	SmtpConnect ()
	Initiates a connection to an SMTP server.
	SmtpSend ($header, $body)
	Sends mail via SMTP using PhpSMTP (Author: Chris Ryan).
	TextLine ($value)
	Returns a formatted mail line.
	UTF8CharBoundary ($encodedText, $maxLength)
	Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
	WrapText ($message, $length, $qp_mode=false)
	Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
Public Attributes
	$AltBody = ''
	$Body = ''
	$CharSet = 'iso-8859-1'
	$ConfirmReadingTo = ''
	$ContentType = 'text/plain'
	$Encoding = '8bit'
	$ErrorInfo = ''
	$From = 'root@localhost'
	$FromName = 'Root User'
	$Helo = ''
	$Host = 'localhost'
	$Hostname = ''
	$Mailer = 'mail'
	$MessageID = ''
	$Password = ''
	$PluginDir = ''
	$Port = 25
	$Priority = 3
	$Sender = ''
	$Sendmail = '/usr/sbin/sendmail'
	$SingleTo = false
	$SMTPAuth = false
	$SMTPDebug = false
	$SMTPKeepAlive = false
	$SMTPSecure = ""
	$Subject = ''
	$Timeout = 10
	$Username = ''
	$Version = "2.1"
	$WordWrap = 0
Private Member Functions
	FixEOL ($str)
	Changes every end of line from CR or LF to CRLF.
	Lang ($key)
	Returns a message in the appropriate language.
	ServerHostname ()
	Returns the server hostname or 'localhost.localdomain' if unknown.
	SetError ($msg)
	Adds the error message to the error container.
Static Private Member Functions
static	RFCDate ()
	Returns the proper RFC 822 formatted date.
Private Attributes
	$attachment = array()
	$bcc = array()
	$boundary = array()
	$cc = array()
	$CustomHeader = array()
	$error_count = 0
	$language = array()
	$LE = "\n"
	$message_type = ''
	$ReplyTo = array()
	$sign_key_file = ""
	$sign_key_pass = ""
	$smtp = NULL
	$to = array()

---

The documentation for this class was generated from the following file:

• ship-simu/inc/classes/third_party/php_mailer/class.phpmailer.php