1.1 --- a/src/message_api.h Mon Jan 26 13:11:40 2015 +0100
1.2 +++ b/src/message_api.h Sun Feb 08 11:33:04 2015 -0500
1.3 @@ -7,47 +7,22 @@
1.4 #include "transport.h"
1.5
1.6
1.7 -// mime_encode_parts() - encode message with MIME
1.8 -// parameters:
1.9 -// src message to encode
1.10 -// dst encoded message or NULL on error
1.11 -//
1.12 -// return value:
1.13 -// error status or PEP_STATUS_OK on success
1.14 -//
1.15 -// caveat:
1.16 -// message must be unencrypted
1.17 -
1.18 -DYNAMIC_API PEP_STATUS mime_encode_parts(const message *src, message **dst);
1.19 -
1.20 -
1.21 -// mime_decode_parts() - decode MIME message
1.22 -// parameters:
1.23 -// src message to decode
1.24 -// dst decoded message or NULL on error
1.25 -//
1.26 -// return value:
1.27 -// error status or PEP_STATUS_OK on success
1.28 -//
1.29 -// caveat:
1.30 -// message must be unencrypted
1.31 -
1.32 -DYNAMIC_API PEP_STATUS mime_decode_parts(const message *src, message **dst);
1.33 -
1.34 -
1.35 // encrypt_message() - encrypt message in memory
1.36 //
1.37 // parameters:
1.38 -// session session handle
1.39 -// src message to encrypt
1.40 -// extra extra keys for encryption
1.41 -// dst pointer to encrypted message or NULL on failure
1.42 -// format encryption format
1.43 +// session (in) session handle
1.44 +// src (in) message to encrypt
1.45 +// extra (in) extra keys for encryption
1.46 +// dst (out) pointer to encrypted message or NULL on failure
1.47 +// format (in) encryption format
1.48 //
1.49 // return value:
1.50 -// error status or PEP_STATUS_OK on success; PEP_KEY_NOT_FOUND if one
1.51 -// or more keys couldn't be found, but the message could be encrypted
1.52 -// with other keys
1.53 +// PEP_STATUS_OK on success
1.54 +// PEP_KEY_NOT_FOUND at least one of the receipient keys
1.55 +// could not be found
1.56 +// PEP_KEY_HAS_AMBIG_NAME at least one of the receipient keys has
1.57 +// an ambiguous name
1.58 +// PEP_GET_KEY_FAILED cannot retrieve key
1.59
1.60 DYNAMIC_API PEP_STATUS encrypt_message(
1.61 PEP_SESSION session,
1.62 @@ -61,9 +36,9 @@
1.63 // decrypt_message() - decrypt message in memory
1.64 //
1.65 // parameters:
1.66 -// session session handle
1.67 -// src message to decrypt
1.68 -// dst pointer to decrypted message or NULL on failure
1.69 +// session (in) session handle
1.70 +// src (in) message to decrypt
1.71 +// dst (out) pointer to decrypted message or NULL on failure
1.72 //
1.73 // return value:
1.74 // error status or PEP_STATUS_OK on success