commands/sms/sms.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # sms.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name sms
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Send or receive text messages.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 The send functionality simply sends a text message to the specified mobile phone number. The receive functionality is intended to allow the handset it's running on to be remotely controlled. Any SMS that is received which started with C<#!fshell> or C<#!perl> is intercepted from the user's messaging inbox and instead is executed as a script. The script can make use of the environment variable SMS_SENDER with is set to the phone number that sent the message.
       
    22 
       
    23 Note, use of receive mode represents a significant security risk. It is recommended that the C<--match> option be used to restrict which sending parties the handset will allow control from.
       
    24 
       
    25 ==argument enum command
       
    26 
       
    27 The action to perform.
       
    28 
       
    29 ==enum-value send
       
    30 
       
    31 Send an SMS.
       
    32 
       
    33 ==enum-value receive
       
    34 
       
    35 Receive, intercept and execute all SMSs that start with C<#!fshell> or C<#!perl>.
       
    36 
       
    37 ==argument string message optional last
       
    38 
       
    39 The text to send. If not specified, C<send> will read from C<STDIN>.
       
    40 
       
    41 ==option string d destination
       
    42 
       
    43 The destination of the SMS. This option is required when sending an SMS, and ignored otherwise.
       
    44 
       
    45 ==option bool n no-delete
       
    46 
       
    47 Scripts that are received are stored in F<C:\shared\fshellN.script> (and F<perlN.pl>) while they are being executed. By default they are deleted when the script completes. Specify this option to not delete them - useful if you need to debug or examine a script.
       
    48 
       
    49 ==option string m match multiple
       
    50 
       
    51 A match string to limit the numbers from which shebang messages will be processed. Shebang messages from numbers that do not match will be discarded. Supports C<TDesC::Match> style wildcards.
       
    52 
       
    53 ==copyright
       
    54 
       
    55 Copyright (c) 2008-2010 Accenture. All rights reserved.
       
    56