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
39
40
//! Module for checking the environment variable:
//! ``USER_EMAIL_VERIFICATION_REQUIRED`` to detect
//! if user email verification is required for
//! a user's login
//!
/// is_verification_required
///
/// Helper for determining if user
/// email verification is required for
/// login and access to resources
///
/// ## Roadmap
///
/// This should move into the
/// [`CoreConfig`](crate::core::core_config::CoreConfig)
/// server statics.
///
/// # Returns
///
/// `bool` where `true` - email verfication is required to login,
/// `false - email verification is required to login
///
/// # Examples
///
/// ```bash
/// # default is disabled - login without verifying email
/// export USER_EMAIL_VERIFICATION_REQUIRED=1
/// ```
///
/// ```rust
/// use restapi::requests::user::is_verification_required::is_verification_required;
/// return is_verification_required();
/// ```
///