Omeka_Controller_Action_Helper_Mail

Package: Controller\ActionHelper

class Omeka_Controller_Action_Helper_Mail

extends Zend_Controller_Action_Helper_Abstract

Action helper for sending email.

Omeka_Controller_Action_Helper_Mail::__construct(Zend_View $view)
Parameters:
  • $view (Zend_View) – View to render as the message body.
Omeka_Controller_Action_Helper_Mail::__call($method, $args)

Delegate to the Zend_Mail instance.

Parameters:
  • $method (string) – Method called.
  • $args (array) – Arguments to method.
Omeka_Controller_Action_Helper_Mail::setSubjectPrefix($prefix)

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

Parameters:
  • $prefix (string) – Subject prefix.
Omeka_Controller_Action_Helper_Mail::setSubject($subject)

Set the subject of the email.

Parameters:
  • $subject (string) – Email subject.
Omeka_Controller_Action_Helper_Mail::setBodyFromView($viewScript, $html = false)

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

Parameters:
  • $viewScript (string) – View script path.
  • $html (bool) – Whether or not the assigned view script will render as HTML. Defaults to false.
Omeka_Controller_Action_Helper_Mail::send($transport = null)

Send the email.

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