Skip to main content

ServerConfig

Struct ServerConfig 

Source
pub struct ServerConfig {
Show 17 fields pub domain: String, pub postmaster: String, pub smtp: SmtpServerConfig, pub imap: Option<ImapServerConfig>, pub jmap: Option<JmapServerConfig>, pub pop3: Option<Pop3ServerConfig>, pub storage: StorageConfig, pub processors: Vec<ProcessorConfig>, pub relay: Option<RelayConfig>, pub auth: Option<AuthConfig>, pub logging: Option<LoggingConfig>, pub queue: Option<QueueConfig>, pub security: Option<SecurityConfig>, pub domains: Option<DomainsConfig>, pub metrics: Option<MetricsConfig>, pub tracing: Option<TracingConfig>, pub connection_limits: Option<ConnectionLimitsConfig>,
}
Expand description

Main server configuration

Fields§

§domain: String§postmaster: String§smtp: SmtpServerConfig§imap: Option<ImapServerConfig>§jmap: Option<JmapServerConfig>§pop3: Option<Pop3ServerConfig>§storage: StorageConfig§processors: Vec<ProcessorConfig>§relay: Option<RelayConfig>§auth: Option<AuthConfig>§logging: Option<LoggingConfig>§queue: Option<QueueConfig>§security: Option<SecurityConfig>§domains: Option<DomainsConfig>§metrics: Option<MetricsConfig>§tracing: Option<TracingConfig>§connection_limits: Option<ConnectionLimitsConfig>

Implementations§

Source§

impl ServerConfig

Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Load configuration from a TOML or YAML file

The format is auto-detected based on file extension:

  • .toml files are parsed as TOML
  • .yaml or .yml files are parsed as YAML
Source

pub fn apply_env_overrides(&mut self)

Apply environment variable overrides to configuration

Environment variables follow the convention RUSMES_SECTION_KEY. Priority: env vars > config file > defaults

Supported environment variables:

  • RUSMES_DOMAIN
  • RUSMES_POSTMASTER
  • RUSMES_SMTP_HOST
  • RUSMES_SMTP_PORT
  • RUSMES_SMTP_TLS_PORT
  • RUSMES_SMTP_MAX_MESSAGE_SIZE
  • RUSMES_SMTP_REQUIRE_AUTH
  • RUSMES_SMTP_ENABLE_STARTTLS
  • RUSMES_SMTP_RATE_LIMIT_MAX_CONNECTIONS_PER_IP
  • RUSMES_SMTP_RATE_LIMIT_MAX_MESSAGES_PER_HOUR
  • RUSMES_SMTP_RATE_LIMIT_WINDOW_DURATION
  • RUSMES_IMAP_HOST
  • RUSMES_IMAP_PORT
  • RUSMES_IMAP_TLS_PORT
  • RUSMES_JMAP_HOST
  • RUSMES_JMAP_PORT
  • RUSMES_JMAP_BASE_URL
  • RUSMES_STORAGE_PATH (for filesystem backend)
  • RUSMES_LOG_LEVEL
  • RUSMES_LOG_FORMAT
  • RUSMES_LOG_OUTPUT
  • RUSMES_QUEUE_INITIAL_DELAY
  • RUSMES_QUEUE_MAX_DELAY
  • RUSMES_QUEUE_BACKOFF_MULTIPLIER
  • RUSMES_QUEUE_MAX_ATTEMPTS
  • RUSMES_QUEUE_WORKER_THREADS
  • RUSMES_QUEUE_BATCH_SIZE
  • RUSMES_METRICS_ENABLED
  • RUSMES_METRICS_BIND_ADDRESS
  • RUSMES_METRICS_PATH
  • RUSMES_TRACING_ENABLED
  • RUSMES_TRACING_ENDPOINT
  • RUSMES_TRACING_PROTOCOL (grpc or http)
  • RUSMES_TRACING_SERVICE_NAME
  • RUSMES_TRACING_SAMPLE_RATIO
  • RUSMES_CONNECTION_LIMITS_MAX_CONNECTIONS_PER_IP
  • RUSMES_CONNECTION_LIMITS_MAX_TOTAL_CONNECTIONS
  • RUSMES_CONNECTION_LIMITS_IDLE_TIMEOUT
  • RUSMES_CONNECTION_LIMITS_REAPER_INTERVAL
Source

pub fn validate(&self) -> Result<()>

Validate the entire configuration

This method is called automatically when loading configuration from a file. It validates:

  • Domain name format
  • Postmaster email address
  • Port numbers for SMTP, IMAP, JMAP
  • Storage path accessibility
  • Processor uniqueness
  • Local domain names (if configured)
Source

pub fn postmaster_address(&self) -> Result<MailAddress>

Get postmaster address

Trait Implementations§

Source§

impl Clone for ServerConfig

Source§

fn clone(&self) -> ServerConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ServerConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ServerConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,