email.help.in
上传用户:knt0001
上传日期:2022-01-28
资源大小:264k
文件大小:10k
源码类别:

Email客户端

开发平台:

C/C++

  1. # Email help file
  2. #############
  3. # Help with help?  #############
  4. help|h|--help|-help|help|-h
  5.     
  6. --help | -help | -h "Module of Help"
  7.   This option can be specified with a module of help
  8.   topic, or without one.  Without a module of help topic,
  9.   it will just print a standard help screen with all
  10.   your possible options.  With a module of help option,
  11.   it will display a more detailed discription of that
  12.   module.
  13.   Modules are determined by command line switches.
  14.   For instance:  if you want to know about the 'encrypt'
  15.   command line option, you would specify --help 'encrypt'
  16.   or --help 'e' and help will display the correct module
  17.   help section.
  18.           
  19.   The Help is not statically programmed into email.
  20.   Instead it is a file in email's home directory called
  21.   'email.help'.  It is updated regularly and will always
  22.   be rewritten with every release of email.
  23.   
  24. EOH
  25. ###########
  26. # Verbose help
  27. ###########
  28. verbose|V|--verbose|-verbose|-V
  29. --verbose | -verbose | -V
  30.   Displays the progress of communicating with the SMTP
  31.   server. Tells what's going on and prints a pretty
  32.   progress bar when sending data.
  33.   This option has replaced the -quiet option which did
  34.   the exact opposite.
  35. EOH
  36. ###########
  37. # Subject help
  38. ###########
  39. subject|sub|s|--subject|-subject|--sub|-sub|-s
  40. --subject | -subject | -sub | -s "Subject of Email"
  41.   This option should be rather obvious.  You specify the
  42.   subject of the email with this option.  If you are not
  43.   redirecting to standard input and you do not specify a
  44.   subject, email will ask you for the subject.  Null
  45.   subjects are allowed.
  46.   
  47. EOH
  48. ###########
  49. # Encrypt help
  50. ###########
  51. encrypt|e|--encrypt|-encrypt|-e
  52. --encrypt | -encrypt | -e 
  53.         
  54.   This options allows you to encrypt your email message
  55.   using 'gpg'. GPG can be obtained by going to:
  56.   http://www.gnupg.org.
  57.   email will use the first person in the recipient list
  58.   to encrypt the message to. This email address must be
  59.   in the key list of GPG.  To figure out all of the 
  60.   UID's that gpg has on your system, you can run the 
  61.   command 'gpg --list-keys' and it will list them out.
  62. EOH
  63. ##########
  64. # Sign help
  65. ##########
  66. sign|--sign|-sign
  67. --sign | -sign
  68.           
  69.   This options will let you "clear sign" your emails
  70.   on the fly... It uses the 'gpg --detach-sign' option.
  71.   It will 'sign' the email with your public key.
  72. EOH
  73. ##########
  74. # CC Help
  75. ##########
  76. cc|--cc|-cc
  77. --cc | -cc recipient,recipient,recipient,...
  78.   "Carbon Copy"
  79.   This option allows you to "carbon copy" a list of
  80.   recipients. Recipients can be from the address book
  81.   or just plain email addresses.  They should be comma
  82.   delimited just as the main recipients will be.  CC
  83.   recipients *will* be posted in the headers and read
  84.   by email clients.
  85.   
  86. EOH
  87. ##########
  88. # Bcc Help
  89. ##########
  90. bcc|--bcc|-bcc
  91. --bcc | -bcc recipient,recipient,recipient,...
  92.   "Blind Carbon Copy"
  93.   Same as the --cc option, but these recipients will
  94.   *not* be posted in the headers of the email.  This
  95.   is a positive solution to if you wanted to "secretly"
  96.   copy someone on the email without the other recipients
  97.   knowing so ( Managers usually bcc their boss when
  98.   sending an email to you about your performance and
  99.   you'll never know it ;-) )
  100.   
  101. EOH
  102. ##########
  103. # Temporary SMTP server
  104. ##########
  105. smtp-server|r|--smtp-server|-smtp-server|-r
  106. --smtp-server | -r server
  107.   This option will let you override the smtp server
  108.   that is specified in the email.conf file...
  109.   Pretty easy option here....
  110.   
  111. EOH
  112. ##########
  113. # Temporary SMTP port
  114. ##########
  115. smtp-port|p|--smtp-port|-smtp-port|-p
  116. --smtp-port | -p port
  117.   This option will let you specify a temporary port for 
  118.   email to connect to.  This is helpful when you use the
  119.   --smtp-server option and you do not have a configuration
  120.   file.  If you do have a configuration file, this option 
  121.   wile override what is in the configuration file.
  122. EOH
  123. ##########
  124. # High Priority ?
  125. ##########
  126. high-priority|o|--high-priority|-high-priority|-o
  127. --high-priority | -o
  128.           
  129.   This options allows you to take advantage of using
  130.   the priority option used by some email clients.
  131.   If the option is specified when sent to a user
  132.   using MS Outlook, a small exclimation mark will
  133.   be next to the message as to let the user know
  134.   this email is important.
  135. EOH
  136. ###########
  137. # HTML ?
  138. ###########
  139. html|--html|-html
  140. --html
  141.   This option allows you to send html emails. As
  142.   of right now, you need to write your own html.
  143.   In later versions of email, it will make your
  144.   html for you...  This is not a high priority
  145.   issue though, so we will take our time on it.
  146.   ( Being as the lead developer *hates* html
  147.   emails being sent to him...  Ugh... )
  148.   
  149. EOH
  150. ###########
  151. # Attachments
  152. ###########
  153. attach|a|--attach|-attach|-a
  154. --attach file | -a file
  155.   This option allows you to attach files to your email.
  156.   It will encode your file with base64 and attach it with
  157.   standard MIME headers for the encoded file.  You can 
  158.   specify multiple files by using the attach option 
  159.   multiple times.
  160.   
  161. EOH
  162. ##########
  163. # Conf file
  164. ##########
  165. conf-file|c|--conf-file|-conf-file|-c
  166. --conf-file | -c /path/to/file
  167.   Specify this option if you would like to use a configuration
  168.   file other than the default configuration.  Email looks for 
  169.   the email.conf file in @sysconfdir@/email or ~/.email.conf.  If
  170.   you want to specify an different location, use this option.
  171. EOH
  172. #########
  173. # Check config help
  174. #########
  175. check-config|t|--check-config|-check-config|-t
  176. --check-config | -t
  177.   You use this option if you want to check to make sure that the
  178.   email.conf file is properly written.  What this means is that
  179.   the syntax of the file is correct.  Since email will give FATAL
  180.   errors upon improper syntax of the email.conf file, it's a good
  181.   idea to check the syntax after making any changes to the file.
  182.   You can specify the --conf-file option before this option to
  183.   check a specific file for gramatical errors.
  184. EOH
  185. ########
  186. # Blank email help
  187. ########
  188. blank-mail|b|--blank-mail|-blank-mail|-b
  189. --blank-mail | -b
  190.   Use this option if you want to send a message with no content.  
  191.   This is good if you want to send emails from the command line 
  192.   with just the headers of the message but no message itself. 
  193.   This option does not put anything in the message including 
  194.   the signature file.  If you want to send a message with the 
  195.   signature file, a good idea is to do something like this:
  196.   echo | email -s "Subject of message" name@domain.pos
  197.   This will simply put a newline (n) in the email and it will
  198.   let email know that you want to append your signature file
  199.   too.  
  200. EOH
  201. #######
  202. # GPG Password
  203. #######
  204. gpg-pass|gpg-password|g|--gpg-password|--gpg-pass|-gpg-password|-gpg-pass|-g
  205. --gpg-pass pass | -g pass
  206.   If you don't want to keep your gpg password (to use for signing and encryption)
  207.   in your email.conf file (GPG_PASS), then you can always use this command line 
  208.   option to specify it.
  209.   Helpful Info: GPG_BIN *must* be specified in email.conf for this option
  210.   to be effective.
  211. EOH
  212. #######
  213. # SMTP Username
  214. #######
  215. smtp-user|smtp-username|u|--smtp-username|--smtp-user|-smtp-user|-smtp-username|-u
  216. --smtp-user name | -u name
  217.   If you don't want to keep your SMTP username (for SMTP Authentication)
  218.   in your email.conf file (SMTP_AUTH_USER), then you can use this command line
  219.   option to specify it.
  220.   Helpful Info: SMTP_AUTH still *must* be specified in email.conf for this option
  221.   to be effective.
  222. EOH
  223. #######
  224. # SMTP Password
  225. #######
  226. smtp-pass|smtp-password|i|--smtp-password|--smtp-pass|-smtp-pass|-smtp-password|-i
  227. --smtp-pass pass | -i pass
  228.   If you don't want to keep your SMTP password (for SMTP Authentication)
  229.   in your email.conf file (SMTP_AUTH_PASS), then you can use this command line
  230.   option to specify it.
  231.   Helpful Info: SMTP_AUTH *must* be specified in email.conf for this option
  232.   to be effective.
  233. EOH
  234. ######
  235. # Senders name
  236. ######
  237. --from-name|-from-name|from-name|-n|n
  238. --from-name name | -n name
  239.   You can specify your name with this option.  Typically, you would put this
  240.   in email.conf under MY_NAME, but, if you are not using a configuration file
  241.   you can set it option this way.  This is the name the recipient will see
  242.   in the From: field of their mail client when reading your message.
  243. EOH
  244. ######
  245. # Senders email address
  246. ######
  247. --from-addr|-from-addr|from-addr|-f|f
  248. --from-addr addr | -f addr
  249.   
  250.   You can specify your email address with this option.  Typicall, you would 
  251.   put this in email.conf under MY_EMAIL, but, if you are not using a
  252.   configuration file, you can set it this way.  This is the email address the
  253.   recipient will see in the From: field of their mail client when reading your
  254.   message.
  255. EOH
  256. ######
  257. # SMTP AUTH Type
  258. ######
  259. --smtp-auth|-smtp-auth|smtp-auth|-m|m
  260.   You must specify this option to use SMTP AUTH if you
  261.   aren't using a configuration file.  'type' is the type
  262.   of AUTH your server lets you use.  There are two supported
  263.   AUTH types with email: PLAIN and LOGIN
  264. EOH
  265. ######
  266. # Headers
  267. ######
  268. --header|-header|header|-H|H
  269. --header string | -H string
  270.   
  271.   You can specify headers to include in the message. To do this, simply 
  272.   specify the entire header to this option. To specify multiple headers
  273.   you can either comma delimit each string, or specify the header option
  274.   multiple times (or both).
  275.   Example:
  276.   email --header "X-My-Header: Stuff" --header "X-Another-Header: Other Stuff"
  277.   Example:
  278.   email --header "X-My-Header: Stuff","X-Another-Header: Other Stuff"
  279. EOH
  280. ######
  281. # TLS
  282. ######
  283. --tls|-tls
  284. -tls
  285.   To turn on TLS, use this option.
  286. EOH
  287. ######
  288. # Timeout
  289. ######
  290. --timeout|-timeout|-x
  291. --timeout secs | -x secs
  292.   Specify a timeout period for sending/receiving on a socket. This is
  293.   helpful if you'd like the client to stop trying to send and receive
  294.   on a server that has stopped responding.
  295. EOH
  296. #####
  297. # Encoding
  298. #####
  299. --no-encoding|-no-encoding
  300. --no-encoding
  301.   If you don't want eMail to automatically use UTF-8 encoding when finding
  302.   non ascii characters, use this option.
  303. EOH
  304.