README
上传用户:knt0001
上传日期:2022-01-28
资源大小:264k
文件大小:11k
源码类别:

Email客户端

开发平台:

C/C++

  1. Welcome to the README File.
  2. This will explain the email program as well as it can.  
  3. First thing is first.  This file will take place as sort of a 
  4. FAQ sheet, because I already know what questions will be asked.
  5. So read along.
  6. Q: What is 'email' ?
  7. A:  'email' is a program I designed that will send email via the command line
  8.     to remote smtp servers or use 'sendmail' internally, and fully interact with
  9.     GNUPG to encrypt and sign your e-mails, so you decide to do so...
  10.     You can get GNUPG at: http://www.gnupg.org
  11. Q: How do I compile and Install this damn thing?
  12. A:  Good question, I mean if I weren't to tell you how, you may 
  13.     actually have to go figure it out on your own... Heaven forbid...
  14.     Anyway, just do this:
  15.     
  16.     ./configure
  17.     make
  18.     su -c 'make install'
  19. Q: Where is it installed?
  20. A:  the executable is called 'email' and is installed in a directory that
  21.     is under the prefix or bindir specified during the ./configure of email.  
  22.     If you choose to specify a prefix during configure, it will go under $bindir
  23.     Which, by default, is an offset of $prefix/bin.  If you specify --bindir
  24.     then the binary will be put in $bindir.
  25.     If you do not specify a directory prefix during configure, then it will 
  26.     go under /usr/local/bin/email.  The configuration files are installed by
  27.     default in /usr/local/etc/email.  However, if you specify the --sysconfdir
  28.     option during ./configure, then the configuration files will go in $sysconfdir.
  29.     
  30.     Please view ./configure --help
  31. Q: How do I make your freakin' program work?
  32. A:  Well, first thing you should do, is configure this email client.
  33.     You will have the configuration file in /usr/local/etc/email/email.conf
  34.     Another thing to look for in /usr/local/etc/email (Or the choosen 
  35.     --prefix during ./configure) is for a script named emailconf.  This
  36.     script will walk you through steps to fully configure email.  Some
  37.     less important options are not set (address_book, save_sent_mail, temp_dir
  38.     reply_to, signature_file, signature_divide) but you can easily set these
  39.     by hand and they are not needed to properly run email.
  40.     You will see it has a few options you must set to your environment.
  41.     1: SMTP_SERVER:        Please specify your smtp server name, or IP address here
  42.     2: SMTP_PORT:        Please specify your smtp servers port number for use
  43.     3: MY_NAME           Please specify your Name here
  44.     4: MY_EMAIL:         Please specify your email address here
  45.     5: REPLY_TO:         Specify a seperate reply to address here
  46.     6: SIGNATURE_FILE:    Specify your signature file
  47.     7: ADDRESS_BOOK:    Where to find your address book file
  48.     8: SAVE_SENT_MAIL:     What directory to save the email.sent file to
  49.     9: TEMP_DIR:           Specify where to store temporary files
  50.    10: GPG_BIN:            Specify where the gpg binary is located.
  51.    11: GPG_PASS:           Optional passphrase for gpg.
  52.    12: SMTP_AUTH:          LOGIN or PLAIN are supported SMTP AUTH types
  53.    13: SMTP_AUTH_USER:     Your SMTP AUTH username
  54.    14: SMTP_AUTH_PASS:     Your SMTP AUTH Password
  55.    15: USE_TLS             Boolean (true/false) to use TLS/SSL
  56.    16: VCARD               Specify a vcard to attach to each message
  57.     SMTP_SERVER can be either a remote SMTP servers fully qualified domain name, or
  58.     an IP address.  You may also opt to use 'sendmail' internally instead of sending
  59.     via remote SMTP servers.  To do this you just put the path to the sendmail
  60.     binary and any options you would like to use with sendmail (Use -t) in the place
  61.     of the smtp server name... HINT: If you would like to send emails to people on
  62.     your local box (i.e. djones@localhost ), then you must use the sendmail binary.
  63.     When you are specifying file paths, you can use the tilde wildcard as you 
  64.     could in the shell to specify your home directory. Example: ~/.email.conf
  65.     would mean /home/user/.email.conf to the email program.
  66.     Once you are done here, you can leave your email in /usr/local/etc/email/email.conf
  67.     or the directory you specified during the configure with --sysconfdir=...
  68.     for a global configuration, or in your local home directory as ~/.email.conf for
  69.     a personal configuration.  Personal configs override global configs.  
  70.     You can get online help by using the --help option with email and specifying
  71.     the command line option you need help with.  Example: email --help encrypt
  72.     If you use the -encrypt or -sign option, you MUST have GNUPG installed on your system.
  73.     email uses gpg to encrypt the email to the FIRST email recipient
  74.     Example: email -s "This is the subject" -encrypt dean@somedomain.org
  75.     
  76.     in that example, I would be sending the email to dean@somedomain.org and gpg would
  77.     encrypt it with the key of dean@somedomain.org
  78.     You can use -high-priority ( or -o ) to send your message in a high priority
  79.     matter.  In MS Outlook you will see a little '!' mark next to the letter so that
  80.     the recipient will see that the message is high priority!
  81.     You can send a message in one of two ways:
  82.     The first way is to already have a message ready to send.  Say if I have a file named
  83.     "this.txt"  and I want to send it to 'dean@somedomain.org'.  I can redirect this file to
  84.     the email program in one of two ways.  Example below:
  85.     cat this.txt | email -s "Sending this.txt to you" dean@somedomain.org
  86.     or
  87.     email -s "Sending this.txt to you" dean@somedomain.org < this.txt
  88.     If you want to create a message, you will need to do two things here.
  89.     First set the environment variable "EDITOR" to your favorite editor. 
  90.     Example: 'export EDITOR=vi'
  91.     Please use your favorite editor in place of vi.
  92.     Now all you have to do is execute the example below:
  93.     Example: email -s "Subject" dean@somedomain.org
  94.     This will open up your favorite editor and let you write a email to dean@somedomain.org
  95.     email will default to 'vi' if you do not set EDITOR.
  96.     You can send to multiple recipients with 'email'.  All you have to do is
  97.     put commas between the email addresses you want the message to be sent to.
  98.     Example below:
  99.     dean@somedomain.org,another@domain.com,you@domain.com 
  100.     Here are some more examples below:
  101.     Example: the below command will send a message that is encrypted with 'dean@somedomain.org' key
  102.     email -s "my email to you" -encrypt dean@somedomain.org,software@cleancode.org
  103.     Example: the example will sign the message directed to it.
  104.     email -s "signed message" -sign dean@somedomain.org < secret_stuff.txt
  105.     Example: This will send to multiple recipients 
  106.     email -s "To all of you" dean@somedomain.org,you@domain.com,me@cleancode.org 
  107.     Example: Set message to high priority
  108.     email -s "High priority email" -high-priority dean@somedomain.org
  109.     Example: Send message with 2 attachements
  110.     email -s "here you go..." -attach file -attach file2 dean@somedomain.org
  111.     Example: Add headers to the message
  112.     email -s "New Message" --header "X-My-Header: Stuff" 
  113.       --header "X-Another-Header: More Stuff" dean@somedomain.org
  114. Q: Do you allow signatures?
  115. A:  Yes, we do.
  116.     Look in email.conf and edit the signature variables as needed.
  117.     If you're wondering what a signature divider is, it's the little
  118.     thingy that divides your email message from the signature.
  119.     Usually it's '---' (Default)
  120.     Also, you can specify wild cards in the signature file.  
  121.     %c = Formated time, date, timezone ( looks like the output of 'date' )
  122.     %t = Time only ( US Standard format )
  123.     %d = Date Only ( US Standard format )
  124.     %v = Version ( For us folks who want to endorse 'email' )
  125.     %h = Host type (ex. Linux 2.2.19 i686 )
  126.     %f = Prints output from the 'fortune(6)' command
  127.     %% = Prints a % mark
  128.     Your sig could look like this:
  129.     ---
  130.     This message was sent: %c
  131.     This would end up looking like: 
  132. This message was sent: Thu Dec 13 04:54:52 PM EST 2001
  133. Q: How does the address Book work?
  134. A:  Set up your email.conf file to point to your very own address book.
  135.     There is a template in the email source directory that you can view to set up your 
  136.     own address book.  The format should be as below:
  137. Any single name to email translation will have to have a 'single:' token before it:
  138.   single: Software    = software ^at^ cleancode.org
  139.   single: Dean        = dean@somedomain.org
  140.   single: "Full Name" = someone@somedomain.org
  141. Any group name to email translation will have to have a 'group:' token before it: 
  142. With groups, you can only use the Names of your single statements above... Format below:
  143.   group: Both = Software,Dean
  144.     See the email.address.template file for more information
  145. Q: Do you allow attachments?
  146. A:  YES!  We now support attachments with email!
  147.     Simply specify the files you want attached to your email by specifying the --attach
  148.     option, with a list of files delemited by commas.  All files will be encoded with
  149.     base64 and attached with the appropriate MIME headings.
  150.     
  151.     Example:
  152.     
  153.       email -s Attachment --attach file dean@somedomain.org
  154.       # Multiple files
  155.       email -s Attachments --attach file1 --attach file2 dean@somedomain.org
  156.       
  157. Q: Do you allow SMTP AUTH?
  158. A:  Yes! Email does SMTP AUTH.  You will need to set a few options in the email.conf
  159.     file.  SMTP_AUTH, SMTP_AUTH_USER and SMTP_AUTH_PASS.  If you want to know more
  160.     about this, please view the email manual page 'man email'.
  161. Q: Can I join the development team?
  162. A:  Yes, send an email at http://www.cleancode.org/projects/email
  163. Q: What Music did you listen to while writing it?
  164. A:  Mainly I listen to trance, house, jungle... Sometimes some radiohead
  165.     or even some Depeche Mode.  Sometimes I'm guilty of listening to country
  166.     music and even a new pop song... Just don't tell anyone.
  167. Q: Why email?
  168. A:  Because 'mailx' won't send to remote smtp servers and I remove sendmail everytime
  169.     I install Slackware!!  I needed something that would communicate with Remote
  170.     smtp servers and encrypt my messages on the fly instead of taking numorous steps to 
  171.     do so.
  172. Q: What does 'email' stand for?
  173. A:  Well, despite popular belief, it stands for "Encrypted Mail"  Not "Electronic Mail"
  174.     My initial purpose was to make e-mail easier to send via command line and encrypt it
  175.     with out taking all the damn steps 'mailx' makes you take!   Sorry mailx!  
  176. Q: Who are the developers?
  177. A:  Dean Jones - Main developer
  178. Q: Can I contact the developers via IM's?
  179. A:  Yes.  You can contact Dean via AOL IM as intargc
  180. That's about it so far. 
  181. I hope you like the program 'email'.
  182. If you have any questions, bugs, or concerns email us at:
  183. http://email.cleancode.org/?pid=contact
  184. Happy mailing!