MailMessage Class Reference
[Lib]

Encapsulates an e-mail message, allowing attachments. More...

List of all members.

Public Member Functions
	__construct ($subject, $message, $to, $from= '', $content_type= '')
	constructor
	add_attachment ($file_name, $name= '')
	Append a file to attach.
	preprocess_header ()
	Clears from, subject, cc and to data to avoid header injection http://www.anders.com/projects/sysadmin/formPostHijacking/.
	send ()
	Sends email.
	set_alt_message ($msg)
	Set alternative message.
Public Attributes
const	MIME_HTML = 'text/html; charset="%charset"'
	HTML mime content type.
const	MIME_TEXT_PLAIN = 'text/plain; charset="%charset"'
	Plain text mime content type.
Protected Member Functions
	create_builder ()
	Return builder suited for config.
	encode_headers ($headers)

---

Detailed Description

Encapsulates an e-mail message, allowing attachments.

Note:

The class relies on the PEAR classes Mail and Mail_Mime

Author:

Gerd Riesselmann

Definition at line 12 of file mailmessage.cls.php.

---

Constructor & Destructor Documentation

MailMessage::__construct	(	$	subject,
		$	message,
		$	to,
		$	from = '',
		$	content_type = ''
	)

constructor

Definition at line 67 of file mailmessage.cls.php.

                                                                                             {
                $this->subject = trim(Config::get_value(Config::MAIL_SUBJECT) . ' ' . $subject);
                $this->message = $message;
                $this->to = $to;
                $this->from = $from;
                if (empty($content_type)) {
                        $this->content_type = self::MIME_TEXT_PLAIN; 
                }
                else {
                        $this->content_type = $content_type;
                }
        }

---

Member Function Documentation

MailMessage::add_attachment	(	$	file_name,
		$	name = ''
	)

Append a file to attach.

Definition at line 144 of file mailmessage.cls.php.

                                                               {
                if ($name == '') {
                        $name = $file_name;
                }
                $this->files_to_attach[$name] = $file_name;
        }

MailMessage::create_builder

(

)

[protected]

Return builder suited for config.

Returns:

IMailMessageBuilder

Definition at line 126 of file mailmessage.cls.php.

                                            {
                $ret = false;
                Load::directories('lib/components/mailmessagebuilder');
                $msg_builder = ($this->message_alt) 
                        ? new AlternativeMessageBuilder($this->message, $this->content_type, $this->message_alt)
                        : new SingleMessageBuilder($this->message, $this->content_type);
                if (count($this->files_to_attach)) {
                        $ret = new AttachmentsBuilder($msg_builder, $this->files_to_attach);
                }
                else {
                        $ret = $msg_builder;
                }
                return $ret;             
        }

MailMessage::encode_headers

(

$

headers

)

[protected]

Definition at line 113 of file mailmessage.cls.php.

                                                    {
                $ret = array();
                foreach($headers as $name => $value) {
                        $ret[$name] = ConverterFactory::encode($value, ConverterFactory::MIMEHEADER);
                }
                return $ret;
        }

MailMessage::preprocess_header

(

)

Clears from, subject, cc and to data to avoid header injection http://www.anders.com/projects/sysadmin/formPostHijacking/.

Definition at line 155 of file mailmessage.cls.php.

                                            {
                $this->to = $this->safety_preprocess_header_field($this->to);
                $this->from = $this->safety_preprocess_header_field($this->from);
                $this->subject = $this->safety_preprocess_header_field($this->subject);
                $this->cc = $this->safety_preprocess_header_field($this->cc);
        }

MailMessage::send

(

)

Sends email.

Returns:

Status

Definition at line 85 of file mailmessage.cls.php.

                               {
                // Check for injection attack;
                $ret = $this->safety_validate_header();
                if ($ret->is_error()) {
                        return $ret;
                }
                
                $headers = array(
                        'From' => empty($this->from) ? Config::get_value(Config::MAIL_SENDER, true) : $this->from,
                );
                if ($this->cc != '') {
                        $headers['Bcc'] = $this->cc;
                }
                
                $builder = $this->create_builder();
                $headers['Content-Type'] = $builder->get_mail_mime();
                $headers = array_merge($headers, $builder->get_additional_headers());
                $body = $builder->get_body();
                
                $headers = $this->encode_headers($headers);
                $subject = ConverterFactory::encode($this->subject, ConverterFactory::MIMEHEADER);
                if (!mail($this->to, $subject, $body, Arr::implode("\n", $headers, ': '))) {
                        $ret->append(tr('Could not send mail', 'core'));
                }

                return $ret;
        }

MailMessage::set_alt_message

(

$

msg

)

Set alternative message.

Definition at line 165 of file mailmessage.cls.php.

                                              {
                $this->message_alt = $msg;
        }

---

Member Data Documentation

const MailMessage::MIME_HTML = 'text/html; charset="%charset"'

HTML mime content type.

Definition at line 16 of file mailmessage.cls.php.

const MailMessage::MIME_TEXT_PLAIN = 'text/plain; charset="%charset"'

Plain text mime content type.

Definition at line 14 of file mailmessage.cls.php.

---

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

• gyro/core/lib/components/mailmessage.cls.php