Merge pull request #1021 from ExpressionEngine/fr/new-email-addy-hooks

Adding email address hooks docs

Author: TomJaeger

docs/development/extension-hooks/cp/login.md

@@ -54,7 +54,7 @@ How it's called:
 
     $this->extensions->call('cp_member_logout');
     if ($this->extensions->end_script === TRUE) return;
-
+	
 ## `cp_member_reset_password()`
 
 | Parameter | Type   |
@@ -67,3 +67,22 @@ How it's called:
 
     $this->extensions->call('cp_member_process_reset_password');
     if ($this->extensions->end_script === TRUE) return;
+
+## `cp_member_send_reset_token_start($address)`
+
+| Parameter | Type     | Description
+| --------- | -------- | ---------------------------------------------------------------
+| $address  | `String` | Email address posted from the control panel reset password form
+| Returns   | `String` | Email address after extension processes it
+
+Additional processing of email address sent via control panel reset password form. 
+
+How it's called:
+
+    if (ee()->extensions->active_hook('member_auth_send_reset_token_start')) {
+        $address = ee()->extensions->call('member_auth_send_reset_token_start', $address);
+        if (ee()->extensions->end_script === true) {
+            return;
+        }
+    }
+

docs/development/extension-hooks/global/email.md

@@ -13,8 +13,50 @@ lang: php
 
 # Email Library Extension Hooks
 
+## `email_from_address($from, $name)`
+
+| Parameter | Type     | Description
+| --------- | -------- | --------------------------------------
+| $from     | `String` | Email `from` address
+| $name     | `String` | Email `name` for `from` address
+| Returns   | `Array`  | Associative array 
+
+Overwrite an email `from` address.
+
+How it's called:
+
+    if (ee()->extensions->active_hook('email_from_address')) {
+        $processed_address = ee()->extensions->call('email_from_address', $from, $name);
+        $from = $processed_address['from'] ?? $from;
+        $name = $processed_address['name'] ?? $name;
+		
+        if (ee()->extensions->end_script === true) {
+            return;
+        }
+    }
+
+## `email_to_address($to)`
+
+| Parameter | Type     | Description
+| --------- | -------- | --------------------------------------
+| $to       | `String` | Email `from` address
+| Returns   | `String` | Manipulated Email `to` address
+
+Overwrite an email `to` address.
+
+How it's called:
+
+    if (ee()->extensions->active_hook('email_to_address')) {
+        $to = ee()->extensions->call('email_to_address', $to);
+		
+        if (ee()->extensions->end_script === true) {
+            return;
+        }		
+    }
+
 ## `email_send(&$data)`
 
+
 | Parameter | Type      | Description                                                                                                                                                                                     |
 | --------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | &\$data   | `Array`   | Array of data about email to be sent (see above) passed [by reference](https://php.net/manual/en/language.references.pass.php) so data may be altered without needing to return the altered data |

docs/development/extension-hooks/module/member-auth.md

@@ -69,6 +69,24 @@ How it's called:
     $edata = ee()->extensions->call('member_member_logout');
     if (ee()->extensions->end_script === TRUE) return;
 
+## `member_auth_send_reset_token_start($address)`
+
+| Parameter | Type     | Description
+| --------- | -------- | ---------------------------------------------
+| $address  | `String` | Email address posted from reset password form
+| Returns   | `String` | Email address after extension processes it
+
+Additional processing of email address sent via reset password form.  Happens after basic security checks, but before email address check occurs.
+
+How it's called:
+
+    if (ee()->extensions->active_hook('member_auth_send_reset_token_start')) {
+        $address = ee()->extensions->call('member_auth_send_reset_token_start', $address);
+        if (ee()->extensions->end_script === true) {
+            return;
+        }
+    }
+
 ## `member_process_reset_password()`
 
 | Parameter | Type    | Description                                |