optus-websms

NAME

optus-websms - send a SMS using Optus' http://www.optuszoo.com.au/ website

SYNOPSIS

echo message | optus-websms numbers

ARGUMENTS

Arguments should contain only digits. No spaces, hyphens or other punctuation should be used. You may give several mobile numbers.

The Optus Web SMS allows sending to many networks, including Optus, Telstra, Orange and Vodafone within Australia and many networks outside Australia. See http://www.optuszoo.com.au/ for more details.

the message

The message is accepted from standard input and/or from the --message option and is then filtered:

Only printable characters and spaces are accepted
Repeated spaces are suppressed.
Other characters are silently ignored.

OPTIONS

--message=string: Use the provided string as the message. Anything from standard input will be placed after this string (unless --no-stdin is given).
--no-stdin: Ignore standard input completely.
--maxchars=<number>: The maximum number of characters in the message. The default of 160 is the common size for a single SMS "segment". Larger numbers are supported by the Optus Web SMS; however, they may incur higher charges and/or result in multiple SMSes.
--truncate: Silently trucate the message at the maximum length rather then exiting with an error message.
--test: Don't send the message, just display the character count and the message as it would have been sent.
--rc=file: Use the named files for our config. See FILES below.
--version: Print the version string and exit.
--man: Print the manual page and exit.
--help: Print a brief help message and exit.

DESCRIPTION

This program is a simple interface to the Optus Web SMS service available to authorized users from the http://www.optuszoo.com.au/ website.

The Optus Web SMS service has Terms and Conditions and you should understand these before your configure this tool to use your account.

EXIT CODES

This program will exit with a zero exit status upon success. No output is produced on stdout.

This program will exit with a non-zero exit status if there was an error, with details on standard error.

FILES

If no file is given with the --rc option, the following locations are checked (in order) and the first match is used.

$HOME/.optus-websmsrc
/usr/local/etc/optus-websmsrc
/etc/optus-websmsrc

This two line file must contain your phone number (all digits, no spaces) on the first line and your password (accepted as-is) on the second line.

EXAMPLES

Send a congratulatory message to the author:

    echo Congratulations, Mark | optus-websms 0411262316

Same as above, but using --message option:

    optus-websms --message "Congratulations, Mark" 0411262316

Announce a meeting to a three phones:

    echo Meeting at 2pm in room 42 | optus-websms 0411111111 0422222222 0433333333

Report a disk space problem to the sysadmin, with part of the df output, truncated to fit in a single SMS:

    df | optus-websms --truncate --message "Space low: " 0411111111

See what that message would look like:

    df | optus-websms --test --truncate --message "Space low: " 0411111111

THANKS

Brian Meilak <brian.meilak@miju.com.au>: Very good suggestions for improving this documentation.
AusCERT staff: Several features, including the --message and ---rc options.
Garth Douglass <Garth@aipl.com.au>: Updates to the script when Optus changed their site.
Indy Siva <i.siva@griffith.edu.au>: Updates to the script when Optus changed their site.

AUTHOR

Mark Suter <suter@humbug.org.au>

LICENSE AND COPYRIGHT

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.