Legacy Documentation
You are using the documentation for version 3.5.17. Go here for the latest version or check here for your available upgrades to the latest version.
Email Module Extension Hooks¶
email_module_send_email_end¶
-
email_module_send_email_end($subject, $message, $approved_tos, $approved_recipients)¶ After emails are sent, do some additional processing.
How it’s called:
ee()->extensions->call('email_module_send_email_end', $subject, $message, $approved_tos, $approved_recipients); if (ee()->extensions->end_script === TRUE) return;
Parameters: - $subject (string) – Sanitized and parsed subject of the email
- $message (string) – Sanitized and parsed body of the email
- $approved_tos (array) – Email addresses in the form’s “to” field
- $approved_recipients (array) – Email addresses specified in the tag as recipients
Return type: Void
New in version 1.5.1.
email_module_tellafriend_override¶
-
email_module_tellafriend_override($qstring, $this)¶ Allow use of Tell-A-Friend for things besides channel entries.
How it’s called:
$tagdata = ee()->extensions->call('email_module_tellafriend_override', $qstring, $this); if (ee()->extensions->end_script === TRUE) return $tagdata;
Parameters: - $qstring (string) – Query string without comments or pagination information
- $this (object) – Email object
Returns: Rendered tagdata
Return type: String
New in version 1.5.1.