Glossia.Environment (glossia v0.1.0)
Glossia is configured at runtime using environment variables. This module provides an interface to read and validate the configuration.
All the configuration env. variables are scoped under the GLOSSIA_
prefix.
Summary
Functions
Returns the email adapter to use.
Returns the SMTP authentication to use.
Returns whether to use no MX lookups.
Returns the SMTP password to use.
Returns the SMTP port to use.
Returns the SMTP relay to use.
Returns the SMTP retries to use.
Returns whether to use SSL.
Returns whether to use TLS.
Returns the SMTP username to use.
Functions
Returns the email adapter to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
:smtp
- The SMTP adapter.
Raises
RuntimeError
if the email adapter is invalid.
Returns the SMTP authentication to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
atom()
- The SMTP authentication.
Example
iex> Glossia.Environment.email_smtp_auth() :always
Returns whether to use no MX lookups.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
boolean()
- Whether to use no MX lookups.
Example
iex> Glossia.Environment.email_smtp_no_mx_lookups() true
Returns the SMTP password to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
String.t()
- The SMTP password.
Example
iex> Glossia.Environment.email_smtp_password() "ilovepepperpotts"
Returns the SMTP port to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
integer()
- The SMTP port.
Example
iex> Glossia.Environment.email_smtp_port()
Returns the SMTP relay to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
String.t()
- The SMTP relay.
Example
iex> Glossia.Environment.email_smtp_relay() "smtp.avengers.com"
Returns the SMTP retries to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
integer()
- The SMTP retries.
Example
iex> Glossia.Environment.email_smtp_retries()
Returns whether to use SSL.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
boolean()
- Whether to use SSL.
Example
iex> Glossia.Environment.email_smtp_ssl() true
Returns whether to use TLS.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
atom()
- Whether to use TLS.
Example
iex> Glossia.Environment.email_smtp_tls() :always
Returns the SMTP username to use.
Parameters
env
- The environment variables to use. Defaults toSystem.get_env()
.
Returns
String.t()
- The SMTP username.
Example
iex> Glossia.Environment.email_smtp_user() "tonystark"