Crate mailbreeze

Crate mailbreeze 

Source
Expand description

§MailBreeze

Official Rust SDK for MailBreeze - Email Marketing & Transactional Email Platform.

§Quick Start

use mailbreeze::{MailBreeze, SendEmailParams};

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

    // Send an email
    let result = client.emails.send(&SendEmailParams {
        from: "sender@yourdomain.com".to_string(),
        to: vec!["recipient@example.com".to_string()],
        subject: Some("Hello from MailBreeze!".to_string()),
        html: Some("<h1>Welcome!</h1>".to_string()),
        ..Default::default()
    }).await?;

    println!("Email sent with message ID: {}", result.message_id);

    // Work with contacts in a specific list
    let contacts = client.contacts("list_xxx");
    let contact_list = contacts.list(&Default::default()).await?;

    Ok(())
}

Structs§

Attachment
Attachment object
Attachments
Attachments API resource
BatchAnalytics
Analytics for batch verification
BatchResults
Categorized batch results (clean, dirty, unknown email lists)
BatchVerificationResult
Batch verification result
CancelEmailResult
Cancel email result
ClientConfig
Configuration for the MailBreeze client
Contact
Contact object
Contacts
Contacts API resource - scoped to a specific contact list
ContactsResponse
Paginated list of contacts (API returns {contacts: [], pagination: {}})
CreateContactParams
Parameters for creating a contact
CreateListParams
Parameters for creating a list
CreateUploadParams
Parameters for creating an upload URL
Email
Email object (from list/get endpoints)
EmailList
Paginated list of emails (API returns {emails: [], pagination: {}})
EmailStats
Email statistics
EmailStatsResponse
Wrapper for email stats response from API
Emails
Emails API resource
HttpClient
HTTP client for MailBreeze API
List
Contact list object
ListContactsParams
Parameters for listing contacts
ListEmailsParams
Parameters for listing emails
ListListsParams
Parameters for listing lists
ListStats
Contact list statistics
Lists
Contact lists API resource
ListsResponse
Paginated list of contact lists
MailBreeze
Main MailBreeze client
MailBreezeBuilder
Builder for creating a MailBreeze client with custom configuration
Pagination
Pagination information returned with list endpoints
SendEmailParams
Parameters for sending an email
SendEmailResult
Result from sending an email
SuppressParams
Suppress params for contact suppression
UpdateContactParams
Parameters for updating a contact
UpdateListParams
Parameters for updating a list
UploadUrl
Upload URL response
Verification
Verification API resource
VerificationListItem
Verification list item (returned by list endpoint)
VerificationListResponse
Response from verification list endpoint
VerificationResult
Single email verification result
VerificationStats
Verification statistics

Enums§

ConsentType
Consent type for NDPR compliance
ContactStatus
Contact subscription status
EmailStatus
Email delivery status
Error
Error types for the MailBreeze SDK
SuppressReason
Reason for suppressing a contact
VerificationStatus
Verification result status

Type Aliases§

Result