sms2mailgw.1
上传用户:eo_sii
上传日期:2007-01-05
资源大小:91k
文件大小:5k
源码类别:

手机短信编程

开发平台:

Unix_Linux

  1. .TH SMS2MAILGW 1 "Project SMSLink" "Les Ateliers du Heron" " -*- nroff -*-
  2. .SH NAME
  3. sms2mailgw - SMS to mail gateway module
  4. .SH SYNOPSIS
  5. .B sms2mailgw
  6. .SH DESCRIPTION
  7. .B sms2mailgw
  8. is a daemon program that will process the mailbox file created by
  9. .B sms_serv
  10. (1) and extract from it the messages that comply with a specified format.
  11. Those messages will then be converted to an email-compatible format and
  12. handed over to an SMTP-compliant MTA (typically
  13. .B sendmail
  14. (1)) for delivery. The
  15. .B sms2mailgw
  16. daemon will automatically synchronize its mailbox-checking interval with
  17. the interval used by the
  18. .B sms_serv
  19. server module.
  20. .PP
  21. This manual page
  22. will cover the functionalities and use of
  23. .BR sms2mailgw .
  24. For installation and configuration instructions, please refer to the 
  25. INSTALL document, provided in the sources directory.
  26. .SS OPTIONS
  27. .TP
  28. None at the present time.
  29. .SH SMS MESSAGE FORMAT
  30. In order for an incoming SMS to be recognized as an email candidate by the
  31. .B sms2mailgw
  32. module, it has to comply to the following format:
  33. .I T: name[, name] [C: name[, name]] [B: name[, name]] [R: name] [F: name] [S: text#]body
  34. Please note that field headers are
  35. .B not
  36. case-sensitive, and can come in any order, except for the T: field that has
  37. to come first, and the S: field that has to come last before the message
  38. body. Multiple identical field headers are allowed. When a field can
  39. be multi-part, multiple identical fields are just added to each other. When
  40. such fields cannot be multi-part, the last occurance only will be used.
  41. .PP
  42. Also please note that the blank character between the ':' and the first letter
  43. of the field contents is optional. Optional as well is the blank following a
  44. comma in multi-part fields. But the blank separating the end of a field
  45. contents from the next field header is mandatory.
  46. .SS FIELDS AND FIELD CONTENTS
  47. .TP
  48. .I "T: (To: field)"
  49. Required. Has to be the first field (an SMS is not considered a candidate
  50. email message if it doesn't begin with "T:"). Multi-part allowed (multiple
  51. names are separated by commas). Names are expanded as explained below (see
  52. .I name
  53. ).
  54. .TP
  55. .I "C: (Cc: field)"
  56. Optional. Multi-part allowed (multiple names are separated by commas).
  57. Names are expanded as explained below (see
  58. .I name
  59. ).
  60. .TP
  61. .I "B: (Bcc: field)"
  62. Optional. Multi-part allowed (multiple names are separated by commas).
  63. Names are expanded as explained below (see
  64. .I name
  65. ).
  66. .TP
  67. .I "R: (Reply-To: field)"
  68. Optional. No multi-part support (any additional name entry after a comma
  69. is just dropped). When multiple "R:" fields are present, only the last
  70. one is used.
  71. Names are expanded as explained below (see
  72. .I name
  73. ).
  74. .br
  75. Use the Reply-To: field to make sure the destination user can send a reply
  76. to a regular mailbox instead of directing it back at the SMS gateway.
  77. .TP
  78. .I "F: (From: field)"
  79. Optional. No multi-part support (any additional name entry after a comma
  80. is just dropped). When multiple "F:" fields are present, only the last
  81. one is used.
  82. Names are expanded as explained below (see
  83. .I name
  84. ).
  85. .br
  86. When not provided by the user, the From: field is automatically filled
  87. with a default value (the username assigned to the gateway module concatenated
  88. with the origin GSM number, followed by the hostname the gateway runs on
  89. and the domain). This will be used to allow for replies to be routed back
  90. to the sending GSM.
  91. .TP
  92. .I "S: (Subject: field)"
  93. Optional. The field has to be terminated by a '#' character, to separate it
  94. from the body. The Subject field has to be the last one before the message
  95. body.
  96. .br
  97. When not provided by the user, a default Subject: field is used, along the
  98. lines of
  99. .I An SMS for you from <source GSM number>.
  100. .TP
  101. .I "body"
  102. The message body.
  103. .TP
  104. .I "name"
  105. Any email address. Some shortcuts are allowed. If your network infrastructure
  106. supports delivering mail to addresses such as, for instance
  107. "first_last@your.domain", and if the gateway host is member of your.domain,
  108. then all addresses specified without any '@' character in them will
  109. automatically get expanded as "address@your.domain". The domain the gateway
  110. host is working for can be overridden at compile-time.
  111. .br
  112. Please note that short and fully qualified version of email addresses can
  113. be mixed in fields that allow multi-part contents.
  114. .TP
  115. .I "text"
  116. A text field (for the subject, for instance). As this kind of field can contain
  117. whitespaces, please use the '#' character to mark its end.
  118. .SH FILES
  119. .PP
  120. .B /var/spool/smslink/inbox
  121. .br
  122. File where the incoming messages will be stored. The file format details
  123. are explained in the server module man page. See
  124. .B sms_serv
  125. (1).
  126. .PP
  127. .B /var/spool/smslink/checkpoint
  128. .br
  129. Empty file "touched" by the server module (in order to alter its timestamp)
  130. after a mailbox check. The timestamp info of this file is used by 
  131. .B sms2mailgw
  132. to synchronize its runs with the server module's checks.
  133. .SH BUGS
  134. Quite a few of them maybe, but still less bugs than lacking features at this
  135. stage.
  136. See the BUGS document, in the sources directory.
  137. .SH SEE ALSO
  138. .BR sms_serv "(1), " sendsms "(1), " gsmdevices "(5), " gsmaccess "(5)"
  139. .PP
  140. The INSTALL, TODO and README documents in the sources tree.
  141. .SH COPYRIGHT
  142. SMSLink is (c) Les Ateliers du Heron, 1998-2000 by Philippe Andersson
  143. <philippe_andersson@ste.scitex.com>. It has been originally written for
  144. Scitex Europe, S.A.
  145. .PP
  146. Part of the code is (c) Riccardo Facchetti.
  147. .PP
  148. The code also includes contributions from Philipp Klaus <pklaus@access.ch>.
  149. .PP
  150. SMSLink has been released to the public under the GNU GPL.