mirror of
https://github.com/str4d/rage.git
synced 2025-04-04 03:17:42 +03:00
Update docs to permit multiple stanzas from recipients
Closes str4d/rage#524.
This commit is contained in:
parent
d0889c90af
commit
bca6916bac
2 changed files with 8 additions and 3 deletions
|
@ -81,8 +81,12 @@ pub trait RecipientPluginV1 {
|
|||
/// Wraps each `file_key` to all recipients and identities previously added via
|
||||
/// `add_recipient` and `add_identity`.
|
||||
///
|
||||
/// Returns either one stanza per recipient and identity for each file key, or any
|
||||
/// errors if one or more recipients or identities could not be wrapped to.
|
||||
/// Returns a set of stanzas per file key that wrap it to each recipient and identity.
|
||||
/// Plugins may return more than one stanza per "actual recipient", e.g. to support
|
||||
/// multiple formats, to build group aliases, or to act as a proxy.
|
||||
///
|
||||
/// If one or more recipients or identities could not be wrapped to, no stanzas are
|
||||
/// returned for any of the file keys.
|
||||
///
|
||||
/// `callbacks` can be used to interact with the user, to have them take some physical
|
||||
/// action or request a secret value.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue