Manual:Hooks/UserMailerChangeReturnPath
From Linux Web Expert
| UserMailerChangeReturnPath | |
|---|---|
| <translate> Available from <tvar name=1><translate> version <tvar (Gerrit change 138655)</tvar></translate> Called to generate a VERP return address when UserMailer sends an email, with a bounce handling extension. | |
| <translate> Define function:</translate> | public static function onUserMailerChangeReturnPath( $to, &$returnPath ) { ... }
|
| <translate> Attach hook:</translate> | <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
"Hooks": {
"UserMailerChangeReturnPath": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserMailerChangeReturnPath"
}
}
|
| <translate> Called from:</translate> | <translate> File(s):</translate> mail/UserMailer.php |
| <translate> Interface:</translate> | UserMailerChangeReturnPathHook.php |
<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks</tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:UserMailerChangeReturnPath extensions</tvar>.</translate>
Hook to generate custom variable envelope return path address (VERP address) for 'Return-Path'. Called to generate a VERP return address when UserMailer sends an email, with a bounce handling extension.
Details
- $to: Array of MailAddress objects for the recipients
- &$returnPath: The return address string
