MIOLO25
Carregando...
Procurando...
Nenhuma entrada encontrada
Referência à classe PHPMailer

Membros públicos

 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="")
 
 addrAppend ($type, $addr)
 
 addrFormat ($addr)
 
 wrapText ($message, $length, $qp_mode=false)
 
 setWordWrap ()
 
 createHeader ()
 
 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')
 
 encodeQP ($str)
 
 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 ()
 
 received ()
 
 serverVar ($varName)
 
 serverHostname ()
 
 lang ($key)
 
 isError ()
 
 fixEOL ($str)
 
 addCustomHeader ($custom_header)
 

Campos de Dados

 $priority = 3
 
 $charSet = "iso-8859-1"
 
 $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 = "1.71"
 
 $confirmReadingTo = ""
 
 $hostname = ""
 
 $host = "localhost"
 
 $port = 25
 
 $helo = ""
 
 $SMTPAuth = false
 
 $username = ""
 
 $password = ""
 
 $timeout = 10
 
 $SMTPDebug = false
 
 $SMTPKeepAlive = false
 
 $smtp = NULL
 
 $to
 
 $cc
 
 $bcc
 
 $replyTo
 
 $attachment
 
 $customHeader
 
 $message_type = ""
 
 $boundary
 
 $language
 
 $error_count = 0
 
 $LE = "\n"
 

Documentação das funções

◆ addAddress()

addAddress ( $address,
$name = "" )

Adds a "To" address.

Parâmetros
string$address
string$name
Retorna
void

◆ addAttachment()

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.

Parâmetros
string$pathPath to the attachment.
string$nameOverrides the attachment name.
string$encodingFile encoding (see $encoding).
string$typeFile extension (MIME) type.
Retorna
bool

◆ addBCC()

addBCC ( $address,
$name = "" )

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

Parâmetros
string$address
string$name
Retorna
void

◆ addCC()

addCC ( $address,
$name = "" )

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

Parâmetros
string$address
string$name
Retorna
void

◆ addCustomHeader()

addCustomHeader ( $custom_header)

Adds a custom header.

Retorna
void

◆ addEmbeddedImage()

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

Parâmetros
string$pathPath to the attachment.
string$cidContent ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
string$nameOverrides the attachment name.
string$encodingFile encoding (see $encoding).
string$typeFile extension (MIME) type.
Retorna
bool

◆ addrAppend()

addrAppend ( $type,
$addr )

Creates recipient headers.
@access private

Retorna
string

◆ addReplyTo()

addReplyTo ( $address,
$name = "" )

Adds a "Reply-to" address.

Parâmetros
string$address
string$name
Retorna
void

◆ addrFormat()

addrFormat ( $addr)

Formats an address correctly. @access private

Retorna
string

◆ addStringAttachment()

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.

Parâmetros
string$stringString attachment data.
string$filenameName of the attachment.
string$encodingFile encoding (see $encoding).
string$typeFile extension (MIME) type.
Retorna
void

◆ attachAll()

attachAll ( )

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

Retorna
string

◆ clearAddresses()

clearAddresses ( )

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

Retorna
void

◆ clearAllRecipients()

clearAllRecipients ( )

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

Retorna
void

◆ clearAttachments()

clearAttachments ( )

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

Retorna
void

◆ clearBCCs()

clearBCCs ( )

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

Retorna
void

◆ clearCCs()

clearCCs ( )

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

Retorna
void

◆ clearCustomHeaders()

clearCustomHeaders ( )

Clears all custom headers. Returns void.

Retorna
void

◆ clearReplyTos()

clearReplyTos ( )

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

Retorna
void

◆ createBody()

createBody ( )

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

Retorna
string

◆ createHeader()

createHeader ( )

Assembles message header.
@access private

Retorna
string

◆ encodeFile()

encodeFile ( $path,
$encoding = "base64" )

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

Retorna
string

◆ encodeHeader()

encodeHeader ( $str,
$position = 'text' )

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

Retorna
string

◆ encodeQ()

encodeQ ( $str,
$position = "text" )

Encode string to q encoding.
@access private

Retorna
string

◆ encodeQP()

encodeQP ( $str)

Encode string to quoted-printable.
@access private

Retorna
string

◆ encodeString()

encodeString ( $str,
$encoding = "base64" )

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

Retorna
string

◆ endBoundary()

endBoundary ( $boundary)

Returns the end of a message boundary. @access private

◆ fixEOL()

fixEOL ( $str)

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

Retorna
string

◆ getBoundary()

getBoundary ( $boundary,
$charSet,
$contentType,
$encoding )

Returns the start of a message boundary. @access private

◆ headerLine()

headerLine ( $name,
$value )

Returns a formatted header line. @access private

Retorna
string

◆ inlineImageExists()

inlineImageExists ( )

Returns true if an inline attachment is present. @access private

Retorna
bool

◆ isError()

isError ( )

Returns true if an error occurred.

Retorna
bool

◆ isHTML()

isHTML ( $bool)

#- Sets message type to HTML.

Parâmetros
bool$bool
Retorna
void

◆ isMail()

isMail ( )

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

Retorna
void

◆ isQmail()

isQmail ( )

Sets Mailer to send message using the qmail MTA.

Retorna
void

◆ isSendmail()

isSendmail ( )

Sets Mailer to send message using the $sendmail program.

Retorna
void

◆ isSMTP()

isSMTP ( )

Sets Mailer to send message using SMTP.

Retorna
void

◆ lang()

lang ( $key)

Returns a message in the appropriate language. @access private

Retorna
string

◆ mailSend()

mailSend ( $header,
$body )

Sends mail using the PHP mail() function.
@access private

Retorna
bool

◆ received()

received ( )

Returns Received header for message tracing. @access private

Retorna
string

◆ RFCDate()

RFCDate ( )

Returns the proper RFC 822 formatted date. @access private

Retorna
string

◆ send()

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.

Retorna
bool

◆ sendmailSend()

sendmailSend ( $header,
$body )

Sends mail using the $sendmail program.
@access private

Retorna
bool

◆ serverHostname()

serverHostname ( )

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

Retorna
string

◆ serverVar()

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

Retorna
mixed

◆ setError()

setError ( $msg)

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

Retorna
void

◆ setLanguage()

setLanguage ( $lang_type,
$lang_path = "" )

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

Parâmetros
string$lang_typeType of language (e.g. Portuguese: "br")
string$lang_pathPath to the language file directory @access public
Retorna
bool

◆ setMessageType()

setMessageType ( )

Sets the message type. @access private

Retorna
void

◆ setWordWrap()

setWordWrap ( )

Set the body wrapping. @access private

Retorna
void

◆ smtpClose()

smtpClose ( )

Closes the active SMTP session if one exists.

Retorna
void

◆ smtpConnect()

smtpConnect ( )

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

Retorna
bool

◆ smtpSend()

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

Retorna
bool

◆ textLine()

textLine ( $value)

Returns a formatted mail line. @access private

Retorna
string

◆ wrapText()

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

Retorna
string

Documentação dos campos e atributos

◆ $altBody

$altBody = ""

◆ $attachment

$attachment
Valor inicial:
= array(
)

◆ $bcc

$bcc
Valor inicial:
= array(
)

◆ $body

$body = ""

◆ $boundary

$boundary
Valor inicial:
= array(
)

◆ $cc

$cc
Valor inicial:
= array(
)

◆ $charSet

$charSet = "iso-8859-1"

◆ $confirmReadingTo

$confirmReadingTo = ""

◆ $contentType

$contentType = "text/plain"

◆ $customHeader

$customHeader
Valor inicial:
= array(
)

◆ $encoding

$encoding = "8bit"

◆ $error_count

$error_count = 0

◆ $errorInfo

$errorInfo = ""

◆ $from

$from = "root@localhost"

◆ $fromName

$fromName = "Root User"

◆ $helo

$helo = ""

◆ $host

$host = "localhost"

◆ $hostname

$hostname = ""

◆ $language

$language
Valor inicial:
= array(
)

◆ $LE

$LE = "\n"

◆ $mailer

$mailer = "mail"

◆ $message_type

$message_type = ""

◆ $password

$password = ""

◆ $pluginDir

$pluginDir = ""

◆ $port

$port = 25

◆ $priority

$priority = 3

◆ $replyTo

$replyTo
Valor inicial:
= array(
)

◆ $sender

$sender = ""

◆ $sendmail

$sendmail = "/usr/sbin/sendmail"

◆ $smtp

$smtp = NULL

#+ @access private

◆ $SMTPAuth

$SMTPAuth = false

◆ $SMTPDebug

$SMTPDebug = false

◆ $SMTPKeepAlive

$SMTPKeepAlive = false

◆ $subject

$subject = ""

◆ $timeout

$timeout = 10

◆ $to

$to
Valor inicial:
= array(
)

◆ $username

$username = ""

◆ $version

$version = "1.71"

◆ $wordWrap

$wordWrap = 0

A documentação para esta classe foi gerada a partir do seguinte ficheiro: