Home Maintained by HueStones
SourceForge.net Logo Make a donation

Penny Post Command Line Options



Generating Stamps


Use the -m option to generate stamps.

HashCash
ppost -m hashcash <version> <value> <resource> [-d <date-YYMMDD>] [-e <extensions>] [-o <outputfile>]

<version> - Can be 0 or 1 (1 is recommended)
<value> - A number specifying the desired StampCost
<resource> - The recepients email address

For Example:
ppost -m hashcash 1 10 help@pennypost.com


MBound
ppost -m mbound <version> <value> <pathlen> <resource> [-d <date-YYMMDD>] [-e <extension>] [-o <outputfile>]

<version> - Presently only version 0 is supported
<value> - A number specifying the desired StampCost
<pathlen> - A number specifying the desired depth for MBound
<resource> - The recepients email address

For Example:
ppost -m mbound 0 10 5 help@pennypost.com



Verifying Stamps


Use the -c option to verify stamps.

If stamp verification fails, the program will return a non-zero exit code. This will hopefully allow easy integration with scripts and other programs like TMDA.

HashCash
ppost -c hashcash <min-value> <token> [-x <date-diff-days>] [-o <outputfile>]

<min-value> - A number specifying the minimum StampCost required for a stamp to be accepted
<token> - The HashCash token to test for validity

For Example:
ppost -c hashcash 5 1:10:070811:help@pennypost.com::22980471:d37d4035


MBound
ppost -c mbound <min-value> <min-path> <max-path> <token> [-x <date-diff-days>] [-o <outputfile>]

<min-value> - A number specifying the minimum StampCost required for a stamp to be accepted
<min-path> - A number specifying the minimum depth required for the MBound stamp
<max-path> - A number specifying the maximum depth for which verification will be attempted for MBound
<token> - The MBound token to test for validity

For Example:
ppost -c mbound 5 5 20 0:10:5:070811:help@pennypost.com::fbe6277d:8d6cb78b



Extra Options


-t - Suppress status codes in output. This option only has effect when generating stamps.

-o <outputfile> - The output will be written to the specified output file instead of the screen

For Example (Redirect output to c:\result.txt):
ppost -m mbound 0 10 5 help@pennypost.com -o c:\result.txt


-d <date-YYMMDD> - The stamp will be generated for the specified date

For Example (Generate a stamp for 25 Jan 2007):
ppost -m mbound 0 10 5 help@pennypost.com -d 070125


-e <extension> - Specify additional data to include in the stamp, formatted as name1=value1;name2=value2 ...

For Example:
ppost -m mbound 0 10 5 help@pennypost.com -e sourceip=119.43.6.5;sourceclient=outlook


-x <date-diff-days> - The number of days between today and the stamp generation date between which the stamp is considered valid

For Example:
ppost -c hashcash 5 1:10:070811:help@pennypost.com::22980471:d37d4035 -x 2


-v - Display PennyPost version information

For Example:
ppost -v




CategoryCommandLineDocs
Creative Commons License
Penny Post Documentation by Aliasgar Lokhandwala is licensed under a Creative Commons Attribution-Non-Commercial-Share Alike 3.0 License.
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by Wikka Wakka Wiki
Page was generated in 0.0900 seconds