sms2mailgw.1
上传用户:eo_sii
上传日期:2007-01-05
资源大小:91k
文件大小:5k
- .TH SMS2MAILGW 1 "Project SMSLink" "Les Ateliers du Heron" " -*- nroff -*-
- .SH NAME
- sms2mailgw - SMS to mail gateway module
- .SH SYNOPSIS
- .B sms2mailgw
- .SH DESCRIPTION
- .B sms2mailgw
- is a daemon program that will process the mailbox file created by
- .B sms_serv
- (1) and extract from it the messages that comply with a specified format.
- Those messages will then be converted to an email-compatible format and
- handed over to an SMTP-compliant MTA (typically
- .B sendmail
- (1)) for delivery. The
- .B sms2mailgw
- daemon will automatically synchronize its mailbox-checking interval with
- the interval used by the
- .B sms_serv
- server module.
- .PP
- This manual page
- will cover the functionalities and use of
- .BR sms2mailgw .
- For installation and configuration instructions, please refer to the
- INSTALL document, provided in the sources directory.
- .SS OPTIONS
- .TP
- None at the present time.
- .SH SMS MESSAGE FORMAT
- In order for an incoming SMS to be recognized as an email candidate by the
- .B sms2mailgw
- module, it has to comply to the following format:
- .I T: name[, name] [C: name[, name]] [B: name[, name]] [R: name] [F: name] [S: text#]body
- Please note that field headers are
- .B not
- case-sensitive, and can come in any order, except for the T: field that has
- to come first, and the S: field that has to come last before the message
- body. Multiple identical field headers are allowed. When a field can
- be multi-part, multiple identical fields are just added to each other. When
- such fields cannot be multi-part, the last occurance only will be used.
- .PP
- Also please note that the blank character between the ':' and the first letter
- of the field contents is optional. Optional as well is the blank following a
- comma in multi-part fields. But the blank separating the end of a field
- contents from the next field header is mandatory.
- .SS FIELDS AND FIELD CONTENTS
- .TP
- .I "T: (To: field)"
- Required. Has to be the first field (an SMS is not considered a candidate
- email message if it doesn't begin with "T:"). Multi-part allowed (multiple
- names are separated by commas). Names are expanded as explained below (see
- .I name
- ).
- .TP
- .I "C: (Cc: field)"
- Optional. Multi-part allowed (multiple names are separated by commas).
- Names are expanded as explained below (see
- .I name
- ).
- .TP
- .I "B: (Bcc: field)"
- Optional. Multi-part allowed (multiple names are separated by commas).
- Names are expanded as explained below (see
- .I name
- ).
- .TP
- .I "R: (Reply-To: field)"
- Optional. No multi-part support (any additional name entry after a comma
- is just dropped). When multiple "R:" fields are present, only the last
- one is used.
- Names are expanded as explained below (see
- .I name
- ).
- .br
- Use the Reply-To: field to make sure the destination user can send a reply
- to a regular mailbox instead of directing it back at the SMS gateway.
- .TP
- .I "F: (From: field)"
- Optional. No multi-part support (any additional name entry after a comma
- is just dropped). When multiple "F:" fields are present, only the last
- one is used.
- Names are expanded as explained below (see
- .I name
- ).
- .br
- When not provided by the user, the From: field is automatically filled
- with a default value (the username assigned to the gateway module concatenated
- with the origin GSM number, followed by the hostname the gateway runs on
- and the domain). This will be used to allow for replies to be routed back
- to the sending GSM.
- .TP
- .I "S: (Subject: field)"
- Optional. The field has to be terminated by a '#' character, to separate it
- from the body. The Subject field has to be the last one before the message
- body.
- .br
- When not provided by the user, a default Subject: field is used, along the
- lines of
- .I An SMS for you from <source GSM number>.
- .TP
- .I "body"
- The message body.
- .TP
- .I "name"
- Any email address. Some shortcuts are allowed. If your network infrastructure
- supports delivering mail to addresses such as, for instance
- "first_last@your.domain", and if the gateway host is member of your.domain,
- then all addresses specified without any '@' character in them will
- automatically get expanded as "address@your.domain". The domain the gateway
- host is working for can be overridden at compile-time.
- .br
- Please note that short and fully qualified version of email addresses can
- be mixed in fields that allow multi-part contents.
- .TP
- .I "text"
- A text field (for the subject, for instance). As this kind of field can contain
- whitespaces, please use the '#' character to mark its end.
- .SH FILES
- .PP
- .B /var/spool/smslink/inbox
- .br
- File where the incoming messages will be stored. The file format details
- are explained in the server module man page. See
- .B sms_serv
- (1).
- .PP
- .B /var/spool/smslink/checkpoint
- .br
- Empty file "touched" by the server module (in order to alter its timestamp)
- after a mailbox check. The timestamp info of this file is used by
- .B sms2mailgw
- to synchronize its runs with the server module's checks.
- .SH BUGS
- Quite a few of them maybe, but still less bugs than lacking features at this
- stage.
- See the BUGS document, in the sources directory.
- .SH SEE ALSO
- .BR sms_serv "(1), " sendsms "(1), " gsmdevices "(5), " gsmaccess "(5)"
- .PP
- The INSTALL, TODO and README documents in the sources tree.
- .SH COPYRIGHT
- SMSLink is (c) Les Ateliers du Heron, 1998-2000 by Philippe Andersson
- <philippe_andersson@ste.scitex.com>. It has been originally written for
- Scitex Europe, S.A.
- .PP
- Part of the code is (c) Riccardo Facchetti.
- .PP
- The code also includes contributions from Philipp Klaus <pklaus@access.ch>.
- .PP
- SMSLink has been released to the public under the GNU GPL.