Skip to content

Commit 9909fb8

Browse files
authored
doc: Adapt the comment on MessageObject.showPadlock (#6925)
We want to remove the padlock-icon from messages, and instead show an icon if the message was unencrypted: deltachat/deltachat-ios#2746 Now, it's confusing for implementers that there is a field `showPadlock` in the jsonrpc. This PR adapts the comment. Two alternatives to this PR would be: - Deprecate `showPadlock`, and introduce a field `wasEncrypted` - Deprecate `showPadlock`, and introduce a field `showLetterIcon`, which is the inverse of `showPadlock`.
1 parent 4eb1a5e commit 9909fb8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

deltachat-jsonrpc/src/api/types/message.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ pub struct MessageObject {
6161

6262
// summary - use/create another function if you need it
6363
subject: String,
64+
65+
/// True if the message was correctly encrypted&signed, false otherwise.
66+
/// Historically, UIs showed a small padlock on the message then.
67+
///
68+
/// Today, the UIs should instead show a small email-icon on the message
69+
/// if `show_padlock` is `false`,
70+
/// and nothing if it is `true`.
6471
show_padlock: bool,
6572
is_setupmessage: bool,
6673
is_info: bool,

0 commit comments

Comments
 (0)