Browse Source

change API reference to add encrypt_message_and_add_priv_key().

JSON-110
Roker 3 years ago
parent
commit
85692cc708
2 changed files with 27 additions and 0 deletions
  1. +26
    -0
      API reference details.md
  2. +1
    -0
      API reference.md

+ 26
- 0
API reference details.md View File

@ -143,6 +143,32 @@ encrypt message in memory
and key is attached to it
```
##### encrypt_message_and_add_priv_key( Message src, Message⇑ dst, String to_fingerprint, PEP_enc_format enc_format, Integer flags)
encrypt message in memory, adding an encrypted private key (encrypted separately and sent within the inner message)
```
parameters:
session (in) session handle
src (in) message to encrypt
dst (out) pointer to new encrypted message or NULL if no
encryption could take place
to_fpr fingerprint of the recipient key to which the private key
should be encrypted
enc_format (in) encrypted format
flags (in) flags to set special encryption features
return value:
PEP_STATUS_OK on success
PEP_KEY_HAS_AMBIG_NAME at least one of the receipient keys has
an ambiguous name
PEP_UNENCRYPTED on demand or no recipients with usable
key, is left unencrypted, and key is
attached to it
caveat:
the ownershop of src remains with the caller
the ownership of dst goes to the caller
```
##### encrypt_message_for_self(Identity target_id, Message src, Message⇑ dst, PEP_enc_format enc_format, Integer flags)
encrypt message in memory for user's identity only,
ignoring recipients and other identities from


+ 1
- 0
API reference.md View File

@ -12,6 +12,7 @@ Output parameters are denoted by a **⇑** , InOut parameters are denoted by a
| startKeyserverLookup | Void | |
| stopKeyserverLookup | Void | |
| encrypt_message | PEP_STATUS | Message, StringList, Message⇑, PEP_enc_format, Integer |
| encrypt_message_and_add_priv_key | PEP_STATUS | Message, Message⇑, String, , PEP_enc_format, Integer |
| encrypt_message_for_self | PEP_STATUS | Identity, Message, StringList, Message⇑, PEP_enc_format, Integer |
| decrypt_message | PEP_STATUS | Message⇕, Message⇑, StringList⇑, PEP_rating⇑, Integer⇕ |
| outgoing_message_rating | PEP_STATUS | Message, PEP_rating⇑ |


Loading…
Cancel
Save