Skip to main content

OutboundEmailPolicy

Struct OutboundEmailPolicy 

Source
pub struct OutboundEmailPolicy { /* private fields */ }
Expand description

Boot-resolved recipient policy shared by comm admission and email delivery. An absent policy permits queuing without claiming that delivery is configured.

Implementations§

Source§

impl OutboundEmailPolicy

Source

pub fn configured(recipients: Vec<String>) -> Result<Self, String>

Install a normalized recipient set; an explicitly empty set denies all recipients.

Source

pub fn is_configured(&self) -> bool

Source

pub fn allows(&self, recipient: &str) -> bool

Source

pub fn allows_external_sender(&self, actor_id: &str) -> bool

Source

pub fn has_external_senders(&self) -> bool

Source

pub fn external_daily_cap(&self) -> Option<u64>

Source

pub async fn lock_external_admission(&self) -> OwnedMutexGuard<()>

Source

pub fn recipient_key(&self, normalized_recipient: &str) -> Option<String>

The recipient key a recipient_key suppression entry matches, derived on demand as HMAC-SHA256(K_rk, normalized address) in lowercase hex; the raw bytes are never stored. None when no recipient-key secret is configured (external senders unset).

The footer text for external messages, or the reason it is unavailable. None while external senders are unset.

The separate footer for external list traffic, or the reason it is unavailable. None while external senders are unset; never consults the default footer.

Select the footer for an external send. List traffic never falls back to the default.

Source

pub fn suppression_mirror(&self) -> Option<&SuppressionMirror>

The remote suppression mirror, when one is configured (ADR-200 §6).

Source

pub fn mint_unsubscribe_token( &self, normalized_recipient: &str, ) -> Option<String>

Mint the unsubscribe token for a normalized external recipient, or None when the recipient-key secret or any token key is unavailable. The highest configured key id mints.

Source

pub fn verify_unsubscribe_token(&self, token: &str) -> Option<String>

Verify an unsubscribe token and return the recipient key text it identifies, or None on any malformed input or tag mismatch. Retired key ids keep verifying.

Source

pub fn from_env() -> Result<Self, String>

Read only public policy inputs, without loading a connector or credentials.

The unsubscribe key variables, the footer files and the suppression mirror variables are read only when external senders are configured; while the senders variable is unset none of them is consulted.

Trait Implementations§

Source§

impl Clone for OutboundEmailPolicy

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for OutboundEmailPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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