NeoMutt  2022-04-29-145-g9b6a0e
Teaching an old dog new tricks
DOXYGEN
envelope.c File Reference

Representation of an email header (envelope) More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <string.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "envelope.h"
#include "email.h"
+ Include dependency graph for envelope.c:

Go to the source code of this file.

Macros

#define MOVE_ELEM(member)
 
#define MOVE_STAILQ(member)
 
#define MOVE_ADDRESSLIST(member)
 
#define MOVE_BUFFER(member)
 
#define H_TO_INTL(member)
 

Functions

struct Envelopemutt_env_new (void)
 Create a new Envelope. More...
 
struct AutocryptHeadermutt_autocrypthdr_new (void)
 Create a new AutocryptHeader. More...
 
void mutt_autocrypthdr_free (struct AutocryptHeader **p)
 Free an AutocryptHeader. More...
 
void mutt_env_free (struct Envelope **ptr)
 Free an Envelope. More...
 
bool mutt_env_notify_send (struct Email *e, enum NotifyEnvelope type)
 Send an Envelope change notification. More...
 
void mutt_env_merge (struct Envelope *base, struct Envelope **extra)
 Merge the headers of two Envelopes. More...
 
bool mutt_env_cmp_strict (const struct Envelope *e1, const struct Envelope *e2)
 Strictly compare two Envelopes. More...
 
void mutt_env_to_local (struct Envelope *env)
 Convert an Envelope's Address fields to local format. More...
 
int mutt_env_to_intl (struct Envelope *env, const char **tag, char **err)
 Convert an Envelope's Address fields to Punycode format. More...
 

Detailed Description

Representation of an email header (envelope)

Authors
  • Richard Russon
  • Pietro Cerutti

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file envelope.c.

Macro Definition Documentation

◆ MOVE_ELEM

#define MOVE_ELEM (   member)
Value:
if (!base->member) \
{ \
base->member = (*extra)->member; \
(*extra)->member = NULL; \
}

◆ MOVE_STAILQ

#define MOVE_STAILQ (   member)
Value:
if (STAILQ_EMPTY(&base->member)) \
{ \
STAILQ_SWAP(&base->member, &(*extra)->member, ListNode); \
}
#define STAILQ_EMPTY(head)
Definition: queue.h:348
A List node for strings.
Definition: list.h:35

◆ MOVE_ADDRESSLIST

#define MOVE_ADDRESSLIST (   member)
Value:
if (TAILQ_EMPTY(&base->member)) \
{ \
TAILQ_SWAP(&base->member, &(*extra)->member, Address, entries); \
}
#define TAILQ_EMPTY(head)
Definition: queue.h:721
An email address.
Definition: address.h:36

◆ MOVE_BUFFER

#define MOVE_BUFFER (   member)
Value:
if (mutt_buffer_is_empty(&base->member)) \
{ \
memcpy(&base->member, &(*extra)->member, sizeof(struct Buffer)); \
mutt_buffer_init(&(*extra)->member); \
}
bool mutt_buffer_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:250
String manipulation buffer.
Definition: buffer.h:34

◆ H_TO_INTL

#define H_TO_INTL (   member)
Value:
if (mutt_addrlist_to_intl(&env->member, err) && (rc == 0)) \
{ \
if (tag) \
*tag = #member; \
rc = 1; \
err = NULL; \
}
int mutt_addrlist_to_intl(struct AddressList *al, char **err)
Convert an Address list to Punycode.
Definition: address.c:1305

Definition at line 307 of file envelope.c.

Function Documentation

◆ mutt_env_new()

struct Envelope* mutt_env_new ( void  )

Create a new Envelope.

Return values
ptrNew Envelope

Definition at line 43 of file envelope.c.

44 {
45  struct Envelope *env = mutt_mem_calloc(1, sizeof(struct Envelope));
46  TAILQ_INIT(&env->return_path);
47  TAILQ_INIT(&env->from);
48  TAILQ_INIT(&env->to);
49  TAILQ_INIT(&env->cc);
50  TAILQ_INIT(&env->bcc);
51  TAILQ_INIT(&env->sender);
52  TAILQ_INIT(&env->reply_to);
55  STAILQ_INIT(&env->references);
56  STAILQ_INIT(&env->in_reply_to);
57  STAILQ_INIT(&env->userhdrs);
58  return env;
59 }
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define STAILQ_INIT(head)
Definition: queue.h:372
#define TAILQ_INIT(head)
Definition: queue.h:765
The header of an Email.
Definition: envelope.h:57
struct ListHead userhdrs
user defined headers
Definition: envelope.h:87
struct AddressList return_path
Return path for the Email.
Definition: envelope.h:58
struct AddressList to
Email's 'To' list.
Definition: envelope.h:60
struct AddressList reply_to
Email's 'reply-to'.
Definition: envelope.h:64
struct AddressList x_original_to
Email's 'X-Orig-to'.
Definition: envelope.h:66
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:85
struct ListHead in_reply_to
in-reply-to header content
Definition: envelope.h:86
struct AddressList bcc
Email's 'Bcc' list.
Definition: envelope.h:62
struct AddressList from
Email's 'From' list.
Definition: envelope.h:59
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_autocrypthdr_new()

struct AutocryptHeader* mutt_autocrypthdr_new ( void  )

Create a new AutocryptHeader.

Return values
ptrNew AutocryptHeader

Definition at line 66 of file envelope.c.

67 {
68  return mutt_mem_calloc(1, sizeof(struct AutocryptHeader));
69 }
Parse Autocrypt header info.
Definition: envelope.h:44
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_autocrypthdr_free()

void mutt_autocrypthdr_free ( struct AutocryptHeader **  p)

Free an AutocryptHeader.

Parameters
pAutocryptHeader to free

Definition at line 75 of file envelope.c.

76 {
77  if (!p)
78  return;
79 
80  struct AutocryptHeader *cur = NULL;
81 
82  while (*p)
83  {
84  cur = *p;
85  *p = (*p)->next;
86  FREE(&cur->addr);
87  FREE(&cur->keydata);
88  FREE(&cur);
89  }
90 }
#define FREE(x)
Definition: memory.h:43
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
+ Here is the caller graph for this function:

◆ mutt_env_free()

void mutt_env_free ( struct Envelope **  ptr)

Free an Envelope.

Parameters
[out]ptrEnvelope to free

Definition at line 97 of file envelope.c.

98 {
99  if (!ptr || !*ptr)
100  return;
101 
102  struct Envelope *env = *ptr;
103 
105  mutt_addrlist_clear(&env->from);
106  mutt_addrlist_clear(&env->to);
107  mutt_addrlist_clear(&env->cc);
108  mutt_addrlist_clear(&env->bcc);
113 
114  FREE(&env->list_post);
115  FREE(&env->list_subscribe);
116  FREE(&env->list_unsubscribe);
117  FREE(&env->subject);
118  /* real_subj is just an offset to subject and shouldn't be freed */
119  FREE(&env->disp_subj);
120  FREE(&env->message_id);
121  FREE(&env->supersedes);
122  FREE(&env->date);
123  FREE(&env->x_label);
124  FREE(&env->organization);
125 #ifdef USE_NNTP
126  FREE(&env->newsgroups);
127  FREE(&env->xref);
128  FREE(&env->followup_to);
129  FREE(&env->x_comment_to);
130 #endif
131 
132  mutt_buffer_dealloc(&env->spam);
133 
134  mutt_list_free(&env->references);
136  mutt_list_free(&env->userhdrs);
137 
138 #ifdef USE_AUTOCRYPT
141 #endif
142 
143  FREE(ptr);
144 }
void mutt_addrlist_clear(struct AddressList *al)
Unlink and free all Address in an AddressList.
Definition: address.c:1470
void mutt_buffer_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:292
void mutt_autocrypthdr_free(struct AutocryptHeader **p)
Free an AutocryptHeader.
Definition: envelope.c:75
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
char * supersedes
Supersedes header.
Definition: envelope.h:74
char * list_subscribe
This stores a mailto URL, or nothing.
Definition: envelope.h:68
char * followup_to
List of 'followup-to' fields.
Definition: envelope.h:81
char * message_id
Message ID.
Definition: envelope.h:73
char * x_comment_to
List of 'X-comment-to' fields.
Definition: envelope.h:82
struct AutocryptHeader * autocrypt_gossip
Autocrypt Gossip header.
Definition: envelope.h:90
char * newsgroups
List of newsgroups.
Definition: envelope.h:79
struct AutocryptHeader * autocrypt
Autocrypt header.
Definition: envelope.h:89
struct Buffer spam
Spam header.
Definition: envelope.h:84
char * subject
Email's subject.
Definition: envelope.h:70
char * xref
List of cross-references.
Definition: envelope.h:80
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 * 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
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_env_notify_send()

bool mutt_env_notify_send ( struct Email e,
enum NotifyEnvelope  type 
)

Send an Envelope change notification.

Parameters
eEmail
typeNotification type, e.g. NT_ENVELOPE_SUBJECT
Return values
trueSuccessfully sent

Definition at line 152 of file envelope.c.

153 {
154  struct EventEmail ev_e = { 1, &e };
155  return notify_send(e->notify, NT_ENVELOPE, type, &ev_e);
156 }
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
@ NT_ENVELOPE
Envelope has changed, NotifyEnvelope.
Definition: notify_type.h:45
struct Notify * notify
Notifications: NotifyEmail, EventEmail.
Definition: email.h:71
An Event that happened to an Email.
Definition: email.h:160
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_env_merge()

void mutt_env_merge ( struct Envelope base,
struct Envelope **  extra 
)

Merge the headers of two Envelopes.

Parameters
[in]baseEnvelope destination for all the headers
[out]extraEnvelope to copy from

Any fields that are missing from base will be copied from extra. extra will be freed afterwards.

Definition at line 166 of file envelope.c.

167 {
168  if (!base || !extra || !*extra)
169  return;
170 
171 /* copies each existing element if necessary, and sets the element
172  * to NULL in the source so that mutt_env_free doesn't leave us
173  * with dangling pointers. */
174 #define MOVE_ELEM(member) \
175  if (!base->member) \
176  { \
177  base->member = (*extra)->member; \
178  (*extra)->member = NULL; \
179  }
180 
181 #define MOVE_STAILQ(member) \
182  if (STAILQ_EMPTY(&base->member)) \
183  { \
184  STAILQ_SWAP(&base->member, &(*extra)->member, ListNode); \
185  }
186 
187 #define MOVE_ADDRESSLIST(member) \
188  if (TAILQ_EMPTY(&base->member)) \
189  { \
190  TAILQ_SWAP(&base->member, &(*extra)->member, Address, entries); \
191  }
192 
193 #define MOVE_BUFFER(member) \
194  if (mutt_buffer_is_empty(&base->member)) \
195  { \
196  memcpy(&base->member, &(*extra)->member, sizeof(struct Buffer)); \
197  mutt_buffer_init(&(*extra)->member); \
198  }
199 
200  MOVE_ADDRESSLIST(return_path);
201  MOVE_ADDRESSLIST(from);
202  MOVE_ADDRESSLIST(to);
203  MOVE_ADDRESSLIST(cc);
204  MOVE_ADDRESSLIST(bcc);
205  MOVE_ADDRESSLIST(sender);
206  MOVE_ADDRESSLIST(reply_to);
207  MOVE_ADDRESSLIST(mail_followup_to);
208  MOVE_ELEM(list_post);
209  MOVE_ELEM(list_subscribe);
210  MOVE_ELEM(list_unsubscribe);
211  MOVE_ELEM(message_id);
212  MOVE_ELEM(supersedes);
213  MOVE_ELEM(date);
214  MOVE_ADDRESSLIST(x_original_to);
215  if (!(base->changed & MUTT_ENV_CHANGED_XLABEL))
216  {
217  MOVE_ELEM(x_label);
218  }
219  if (!(base->changed & MUTT_ENV_CHANGED_REFS))
220  {
221  MOVE_STAILQ(references);
222  }
223  if (!(base->changed & MUTT_ENV_CHANGED_IRT))
224  {
225  MOVE_STAILQ(in_reply_to);
226  }
227 
228  /* real_subj is subordinate to subject */
229  if (!base->subject)
230  {
231  base->subject = (*extra)->subject;
232  base->real_subj = (*extra)->real_subj;
233  base->disp_subj = (*extra)->disp_subj;
234  (*extra)->subject = NULL;
235  (*extra)->real_subj = NULL;
236  (*extra)->disp_subj = NULL;
237  }
238  /* spam and user headers should never be hashed, and the new envelope may
239  * have better values. Use new versions regardless. */
240  mutt_buffer_dealloc(&base->spam);
241  mutt_list_free(&base->userhdrs);
242  MOVE_BUFFER(spam);
243  MOVE_STAILQ(userhdrs);
244 #undef MOVE_ELEM
245 #undef MOVE_STAILQ
246 #undef MOVE_ADDRESSLIST
247 #undef MOVE_BUFFER
248 
249  mutt_env_free(extra);
250 }
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:97
#define MOVE_ELEM(member)
#define MOVE_ADDRESSLIST(member)
#define MOVE_STAILQ(member)
#define MOVE_BUFFER(member)
#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
unsigned char changed
Changed fields, e.g. MUTT_ENV_CHANGED_SUBJECT.
Definition: envelope.h:92
char * real_subj
Offset of the real subject.
Definition: envelope.h:71
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_env_cmp_strict()

bool mutt_env_cmp_strict ( const struct Envelope e1,
const struct Envelope e2 
)

Strictly compare two Envelopes.

Parameters
e1First Envelope
e2Second Envelope
Return values
trueEnvelopes are strictly identical

Definition at line 258 of file envelope.c.

259 {
260  if (e1 && e2)
261  {
262  if (!mutt_str_equal(e1->message_id, e2->message_id) ||
263  !mutt_str_equal(e1->subject, e2->subject) ||
264  !mutt_list_compare(&e1->references, &e2->references) ||
265  !mutt_addrlist_equal(&e1->from, &e2->from) ||
266  !mutt_addrlist_equal(&e1->sender, &e2->sender) ||
267  !mutt_addrlist_equal(&e1->reply_to, &e2->reply_to) ||
268  !mutt_addrlist_equal(&e1->to, &e2->to) || !mutt_addrlist_equal(&e1->cc, &e2->cc) ||
270  {
271  return false;
272  }
273  else
274  return true;
275  }
276  else
277  {
278  return (!e1 && !e2);
279  }
280 }
bool mutt_addrlist_equal(const struct AddressList *ala, const struct AddressList *alb)
Compare two Address lists for equality.
Definition: address.c:812
bool mutt_list_compare(const struct ListHead *ah, const struct ListHead *bh)
Compare two string lists.
Definition: list.c:218
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:784
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_env_to_local()

void mutt_env_to_local ( struct Envelope env)

Convert an Envelope's Address fields to local format.

Parameters
envEnvelope to modify

Run mutt_addrlist_to_local() on each of the Address fields in the Envelope.

Definition at line 288 of file envelope.c.

289 {
290  if (!env)
291  return;
292 
295  mutt_addrlist_to_local(&env->to);
296  mutt_addrlist_to_local(&env->cc);
300 }
int mutt_addrlist_to_local(struct AddressList *al)
Convert an Address list from Punycode.
Definition: address.c:1388
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_env_to_intl()

int mutt_env_to_intl ( struct Envelope env,
const char **  tag,
char **  err 
)

Convert an Envelope's Address fields to Punycode format.

Parameters
[in]envEnvelope to modify
[out]tagName of the failed field
[out]errFailed address
Return values
0Success, all addresses converted
1Error, tag and err will be set

Run mutt_addrlist_to_intl() on each of the Address fields in the Envelope.

Definition at line 326 of file envelope.c.

327 {
328  if (!env)
329  return 1;
330 
331  int rc = 0;
332  H_TO_INTL(return_path);
333  H_TO_INTL(from);
334  H_TO_INTL(to);
335  H_TO_INTL(cc);
336  H_TO_INTL(bcc);
337  H_TO_INTL(reply_to);
338  H_TO_INTL(mail_followup_to);
339  return rc;
340 }
#define H_TO_INTL(member)
Definition: envelope.c:307
+ Here is the caller graph for this function: