Contacts

Struct Contacts 

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

Contacts API resource - scoped to a specific contact list

All contact operations are performed within the context of a specific list. Get a contacts instance by calling client.contacts(list_id).

§Example

use mailbreeze::MailBreeze;

#[tokio::main]
async fn main() -> mailbreeze::Result<()> {
    let client = MailBreeze::new("your_api_key")?;

    // Get contacts for a specific list
    let contacts = client.contacts("list_123");

    // Create a contact in this list
    let contact = contacts.create(&mailbreeze::CreateContactParams {
        email: "user@example.com".to_string(),
        first_name: Some("John".to_string()),
        ..Default::default()
    }).await?;

    // List contacts in this list
    let list = contacts.list(&Default::default()).await?;

    Ok(())
}

Implementations§

Source§

impl Contacts

Source

pub fn new(client: HttpClient, list_id: impl Into<String>) -> Self

Source

pub async fn create(&self, params: &CreateContactParams) -> Result<Contact>

Create a new contact in the list

Source

pub async fn get(&self, id: &str) -> Result<Contact>

Get a contact by ID

Source

pub async fn update( &self, id: &str, params: &UpdateContactParams, ) -> Result<Contact>

Update a contact

Source

pub async fn delete(&self, id: &str) -> Result<()>

Delete a contact

Source

pub async fn list( &self, params: &ListContactsParams, ) -> Result<ContactsResponse>

List contacts in the list with optional filters

Source

pub async fn suppress(&self, id: &str, reason: SuppressReason) -> Result<()>

Suppress a contact

Suppressed contacts will not receive any emails. This is different from unsubscribing - suppression is typically used for bounces, complaints, or manual removal.

Trait Implementations§

Source§

impl Clone for Contacts

Source§

fn clone(&self) -> Contacts

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 Contacts

Source§

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

Formats the value using the given formatter. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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