Code cleanup
[openpgp-sendmail-classes.git] / examples.txt
1    * Example of usage:
2    * <?
3    *  header("Content-type: text/plain");
4    *  require("emailclass.php");
5    *  $a = new sendmail;
6    *  $a->from("noreply@kfwebs.net");
7    *  $a->add_to("@kfwebs.net");
8    *  $a->add_cc("user1@kfwebs.net");
9    *  $a->add_bcc("user2@kfwebs.net");
10    *  $a->subject("This is the subject - blah");
11    *  $a->body("This is a test\n\n");
12    *  $a->body("This is another line");
13    *  $a->gpg_set_key("test2");
14    *  $a->gpg_set_algo("twofish"); //default to AES256 if omitted
15    *  $a->attachment("/webs/development/WhoWroteSobig.pdf");
16    *  if($a->send()) echo "Mail sent"; 
17    * ***************************************************************
18    * If you want to use asymmetrical encryption instead 
19    * (Public Key Infrastructure) you will have to configure a keyring
20    * manually. Then you can use:
21    * $a->gpg_add_key("6b0b9508");
22    * $a->gpg_add_key("789ABCDE");
23    * $a->gpg_set_type(GPG_ASYMMETRIC);
24    * $a->gpg_set_homedir("/webs/development/.gnupg/");
25    * instead. now gpg_set_key is the keys to use and not the password, 
26    * GPG_ASYMMETRIC is a constant to 2, the constant GPG_SYMMETRIC is 1,
27    * but rarely used as it is the default.
28    * 
29    * To use the sign feature you have to set $a->gpg_set_sign(1); this 
30    * require a default key to be defined in the gpg.conf, using a line 
31    * such as default-key  4336E0CB
32    * ***************************************************************
33    * To sign outgoing messages: 
34    * $a = new sendmail_gpgsign;
35    * $a->from("kf@kfwebs.net");
36    * $a->add_to("webmaster@kfwebs.net");
37    * $a->subject("This is the subject - blah");
38    * $a->body("This is a test\n\n");
39    * $a->body("This is another line");
40    * $a->gpg_set_signing_key("0x4336E0CB");
41    * $a->gpg_set_algo("sha512"); // default to sha256
42    * $a->gpg_set_homedir("/webs/development/.gnupg/");
43    * $a->gpg_set_key("6b0b9508");
44    * $a->attachment("/webs/development/img_2670.jpg");
45    * if($a->send()) echo "Mail sent"; 
46