NeoMutt  2020-06-26-89-g172cd3
Teaching an old dog new tricks
DOXYGEN
mutt_header.h File Reference

Representation of the email's header. More...

+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void mutt_edit_headers (const char *editor, const char *body, struct Email *e, struct Buffer *fcc)
 Let the user edit the message header and body. More...
 
void mutt_label_hash_add (struct Mailbox *m, struct Email *e)
 Add a message's labels to the Hash Table. More...
 
void mutt_label_hash_remove (struct Mailbox *m, struct Email *e)
 Remove a message's labels from the Hash Table. More...
 
int mutt_label_message (struct Mailbox *m, struct EmailList *el)
 Let the user label a message. More...
 
void mutt_make_label_hash (struct Mailbox *m)
 Create a Hash Table to store the labels. More...
 

Detailed Description

Representation of the email's header.

Authors
  • Richard Russon

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 mutt_header.h.

Function Documentation

◆ mutt_edit_headers()

void mutt_edit_headers ( const char *  editor,
const char *  body,
struct Email e,
struct Buffer fcc 
)

Let the user edit the message header and body.

Parameters
editorEditor command
bodyFile containing message body
eEmail
fccBuffer for the fcc field

Definition at line 167 of file mutt_header.c.

169 {
170  char buf[1024];
171  const char *p = NULL;
172  int i;
173  struct Envelope *n = NULL;
174  time_t mtime;
175  struct stat st;
176 
177  struct Buffer *path = mutt_buffer_pool_get();
178  mutt_buffer_mktemp(path);
179  FILE *fp_out = mutt_file_fopen(mutt_b2s(path), "w");
180  if (!fp_out)
181  {
182  mutt_perror(mutt_b2s(path));
183  goto cleanup;
184  }
185 
188  false, false, NeoMutt->sub);
189  fputc('\n', fp_out); /* tie off the header. */
190 
191  /* now copy the body of the message. */
192  FILE *fp_in = fopen(body, "r");
193  if (!fp_in)
194  {
195  mutt_perror(body);
196  mutt_file_fclose(&fp_out);
197  goto cleanup;
198  }
199 
200  mutt_file_copy_stream(fp_in, fp_out);
201 
202  mutt_file_fclose(&fp_in);
203  mutt_file_fclose(&fp_out);
204 
205  if (stat(mutt_b2s(path), &st) == -1)
206  {
207  mutt_perror(mutt_b2s(path));
208  goto cleanup;
209  }
210 
211  mtime = mutt_file_decrease_mtime(mutt_b2s(path), &st);
212 
213  mutt_edit_file(editor, mutt_b2s(path));
214  stat(mutt_b2s(path), &st);
215  if (mtime == st.st_mtime)
216  {
217  mutt_debug(LL_DEBUG1, "temp file was not modified\n");
218  /* the file has not changed! */
219  mutt_file_unlink(mutt_b2s(path));
220  goto cleanup;
221  }
222 
223  mutt_file_unlink(body);
225 
226  /* Read the temp file back in */
227  fp_in = fopen(mutt_b2s(path), "r");
228  if (!fp_in)
229  {
230  mutt_perror(mutt_b2s(path));
231  goto cleanup;
232  }
233 
234  fp_out = mutt_file_fopen(body, "w");
235  if (!fp_out)
236  {
237  /* intentionally leak a possible temporary file here */
238  mutt_file_fclose(&fp_in);
239  mutt_perror(body);
240  goto cleanup;
241  }
242 
243  n = mutt_rfc822_read_header(fp_in, NULL, true, false);
244  while ((i = fread(buf, 1, sizeof(buf), fp_in)) > 0)
245  fwrite(buf, 1, i, fp_out);
246  mutt_file_fclose(&fp_out);
247  mutt_file_fclose(&fp_in);
248  mutt_file_unlink(mutt_b2s(path));
249 
250  /* in case the user modifies/removes the In-Reply-To header with
251  * $edit_headers set, we remove References: as they're likely invalid;
252  * we can simply compare strings as we don't generate References for
253  * multiple Message-Ids in IRT anyways */
254 #ifdef USE_NNTP
255  if (!OptNewsSend)
256 #endif
257  {
258  if (!STAILQ_EMPTY(&e->env->in_reply_to) &&
259  (STAILQ_EMPTY(&n->in_reply_to) ||
261  STAILQ_FIRST(&e->env->in_reply_to)->data)))
262  {
264  }
265  }
266 
267  /* restore old info. */
270 
271  mutt_env_free(&e->env);
272  e->env = n;
273  n = NULL;
274 
276 
277  /* search through the user defined headers added to see if
278  * fcc: or attach: or pgp: was specified */
279 
280  struct ListNode *np = NULL, *tmp = NULL;
281  STAILQ_FOREACH_SAFE(np, &e->env->userhdrs, entries, tmp)
282  {
283  bool keep = true;
284  size_t plen;
285 
286  if (fcc && (plen = mutt_istr_startswith(np->data, "fcc:")))
287  {
288  p = mutt_str_skip_email_wsp(np->data + plen);
289  if (*p)
290  {
291  mutt_buffer_strcpy(fcc, p);
293  }
294  keep = false;
295  }
296  else if ((plen = mutt_istr_startswith(np->data, "attach:")))
297  {
298  struct Body *body2 = NULL;
299  struct Body *parts = NULL;
300 
301  p = mutt_str_skip_email_wsp(np->data + plen);
302  if (*p)
303  {
304  mutt_buffer_reset(path);
305  for (; (p[0] != '\0') && (p[0] != ' ') && (p[0] != '\t'); p++)
306  {
307  if (p[0] == '\\')
308  {
309  if (p[1] == '\0')
310  break;
311  p++;
312  }
313  mutt_buffer_addch(path, *p);
314  }
316 
318  body2 = mutt_make_file_attach(mutt_b2s(path), NeoMutt->sub);
319  if (body2)
320  {
321  body2->description = mutt_str_dup(p);
322  for (parts = e->content; parts->next; parts = parts->next)
323  ; // do nothing
324 
325  parts->next = body2;
326  }
327  else
328  {
330  mutt_error(_("%s: unable to attach file"), mutt_b2s(path));
331  }
332  }
333  keep = false;
334  }
335  else if (((WithCrypto & APPLICATION_PGP) != 0) &&
336  (plen = mutt_istr_startswith(np->data, "pgp:")))
337  {
338  e->security = mutt_parse_crypt_hdr(np->data + plen, false, APPLICATION_PGP);
339  if (e->security)
341  keep = false;
342  }
343 
344  if (!keep)
345  {
346  STAILQ_REMOVE(&e->env->userhdrs, np, ListNode, entries);
347  FREE(&np->data);
348  FREE(&np);
349  }
350  }
351 
352 cleanup:
354 }
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:876
#define mutt_buffer_mktemp(buf)
Definition: muttlib.h:77
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:399
void mutt_buffer_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:79
#define WithCrypto
Definition: lib.h:118
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
#define mutt_perror(...)
Definition: logging.h:85
void mutt_expand_aliases_env(struct Envelope *env)
Expand aliases in all the fields of an Envelope.
Definition: alias.c:309
static size_t plen
Length of cached packet.
Definition: pgppacket.c:39
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Body * content
List of MIME parts.
Definition: email.h:90
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition: file.c:195
String manipulation buffer.
Definition: buffer.h:33
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:375
struct ListHead userhdrs
user defined headers
Definition: envelope.h:83
#define _(a)
Definition: message.h:28
struct Body * next
next attachment in the list
Definition: body.h:53
Container for Accounts, Notifications.
Definition: neomutt.h:36
void mutt_buffer_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:598
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
The body of an email.
Definition: body.h:34
struct ListHead in_reply_to
in-reply-to header content
Definition: envelope.h:82
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:153
struct Envelope * env
Envelope information.
Definition: email.h:89
struct Body * mutt_make_file_attach(const char *path, struct ConfigSubset *sub)
Create a file attachment.
Definition: sendlib.c:1080
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:359
#define mutt_b2s(buf)
Definition: buffer.h:41
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:92
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:96
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:54
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition: string.c:748
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:177
char * description
content-description
Definition: body.h:40
size_t mutt_buffer_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:240
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib...
Definition: email.h:39
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
void mutt_env_to_local(struct Envelope *env)
Convert an Envelope's Address fields to local format.
Definition: envelope.c:271
SecurityFlags mutt_parse_crypt_hdr(const char *p, bool set_empty_signas, SecurityFlags crypt_app)
Parse a crypto header string.
Definition: postpone.c:496
char * data
String.
Definition: list.h:36
void mutt_buffer_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:323
Log at debug level 1.
Definition: logging.h:40
int n
Definition: acutest.h:492
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:271
#define mutt_error(...)
Definition: logging.h:84
time_t mutt_file_decrease_mtime(const char *fp, struct stat *st)
Decrease a file's modification time by 1 second.
Definition: file.c:963
#define FREE(x)
Definition: memory.h:40
#define STAILQ_EMPTY(head)
Definition: queue.h:345
#define STAILQ_SWAP(head1, head2, type)
Definition: queue.h:425
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
WHERE bool OptNewsSend
(pseudo) used to change behavior when posting
Definition: options.h:46
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:588
struct ListHead references
message references (in reverse order)
Definition: envelope.h:81
A List node for strings.
Definition: list.h:34
struct Envelope * mutt_rfc822_read_header(FILE *fp, struct Email *e, bool user_hdrs, bool weed)
parses an RFC822 header
Definition: parse.c:1106
#define STAILQ_FIRST(head)
Definition: queue.h:347
void mutt_edit_file(const char *editor, const char *file)
Let the user edit a file.
Definition: curs_lib.c:353
int mutt_rfc822_write_header(FILE *fp, struct Envelope *env, struct Body *attach, enum MuttWriteHeaderMode mode, bool privacy, bool hide_protected_subject, struct ConfigSubset *sub)
Write out one RFC822 header line.
Definition: header.c:573
The header of an Email.
Definition: envelope.h:54
"light" mode (used for edit_hdrs)
Definition: header.h:43
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_hash_add()

void mutt_label_hash_add ( struct Mailbox m,
struct Email e 
)

Add a message's labels to the Hash Table.

Parameters
mMailbox
eEmail

Definition at line 372 of file mutt_header.c.

373 {
374  if (!m || !m->label_hash)
375  return;
376  if (e->env->x_label)
377  label_ref_inc(m, e->env->x_label);
378 }
struct HashTable * label_hash
Hash Table for x-labels.
Definition: mailbox.h:129
struct Envelope * env
Envelope information.
Definition: email.h:89
char * x_label
X-Label.
Definition: envelope.h:72
static void label_ref_inc(struct Mailbox *m, char *label)
Increase the refcount of a label.
Definition: mutt_header.c:77
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_hash_remove()

void mutt_label_hash_remove ( struct Mailbox m,
struct Email e 
)

Remove a message's labels from the Hash Table.

Parameters
mMailbox
eEmail

Definition at line 385 of file mutt_header.c.

386 {
387  if (!m || !m->label_hash)
388  return;
389  if (e->env->x_label)
390  label_ref_dec(m, e->env->x_label);
391 }
struct HashTable * label_hash
Hash Table for x-labels.
Definition: mailbox.h:129
struct Envelope * env
Envelope information.
Definition: email.h:89
static void label_ref_dec(struct Mailbox *m, char *label)
Decrease the refcount of a label.
Definition: mutt_header.c:55
char * x_label
X-Label.
Definition: envelope.h:72
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_message()

int mutt_label_message ( struct Mailbox m,
struct EmailList *  el 
)

Let the user label a message.

Parameters
mMailbox
elList of Emails to label
Return values
numNumber of messages changed

Definition at line 124 of file mutt_header.c.

125 {
126  if (!m || !el)
127  return 0;
128 
129  char buf[1024] = { 0 };
130 
131  struct EmailNode *en = STAILQ_FIRST(el);
132  if (!STAILQ_NEXT(en, entries))
133  {
134  // If there's only one email, use its label as a template
135  if (en->email->env->x_label)
136  mutt_str_copy(buf, en->email->env->x_label, sizeof(buf));
137  }
138 
139  if (mutt_get_field("Label: ", buf, sizeof(buf), MUTT_LABEL /* | MUTT_CLEAR */) != 0)
140  return 0;
141 
142  char *new_label = buf;
143  SKIPWS(new_label);
144  if (*new_label == '\0')
145  new_label = NULL;
146 
147  int changed = 0;
148  STAILQ_FOREACH(en, el, entries)
149  {
150  if (label_message(m, en->email, new_label))
151  {
152  changed++;
154  }
155  }
156 
157  return changed;
158 }
#define MUTT_LABEL
Do label completion.
Definition: mutt.h:65
#define mutt_get_field(field, buf, buflen, complete)
Definition: curs_lib.h:91
struct Envelope * env
Envelope information.
Definition: email.h:89
#define SKIPWS(ch)
Definition: string2.h:46
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:349
#define STAILQ_NEXT(elm, field)
Definition: queue.h:397
void mutt_set_header_color(struct Mailbox *m, struct Email *e)
Select a colour for a message.
Definition: index.c:3983
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:721
struct Email * email
Email in the list.
Definition: email.h:116
List of Emails.
Definition: email.h:114
char * x_label
X-Label.
Definition: envelope.h:72
#define STAILQ_FIRST(head)
Definition: queue.h:347
static bool label_message(struct Mailbox *m, struct Email *e, char *new_label)
add an X-Label: field
Definition: mutt_header.c:101
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_make_label_hash()

void mutt_make_label_hash ( struct Mailbox m)

Create a Hash Table to store the labels.

Parameters
mMailbox

Definition at line 360 of file mutt_header.c.

361 {
362  /* 131 is just a rough prime estimate of how many distinct
363  * labels someone might have in a m. */
365 }
struct HashTable * label_hash
Hash Table for x-labels.
Definition: mailbox.h:129
#define MUTT_HASH_STRDUP_KEYS
make a copy of the keys
Definition: hash.h:99
struct HashTable * mutt_hash_new(size_t num_elems, HashFlags flags)
Create a new Hash Table (with string keys)
Definition: hash.c:251
+ Here is the call graph for this function:
+ Here is the caller graph for this function: