Struct SmsMessage 

pub struct SmsMessage {
    pub from: Option<String>,
    pub body: String,
    pub to: Option<String>,
    pub source: Option<String>,
    pub schedule: Option<i64>,
    pub custom_string: Option<String>,
    pub list_id: Option<i64>,
    pub country: Option<String>,
    pub from_email: Option<String>,
}

A single SMS to be sent.

Build with SmsMessage::new then chain optional setters. Wrap in SmsMessageCollection to send.

Fields

from: Option<String>

Sender ID — alphanumeric (e.g. "MyBrand") or E.164 number you own. If None, ClickSend picks a shared number.

body: String

Message text. Long messages get split into parts and billed per part.

to: Option<String>

Recipient in E.164 (+15551234567). Either this or Self::list_id.

source: Option<String>

Free-form tag of where this came from (e.g. "rust"). Defaults to "rust".

schedule: Option<i64>

Unix timestamp for scheduled send. None = immediate.

custom_string: Option<String>

Your reference id; echoed back in delivery receipts and replies.

list_id: Option<i64>

Send to a saved contact list instead of Self::to.

country: Option<String>

ISO country (e.g. "US") — improves routing for some numbers.

from_email: Option<String>

Where replies should be emailed.

Implementations

impl SmsMessage

pub fn new(to: impl Into<String>, body: impl Into<String>) -> Self

New SMS with required to and body. Source defaults to "rust".

pub fn from(self, from: impl Into<String>) -> Self

Set the sender id.

pub fn schedule(self, ts: i64) -> Self

Schedule for later (unix timestamp).

pub fn custom_string(self, s: impl Into<String>) -> Self

Tag the message with your own reference.

Trait Implementations

impl Clone for SmsMessage

fn clone(&self) -> SmsMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SmsMessage

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

Formats the value using the given formatter.

impl Default for SmsMessage

fn default() -> SmsMessage

Returns the “default value” for a type.

impl Serialize for SmsMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.