Omeka_Controller_Action_Helper_Mail

class Omeka_Controller_Action_Helper_Mail

Package: Controller\ActionHelper

Action helper for sending email.

property _view

property _subject

Subject of the email.

property _subjectPrefix

Prefix (prepended to the subject).

__construct(Zend_View $view)

Parameters:

• $view (Zend_View) – View to render as the message body.

__call(string $method, array $args)

Delegate to the Zend_Mail instance.

Parameters:

• $method (string) – Method called.
• $args (array) – Arguments to method.

setSubjectPrefix(string $prefix)

Set the prefix for the subject header. Typically takes the form “[Site Name] ”.

Parameters:

• $prefix (string) – Subject prefix.

setSubject(string $subject)

Set the subject of the email.

Parameters:

• $subject (string) – Email subject.

setBodyFromView(string $viewScript, boolean $html =)

Render the given view and use it as the body of the email.

Parameters:

• $viewScript (string) – View script path.
• $html (boolean) – Whether or not the assigned view script will render as HTML. Defaults to false.

send(Zend_Mail_Transport_Abstract $transport)

Send the email.

Parameters:

• $transport (Zend_Mail_Transport_Abstract) – Optional defaults to null.