Merge pull request #800 from tphoney/MODULES-5382

MODULES-5382 Add documentation for email functions

Author: pmcmaw

README.md

@@ -1208,6 +1208,13 @@ Returns `true` if the string passed to this function is a syntactically correct
 
 *Type*: rvalue.
 
+#### `is_email_address`
+
+Returns true if the string passed to this function is a valid email address.
+
+*Type*: rvalue.
+
+
 #### `is_float`
 
 **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**
@@ -2029,6 +2036,27 @@ validate_domain_name('www.example.2com')
 
 *Type*: statement.
 
+#### `validate_email_address`
+
+Validate that all values passed are valid email addresses. Fail compilation if any value fails this check.
+
+The following values will pass:
+
+~~~
+$my_email = "[email protected]"
+validate_email_address($my_email)
+validate_email_address("[email protected]", "[email protected]", $my_email)
+~~~
+
+The following values will fail, causing compilation to abort:
+
+~~~
+$some_array = [ 'bad_email@/d/efdf.com' ]
+validate_email_address($some_array)
+~~~
+
+*Type*: statement.
+
 #### `validate_hash`
 
 **Deprecated. Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).**