[ Index ]

PHP Cross Reference of MyBB

title

Body

[close]

/inc/ -> class_mailhandler.php (summary)

MyBB 1.6 Copyright 2010 MyBB Group, All Rights Reserved Website: http://mybb.com License: http://mybb.com/about/license

File Size: 412 lines (10 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

MailHandler:: (12 methods):
  build_message()
  set_charset()
  set_message()
  set_subject()
  set_to()
  set_plain_headers()
  set_html_headers()
  set_common_headers()
  fatal_error()
  cleanup()
  cleanup_crlf()
  utf8_encode()


Class: MailHandler  - X-Ref

Base mail handler class.

build_message($to, $subject, $message, $from="", $charset="", $headers="", $format="text", $message_text="", $return_email="")   X-Ref
Builds the whole mail.
To be used by the different email classes later.

param: string to email.
param: string subject of email.
param: string message of email.
param: string from email.
param: string charset of email.
param: string headers of email.
param: string format of the email (HTML, plain text, or both?).
param: string plain text version of the email.
param: string the return email address.

set_charset($charset)   X-Ref
Sets the charset.

param: string charset

set_message($message, $message_text="")   X-Ref
Sets and formats the email message.

param: string message

set_subject($subject)   X-Ref
Sets and formats the email subject.

param: string subject

set_to($to)   X-Ref
Sets and formats the recipient address.

param: string to

set_plain_headers()   X-Ref
Sets the plain headers, text/plain


set_html_headers($message, $message_text="")   X-Ref
Sets the alternative headers, text/html and text/plain.

param: string message

set_common_headers()   X-Ref
Sets the common headers.


fatal_error($error)   X-Ref
Log a fatal error message to the database.

param: string The error message
param: string Any additional information

cleanup($string)   X-Ref
Rids pesky characters from subjects, recipients, from addresses etc (prevents mail injection too)

param: string The string being checked
return: string The cleaned string

cleanup_crlf($text)   X-Ref
Converts message text to suit the correct delimiter
See dev.mybb.com/issues/1735 (Jorge Oliveira)

param: string The text being converted
return: string The converted string

utf8_encode($string)   X-Ref
Encode a string based on the character set enabled. Used to encode subjects
and recipients in email messages going out so that they show up correctly
in email clients.

param: string The string to be encoded.
return: string The encoded string.



Generated: Tue Oct 8 19:19:50 2013 Cross-referenced by PHPXref 0.7.1