[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-forums/bbpress/bb-includes/backpress/ -> class.mailer.php (summary)

(no description)

File Size: 1933 lines (58 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 src/bp-forums/bbpress/bb-includes/backpress/class.mailer-smtp.php

Defines 1 class

PHPMailer:: (63 methods):
  IsHTML()
  IsSMTP()
  IsMail()
  IsSendmail()
  IsQmail()
  AddAddress()
  AddCC()
  AddBCC()
  AddReplyTo()
  Send()
  SendmailSend()
  MailSend()
  SmtpSend()
  SmtpConnect()
  SmtpClose()
  SetLanguage()
  AddrAppend()
  AddrFormat()
  WrapText()
  UTF8CharBoundary()
  SetWordWrap()
  CreateHeader()
  GetMailMIME()
  CreateBody()
  GetBoundary()
  EndBoundary()
  SetMessageType()
  HeaderLine()
  TextLine()
  AddAttachment()
  AttachAll()
  EncodeFile()
  EncodeString()
  EncodeHeader()
  HasMultiBytes()
  Base64EncodeWrapMB()
  EncodeQP()
  EncodeQ_callback()
  EncodeQ()
  AddStringAttachment()
  AddEmbeddedImage()
  InlineImageExists()
  ClearAddresses()
  ClearCCs()
  ClearBCCs()
  ClearReplyTos()
  ClearAllRecipients()
  ClearAttachments()
  ClearCustomHeaders()
  SetError()
  RFCDate()
  ServerVar()
  ServerHostname()
  Lang()
  IsError()
  FixEOL()
  AddCustomHeader()
  MsgHTML()
  _mime_types()
  set()
  getFile()
  SecureHeader()
  Sign()


Class: PHPMailer  - X-Ref

PHPMailer - PHP email transport class

IsHTML($bool)   X-Ref
Sets message type to HTML.

return: void
param: bool $bool

IsSMTP()   X-Ref
Sets Mailer to send message using SMTP.

return: void

IsMail()   X-Ref
Sets Mailer to send message using PHP mail() function.

return: void

IsSendmail()   X-Ref
Sets Mailer to send message using the $Sendmail program.

return: void

IsQmail()   X-Ref
Sets Mailer to send message using the qmail MTA.

return: void

AddAddress($address, $name = '')   X-Ref
Adds a "To" address.

return: void
param: string $address
param: string $name

AddCC($address, $name = '')   X-Ref
Adds a "Cc" address. Note: this function works
with the SMTP mailer on win32, not with the "mail"
mailer.

return: void
param: string $address
param: string $name

AddBCC($address, $name = '')   X-Ref
Adds a "Bcc" address. Note: this function works
with the SMTP mailer on win32, not with the "mail"
mailer.

return: void
param: string $address
param: string $name

AddReplyTo($address, $name = '')   X-Ref
Adds a "Reply-To" address.

return: void
param: string $address
param: string $name

Send()   X-Ref
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.

return: bool

SendmailSend($header, $body)   X-Ref
Sends mail using the $Sendmail program.

return: bool

MailSend($header, $body)   X-Ref
Sends mail using the PHP mail() function.

return: bool

SmtpSend($header, $body)   X-Ref
Sends mail via SMTP using PhpSMTP (Author:
Chris Ryan).  Returns bool.  Returns false if there is a
bad MAIL FROM, RCPT, or DATA input.

return: bool

SmtpConnect()   X-Ref
Initiates a connection to an SMTP server.  Returns false if the
operation failed.

return: bool

SmtpClose()   X-Ref
Closes the active SMTP session if one exists.

return: void

SetLanguage($lang_type, $lang_path = 'language/')   X-Ref
Sets the language for all class error messages.  Returns false
if it cannot load the language file.  The default language type
is English.

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

AddrAppend($type, $addr)   X-Ref
Creates recipient headers.

return: string

AddrFormat($addr)   X-Ref
Formats an address correctly.

return: string

WrapText($message, $length, $qp_mode = false)   X-Ref
Wraps message for use with mailers that do not
automatically perform wrapping and for quoted-printable.
Original written by philippe.

return: string

UTF8CharBoundary($encodedText, $maxLength)   X-Ref
Finds last character boundary prior to maxLength in a utf-8
quoted (printable) encoded string.
Original written by Colin Brown.

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

SetWordWrap()   X-Ref
Set the body wrapping.

return: void

CreateHeader()   X-Ref
Assembles message header.

return: string

GetMailMIME()   X-Ref
Returns the message MIME.

return: string

CreateBody()   X-Ref
Assembles the message body.  Returns an empty string on failure.

return: string

GetBoundary($boundary, $charSet, $contentType, $encoding)   X-Ref
Returns the start of a message boundary.


EndBoundary($boundary)   X-Ref
Returns the end of a message boundary.


SetMessageType()   X-Ref
Sets the message type.

return: void

HeaderLine($name, $value)   X-Ref
No description

TextLine($value)   X-Ref
Returns a formatted mail line.

return: string

AddAttachment($path, $name = '', $encoding = 'base64', $type = 'application/octet-stream')   X-Ref
Adds an attachment from a path on the filesystem.
Returns false if the file could not be found
or accessed.

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

AttachAll()   X-Ref
Attaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.

return: string

EncodeFile($path, $encoding = 'base64')   X-Ref
Encodes attachment in requested format.  Returns an
empty string on failure.

return: string

EncodeString($str, $encoding = 'base64')   X-Ref
Encodes string to requested format. Returns an
empty string on failure.

return: string

EncodeHeader($str, $position = 'text')   X-Ref
Encode a header string to best of Q, B, quoted or none.

return: string

HasMultiBytes($str)   X-Ref
Checks if a string contains multibyte characters.

return: bool
param: string $str multi-byte text to wrap encode

Base64EncodeWrapMB($str)   X-Ref
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

return: string
param: string $str multi-byte text to wrap encode

EncodeQP( $input = '', $line_max = 76, $space_conv = false )   X-Ref
Encode string to quoted-printable.

return: string

EncodeQ_callback($matches)   X-Ref
Callback for converting to "=XX".

return: string

EncodeQ($str, $position = 'text')   X-Ref
Encode string to q encoding.

return: string

AddStringAttachment($string, $filename, $encoding = 'base64', $type = 'application/octet-stream')   X-Ref
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.

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

AddEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = 'application/octet-stream')   X-Ref
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".

return: bool
param: string $path Path to the attachment.
param: string $cid Content ID of the attachment.  Use this to identify
param: string $name Overrides the attachment name.
param: string $encoding File encoding (see $Encoding).
param: string $type File extension (MIME) type.

InlineImageExists()   X-Ref
Returns true if an inline attachment is present.

return: bool

ClearAddresses()   X-Ref
Clears all recipients assigned in the TO array.  Returns void.

return: void

ClearCCs()   X-Ref
Clears all recipients assigned in the CC array.  Returns void.

return: void

ClearBCCs()   X-Ref
Clears all recipients assigned in the BCC array.  Returns void.

return: void

ClearReplyTos()   X-Ref
Clears all recipients assigned in the ReplyTo array.  Returns void.

return: void

ClearAllRecipients()   X-Ref
Clears all recipients assigned in the TO, CC and BCC
array.  Returns void.

return: void

ClearAttachments()   X-Ref
Clears all previously set filesystem, string, and binary
attachments.  Returns void.

return: void

ClearCustomHeaders()   X-Ref
Clears all custom headers.  Returns void.

return: void

SetError($msg)   X-Ref
Adds the error message to the error container.
Returns void.

return: void

RFCDate()   X-Ref
Returns the proper RFC 822 formatted date.

return: string

ServerVar($varName)   X-Ref
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.

return: mixed

ServerHostname()   X-Ref
Returns the server hostname or 'localhost.localdomain' if unknown.

return: string

Lang($key)   X-Ref
Returns a message in the appropriate language.

return: string

IsError()   X-Ref
Returns true if an error occurred.

return: bool

FixEOL($str)   X-Ref
Changes every end of line from CR or LF to CRLF.

return: string

AddCustomHeader($custom_header)   X-Ref
Adds a custom header.

return: void

MsgHTML($message,$basedir='')   X-Ref
Evaluates the message and returns modifications for inline images and backgrounds

return: $message

_mime_types($ext = '')   X-Ref
Gets the mime type of the embedded or inline image

return: mime type of ext

set( $name, $value = '' )   X-Ref
Set (or reset) Class Objects (variables)

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

param: string $name Parameter Name
param: mixed $value Parameter Value

getFile($filename)   X-Ref
Read a file from a supplied filename and return it.

param: string $filename Parameter File Name

SecureHeader($str)   X-Ref
Strips newlines to prevent header injection.

return: string
param: string $str String

Sign($cert_filename, $key_filename, $key_pass)   X-Ref
Set the private key file and password to sign the message.

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



Generated: Wed Jul 17 01:01:40 2019 Cross-referenced by PHPXref 0.7.1