Struct FreeMobileClient 

pub struct FreeMobileClient { /* private fields */ }

FreeMobile SMS API client

This client handles all communication with the FreeMobile API, including message sanitization, chunking, and proper error handling.

Example

use freemobile_api::{FreeMobileClient, Credentials};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let credentials = Credentials::new(
        "12345678".to_string(),
        "your-api-key".to_string()
    );
     
    let client = FreeMobileClient::new(credentials)?;
    client.send("Hello World! ✅").await?;
     
    Ok(())
}

Implementations

impl FreeMobileClient

pub fn new(credentials: Credentials) -> Result<Self, FreeMobileError>

Create a new FreeMobile client

Arguments

• credentials - Valid FreeMobile API credentials

Errors

Returns FreeMobileError::InvalidCredentials if credentials are invalid or FreeMobileError::HttpError if HTTP client creation fails.

pub async fn send(&self, message: &str) -> Result<(), FreeMobileError>

Send an SMS message

This method automatically handles:

• Message sanitization (emoji replacement)
• Message chunking for long texts
• Rate limiting between chunks

Arguments

• message - The message to send (will be sanitized automatically)

Errors

• FreeMobileError::EmptyMessage - If message is empty after trimming
• FreeMobileError::InvalidCredentials - If API credentials are rejected
• FreeMobileError::TooManyRequests - If rate limit is exceeded
• FreeMobileError::HttpError - For network-related errors

Example

client.send("Hello World! ✅").await?;

pub async fn send_sanitized( &self, sanitized_message: &str, ) -> Result<(), FreeMobileError>

Send a pre-sanitized message

Use this method if you want to handle sanitization yourself or send a message that has already been processed.

Arguments

• sanitized_message - Pre-sanitized message content

pub fn sanitize_message(&self, message: &str) -> String

Sanitize a message without sending it

This method applies the same emoji sanitization that would be applied during sending, useful for previewing changes.

Arguments

• message - Raw message to sanitize

Returns

The sanitized message with supported emojis preserved and unsupported ones replaced with []

Trait Implementations

impl Debug for FreeMobileClient

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

Formats the value using the given formatter.