This documentation covers the in-development release of Review Board. You can see the stable Review Board documentation or all previous versions.

reviewboard.notifications.email¶

Review Board e-mail module.

register_email_hook(signal: Signal, handler: EmailHook) → None¶

Register an e-mail hook.

Parameters:

signal (django.dispatch.Signal) – The signal that will trigger the e-mail to be sent. This is one of review_request_published, review_request_closed, review_published, or reply_published.
handler (reviewboard.extensions.hooks.EmailHook) – The EmailHook that will be triggered when an e-mail of the chosen type is about to be sent.

unregister_email_hook(signal: Signal, handler: EmailHook) → None¶

Unregister an e-mail hook.

Parameters:

signal (django.dispatch.Signal) – The signal that will trigger the e-mail to be sent. This is one of review_request_published, review_request_closed, review_published, or reply_published.
handler (reviewboard.extensions.hooks.EmailHook) – The EmailHook that will be triggered when an e-mail of the chosen type is about to be sent.