util/repair: add _notmuch_repair_crypto_payload_skip_legacy_display
[notmuch] / util / repair.h
1 #ifndef _REPAIR_H
2 #define _REPAIR_H
3
4 #include "gmime-extra.h"
5
6 #ifdef __cplusplus
7 extern "C" {
8 #endif
9
10 /* This is a collection of message structure and message format repair
11  * techniques that are designed to improve the user experience of
12  * notmuch */
13
14 /* If payload is a cryptographic payload within an encrypted message, and
15  * it has a "legacy display" part, then we can skip over it and jump
16  * to the actual content, because notmuch already handles protected
17  * headers appropriately.
18  *
19  * This function either returns payload directly (if it does not have
20  * a "legacy display" part), or it returns a pointer to its
21  * content-bearing subpart, with the "legacy display" part and the
22  * surrounding multipart/mixed object bypassed.
23  *
24  * No new objects are created by calling this function, and the
25  * returned object will only be released when the original part is
26  * disposed of.
27  */
28 GMimeObject *
29 _notmuch_repair_crypto_payload_skip_legacy_display (GMimeObject *payload);
30
31 #ifdef __cplusplus
32 }
33 #endif
34 #endif