1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
//! Module for checking the environment variable:
//! ``USER_EMAIL_VERIFICATION_ENABLED`` to detect
//! if user email verification is enabled
//!
/// is_verification_enabled
///
/// Helper function to determine if
/// user email verification is enabled
///
/// ## Roadmap
///
/// This should move into the
/// [`CoreConfig`](crate::core::core_config::CoreConfig)
/// server statics.
///
/// # Returns
///
/// `bool` where `true` - email verfication is enabled,
/// `false - email verification is disabled
///
/// # Examples
///
/// ```bash
/// # default - email verification enabled
/// export USER_EMAIL_VERIFICATION_ENABLED=1
/// ```
///
/// ```rust
/// use restapi::requests::user::is_verification_enabled::is_verification_enabled;
/// return is_verification_enabled();
/// ```
///