NeoMutt  2024-02-01-23-g345d7b
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
envelope.c
Go to the documentation of this file.
1
31#include "config.h"
32#include <stddef.h>
33#include <stdbool.h>
34#include <string.h>
35#include "mutt/lib.h"
36#include "address/lib.h"
37#include "config/lib.h"
38#include "core/lib.h"
39#include "envelope.h"
40#include "email.h"
41
47{
48 struct Envelope *env = mutt_mem_calloc(1, sizeof(struct Envelope));
50 TAILQ_INIT(&env->from);
51 TAILQ_INIT(&env->to);
52 TAILQ_INIT(&env->cc);
53 TAILQ_INIT(&env->bcc);
54 TAILQ_INIT(&env->sender);
55 TAILQ_INIT(&env->reply_to);
60 STAILQ_INIT(&env->userhdrs);
61 return env;
62}
63
69void mutt_env_set_subject(struct Envelope *env, const char *subj)
70{
71 mutt_str_replace((char **) &env->subject, subj);
72 *(char **) &env->real_subj = NULL;
73
74 if (env->subject)
75 {
76 regmatch_t match;
77 const struct Regex *c_reply_regex = cs_subset_regex(NeoMutt->sub, "reply_regex");
78 if (mutt_regex_capture(c_reply_regex, env->subject, 1, &match))
79 {
80 if (env->subject[match.rm_eo] != '\0')
81 *(char **) &env->real_subj = env->subject + match.rm_eo;
82 }
83 else
84 {
85 *(char **) &env->real_subj = env->subject;
86 }
87 }
88}
89
90#ifdef USE_AUTOCRYPT
96{
97 return mutt_mem_calloc(1, sizeof(struct AutocryptHeader));
98}
99
105{
106 if (!ptr || !*ptr)
107 return;
108
109 struct AutocryptHeader *cur = NULL;
110
111 while (*ptr)
112 {
113 cur = *ptr;
114 *ptr = (*ptr)->next;
115 FREE(&cur->addr);
116 FREE(&cur->keydata);
117 FREE(&cur);
118 }
119}
120#endif
121
126void mutt_env_free(struct Envelope **ptr)
127{
128 if (!ptr || !*ptr)
129 return;
130
131 struct Envelope *env = *ptr;
132
135 mutt_addrlist_clear(&env->to);
136 mutt_addrlist_clear(&env->cc);
142
143 FREE(&env->list_post);
144 FREE(&env->list_subscribe);
145 FREE(&env->list_unsubscribe);
146 FREE((char **) &env->subject);
147 /* real_subj is just an offset to subject and shouldn't be freed */
148 FREE(&env->disp_subj);
149 FREE(&env->message_id);
150 FREE(&env->supersedes);
151 FREE(&env->date);
152 FREE(&env->x_label);
153 FREE(&env->organization);
154 FREE(&env->newsgroups);
155 FREE(&env->xref);
156 FREE(&env->followup_to);
157 FREE(&env->x_comment_to);
158
159 buf_dealloc(&env->spam);
160
164
165#ifdef USE_AUTOCRYPT
168#endif
169
170 FREE(ptr);
171}
172
179bool mutt_env_notify_send(struct Email *e, enum NotifyEnvelope type)
180{
181 struct EventEmail ev_e = { 1, &e };
182 return notify_send(e->notify, NT_ENVELOPE, type, &ev_e);
183}
184
193void mutt_env_merge(struct Envelope *base, struct Envelope **extra)
194{
195 if (!base || !extra || !*extra)
196 return;
197
198/* copies each existing element if necessary, and sets the element
199 * to NULL in the source so that mutt_env_free doesn't leave us
200 * with dangling pointers. */
201#define MOVE_ELEM(member) \
202 if (!base->member) \
203 { \
204 base->member = (*extra)->member; \
205 (*extra)->member = NULL; \
206 }
207
208#define MOVE_STAILQ(member) \
209 if (STAILQ_EMPTY(&base->member)) \
210 { \
211 STAILQ_SWAP(&base->member, &(*extra)->member, ListNode); \
212 }
213
214#define MOVE_ADDRESSLIST(member) \
215 if (TAILQ_EMPTY(&base->member)) \
216 { \
217 TAILQ_SWAP(&base->member, &(*extra)->member, Address, entries); \
218 }
219
220#define MOVE_BUFFER(member) \
221 if (buf_is_empty(&base->member)) \
222 { \
223 memcpy(&base->member, &(*extra)->member, sizeof(struct Buffer)); \
224 buf_init(&(*extra)->member); \
225 }
226
227 MOVE_ADDRESSLIST(return_path);
228 MOVE_ADDRESSLIST(from);
231 MOVE_ADDRESSLIST(bcc);
232 MOVE_ADDRESSLIST(sender);
233 MOVE_ADDRESSLIST(reply_to);
234 MOVE_ADDRESSLIST(mail_followup_to);
235 MOVE_ELEM(list_post);
236 MOVE_ELEM(list_subscribe);
237 MOVE_ELEM(list_unsubscribe);
238 MOVE_ELEM(message_id);
239 MOVE_ELEM(supersedes);
240 MOVE_ELEM(date);
241 MOVE_ADDRESSLIST(x_original_to);
242 if (!(base->changed & MUTT_ENV_CHANGED_XLABEL))
243 {
244 MOVE_ELEM(x_label);
245 }
246 if (!(base->changed & MUTT_ENV_CHANGED_REFS))
247 {
248 MOVE_STAILQ(references);
249 }
250 if (!(base->changed & MUTT_ENV_CHANGED_IRT))
251 {
252 MOVE_STAILQ(in_reply_to);
253 }
254
255 /* real_subj is subordinate to subject */
256 if (!base->subject)
257 {
258 *(char **) &base->subject = (*extra)->subject;
259 *(char **) &base->real_subj = (*extra)->real_subj;
260 base->disp_subj = (*extra)->disp_subj;
261 *(char **) &(*extra)->subject = NULL;
262 *(char **) &(*extra)->real_subj = NULL;
263 (*extra)->disp_subj = NULL;
264 }
265 /* spam and user headers should never be hashed, and the new envelope may
266 * have better values. Use new versions regardless. */
267 buf_dealloc(&base->spam);
268 mutt_list_free(&base->userhdrs);
269 MOVE_BUFFER(spam);
270 MOVE_STAILQ(userhdrs);
271#undef MOVE_ELEM
272#undef MOVE_STAILQ
273#undef MOVE_ADDRESSLIST
274#undef MOVE_BUFFER
275
276 mutt_env_free(extra);
277}
278
285bool mutt_env_cmp_strict(const struct Envelope *e1, const struct Envelope *e2)
286{
287 if (e1 && e2)
288 {
289 if (!mutt_str_equal(e1->message_id, e2->message_id) ||
290 !mutt_str_equal(e1->subject, e2->subject) ||
292 !mutt_addrlist_equal(&e1->from, &e2->from) ||
293 !mutt_addrlist_equal(&e1->sender, &e2->sender) ||
295 !mutt_addrlist_equal(&e1->to, &e2->to) || !mutt_addrlist_equal(&e1->cc, &e2->cc) ||
297 {
298 return false;
299 }
300 else
301 {
302 return true;
303 }
304 }
305 else
306 {
307 return (!e1 && !e2);
308 }
309}
310
318{
319 if (!env)
320 return;
321
329}
330
331/* Note that 'member' in the 'env->member' expression is macro argument, not
332 * "real" name of an 'env' compound member. Real name will be substituted by
333 * preprocessor at the macro-expansion time.
334 * Note that #member escapes and double quotes the argument.
335 */
336#define H_TO_INTL(member) \
337 if (mutt_addrlist_to_intl(&env->member, err) && (rc == 0)) \
338 { \
339 if (tag) \
340 *tag = #member; \
341 rc = 1; \
342 err = NULL; \
343 }
344
355int mutt_env_to_intl(struct Envelope *env, const char **tag, char **err)
356{
357 if (!env)
358 return 1;
359
360 int rc = 0;
361 H_TO_INTL(return_path);
362 H_TO_INTL(from);
363 H_TO_INTL(to);
364 H_TO_INTL(cc);
365 H_TO_INTL(bcc);
366 H_TO_INTL(reply_to);
367 H_TO_INTL(mail_followup_to);
368 return rc;
369}
370
371#undef H_TO_INTL
bool mutt_addrlist_equal(const struct AddressList *ala, const struct AddressList *alb)
Compare two Address lists for equality.
Definition: address.c:840
void mutt_addrlist_clear(struct AddressList *al)
Unlink and free all Address in an AddressList.
Definition: address.c:1464
int mutt_addrlist_to_local(struct AddressList *al)
Convert an Address list from Punycode.
Definition: address.c:1382
Email Address Handling.
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:394
const struct Regex * cs_subset_regex(const struct ConfigSubset *sub, const char *name)
Get a regex config item by name.
Definition: helpers.c:218
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
Representation of an email.
int mutt_env_to_intl(struct Envelope *env, const char **tag, char **err)
Convert an Envelope's Address fields to Punycode format.
Definition: envelope.c:355
void mutt_env_merge(struct Envelope *base, struct Envelope **extra)
Merge the headers of two Envelopes.
Definition: envelope.c:193
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:126
#define MOVE_ELEM(member)
#define MOVE_ADDRESSLIST(member)
struct Envelope * mutt_env_new(void)
Create a new Envelope.
Definition: envelope.c:46
#define MOVE_STAILQ(member)
void mutt_env_set_subject(struct Envelope *env, const char *subj)
Set both subject and real_subj to subj.
Definition: envelope.c:69
#define H_TO_INTL(member)
Definition: envelope.c:336
#define MOVE_BUFFER(member)
bool mutt_env_notify_send(struct Email *e, enum NotifyEnvelope type)
Send an Envelope change notification.
Definition: envelope.c:179
bool mutt_env_cmp_strict(const struct Envelope *e1, const struct Envelope *e2)
Strictly compare two Envelopes.
Definition: envelope.c:285
struct AutocryptHeader * mutt_autocrypthdr_new(void)
Create a new AutocryptHeader.
Definition: envelope.c:95
void mutt_autocrypthdr_free(struct AutocryptHeader **ptr)
Free an AutocryptHeader.
Definition: envelope.c:104
void mutt_env_to_local(struct Envelope *env)
Convert an Envelope's Address fields to local format.
Definition: envelope.c:317
Representation of an email header (envelope)
NotifyEnvelope
Types of Envelope Event.
Definition: envelope.h:102
#define MUTT_ENV_CHANGED_XLABEL
X-Label edited.
Definition: envelope.h:36
#define MUTT_ENV_CHANGED_IRT
In-Reply-To changed to link/break threads.
Definition: envelope.h:34
#define MUTT_ENV_CHANGED_REFS
References changed to break thread.
Definition: envelope.h:35
bool mutt_list_equal(const struct ListHead *ah, const struct ListHead *bh)
Compare two string lists.
Definition: list.c:218
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define FREE(x)
Definition: memory.h:45
Convenience wrapper for the library headers.
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:173
bool mutt_regex_capture(const struct Regex *regex, const char *str, size_t nmatch, regmatch_t matches[])
Match a regex against a string, with provided options.
Definition: regex.c:622
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:709
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:329
@ NT_ENVELOPE
Envelope has changed, NotifyEnvelope.
Definition: notify_type.h:45
#define STAILQ_INIT(head)
Definition: queue.h:372
#define TAILQ_INIT(head)
Definition: queue.h:765
Parse Autocrypt header info.
Definition: envelope.h:44
struct AutocryptHeader * next
Linked list.
Definition: envelope.h:49
char * keydata
PGP Key data.
Definition: envelope.h:46
char * addr
Email address.
Definition: envelope.h:45
The envelope/body of an email.
Definition: email.h:39
struct Notify * notify
Notifications: NotifyEmail, EventEmail.
Definition: email.h:73
The header of an Email.
Definition: envelope.h:57
struct ListHead userhdrs
user defined headers
Definition: envelope.h:85
char * supersedes
Supersedes header.
Definition: envelope.h:74
char * list_subscribe
This stores a mailto URL, or nothing.
Definition: envelope.h:68
struct AddressList return_path
Return path for the Email.
Definition: envelope.h:58
char *const subject
Email's subject.
Definition: envelope.h:70
struct AddressList to
Email's 'To' list.
Definition: envelope.h:60
unsigned char changed
Changed fields, e.g. MUTT_ENV_CHANGED_SUBJECT.
Definition: envelope.h:90
char * followup_to
List of 'followup-to' fields.
Definition: envelope.h:80
struct AddressList reply_to
Email's 'reply-to'.
Definition: envelope.h:64
char * message_id
Message ID.
Definition: envelope.h:73
char * x_comment_to
List of 'X-comment-to' fields.
Definition: envelope.h:81
struct AddressList x_original_to
Email's 'X-Orig-to'.
Definition: envelope.h:66
struct AutocryptHeader * autocrypt_gossip
Autocrypt Gossip header.
Definition: envelope.h:88
char * newsgroups
List of newsgroups.
Definition: envelope.h:78
struct AddressList mail_followup_to
Email's 'mail-followup-to'.
Definition: envelope.h:65
struct AddressList cc
Email's 'Cc' list.
Definition: envelope.h:61
struct AddressList sender
Email's sender.
Definition: envelope.h:63
struct ListHead references
message references (in reverse order)
Definition: envelope.h:83
struct AutocryptHeader * autocrypt
Autocrypt header.
Definition: envelope.h:87
struct Buffer spam
Spam header.
Definition: envelope.h:82
struct ListHead in_reply_to
in-reply-to header content
Definition: envelope.h:84
struct AddressList bcc
Email's 'Bcc' list.
Definition: envelope.h:62
char * xref
List of cross-references.
Definition: envelope.h:79
char * organization
Organisation header.
Definition: envelope.h:77
char * x_label
X-Label.
Definition: envelope.h:76
char * list_post
This stores a mailto URL, or nothing.
Definition: envelope.h:67
char *const real_subj
Offset of the real subject.
Definition: envelope.h:71
char * date
Sent date.
Definition: envelope.h:75
char * disp_subj
Display subject (modified copy of subject)
Definition: envelope.h:72
char * list_unsubscribe
This stores a mailto URL, or nothing.
Definition: envelope.h:69
struct AddressList from
Email's 'From' list.
Definition: envelope.h:59
An Event that happened to an Email.
Definition: email.h:164
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
Cached regular expression.
Definition: regex3.h:85