NeoMutt  2022-04-29-178-g3b62e6
Teaching an old dog new tricks

Save the tags to a message. More...

+ Collaboration diagram for tags_commit():


static int comp_tags_commit (struct Mailbox *m, struct Email *e, const char *buf)
 Save the tags to a message - Implements MxOps::tags_commit() -. More...
static int imap_tags_commit (struct Mailbox *m, struct Email *e, const char *buf)
 Save the tags to a message - Implements MxOps::tags_commit() -. More...
static int nm_tags_commit (struct Mailbox *m, struct Email *e, const char *buf)
 Save the tags to a message - Implements MxOps::tags_commit() -. More...

Detailed Description

Save the tags to a message.

bufBuffer containing tags
Return values


Function Documentation

◆ comp_tags_commit()

static int comp_tags_commit ( struct Mailbox m,
struct Email e,
const char *  buf 

Save the tags to a message - Implements MxOps::tags_commit() -.

Definition at line 863 of file compress.c.

865 if (!m->compress_info)
866 return 0;
868 struct CompressInfo *ci = m->compress_info;
870 const struct MxOps *ops = ci->child_ops;
871 if (!ops || !ops->tags_commit)
872 return 0;
874 return ops->tags_commit(m, e, buf);
Private data for compress.
Definition: lib.h:47
const struct MxOps * child_ops
callbacks of de-compressed file
Definition: lib.h:52
void * compress_info
Compressed mbox module private data.
Definition: mailbox.h:121
Definition: mxapi.h:112
int(* tags_commit)(struct Mailbox *m, struct Email *e, const char *buf)
Definition: mxapi.h:360

◆ imap_tags_commit()

static int imap_tags_commit ( struct Mailbox m,
struct Email e,
const char *  buf 

Save the tags to a message - Implements MxOps::tags_commit() -.

This method update the server flags on the server by removing the last know custom flags of a header and adds the local flags

If everything success we push the local flags to the last know custom flags (flags_remote).

Also this method check that each flags is support by the server first and remove unsupported one.

Definition at line 2335 of file imap.c.

2337 char uid[11] = { 0 };
2341 if (*buf == '\0')
2342 buf = NULL;
2344 if (!(adata->mailbox->rights & MUTT_ACL_WRITE))
2345 return 0;
2347 snprintf(uid, sizeof(uid), "%u", imap_edata_get(e)->uid);
2349 /* Remove old custom flags */
2350 if (imap_edata_get(e)->flags_remote)
2351 {
2352 struct Buffer cmd = mutt_buffer_make(128); // just a guess
2353 mutt_buffer_addstr(&cmd, "UID STORE ");
2354 mutt_buffer_addstr(&cmd, uid);
2355 mutt_buffer_addstr(&cmd, " -FLAGS.SILENT (");
2356 mutt_buffer_addstr(&cmd, imap_edata_get(e)->flags_remote);
2357 mutt_buffer_addstr(&cmd, ")");
2359 /* Should we return here, or we are fine and we could
2360 * continue to add new flags */
2361 int rc = imap_exec(adata,, IMAP_CMD_NO_FLAGS);
2362 mutt_buffer_dealloc(&cmd);
2363 if (rc != IMAP_EXEC_SUCCESS)
2364 {
2365 return -1;
2366 }
2367 }
2369 /* Add new custom flags */
2370 if (buf)
2371 {
2372 struct Buffer cmd = mutt_buffer_make(128); // just a guess
2373 mutt_buffer_addstr(&cmd, "UID STORE ");
2374 mutt_buffer_addstr(&cmd, uid);
2375 mutt_buffer_addstr(&cmd, " +FLAGS.SILENT (");
2376 mutt_buffer_addstr(&cmd, buf);
2377 mutt_buffer_addstr(&cmd, ")");
2379 int rc = imap_exec(adata,, IMAP_CMD_NO_FLAGS);
2380 mutt_buffer_dealloc(&cmd);
2381 if (rc != IMAP_EXEC_SUCCESS)
2382 {
2383 mutt_debug(LL_DEBUG1, "fail to add new flags\n");
2384 return -1;
2385 }
2386 }
2388 /* We are good sync them */
2389 mutt_debug(LL_DEBUG1, "NEW TAGS: %s\n", buf);
2390 driver_tags_replace(&e->tags, buf);
2391 FREE(&imap_edata_get(e)->flags_remote);
2394 return 0;
struct Buffer mutt_buffer_make(size_t size)
Make a new buffer on the stack.
Definition: buffer.c:63
void mutt_buffer_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:292
size_t mutt_buffer_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:223
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
int imap_msg_save_hcache(struct Mailbox *m, struct Email *e)
Save message to the header cache - Implements MxOps::msg_save_hcache() -.
Definition: message.c:2189
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:89
int imap_exec(struct ImapAccountData *adata, const char *cmdstr, ImapCmdFlags flags)
Execute a command and wait for the response from the server.
Definition: command.c:1247
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:65
No flags are set.
Definition: private.h:73
Imap command executed or queued successfully.
Definition: private.h:84
Log at debug level 1.
Definition: logging.h:40
Write to a message (for flagging or linking threads)
Definition: mailbox.h:71
#define FREE(x)
Definition: memory.h:43
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
String manipulation buffer.
Definition: buffer.h:34
char * data
Pointer to data.
Definition: buffer.h:35
struct TagList tags
For drivers that support server tagging.
Definition: email.h:70
IMAP-specific Account data -.
Definition: adata.h:40
char * buf
Definition: adata.h:59
char * flags_remote
Definition: edata.h:48
bool driver_tags_replace(struct TagList *head, const char *tags)
Replace all tags.
Definition: tags.c:186
char * driver_tags_get_with_hidden(struct TagList *list)
Get tags with hiddens.
Definition: tags.c:158
+ Here is the call graph for this function:

◆ nm_tags_commit()

static int nm_tags_commit ( struct Mailbox m,
struct Email e,
const char *  buf 

Save the tags to a message - Implements MxOps::tags_commit() -.

Definition at line 2393 of file notmuch.c.

2395 if (*buf == '\0')
2396 return 0; /* no tag change, so nothing to do */
2398 struct NmMboxData *mdata = nm_mdata_get(m);
2399 if (!mdata)
2400 return -1;
2402 notmuch_database_t *db = NULL;
2403 notmuch_message_t *msg = NULL;
2404 int rc = -1;
2406 if (!(db = nm_db_get(m, true)) || !(msg = get_nm_message(db, e)))
2407 goto done;
2409 mutt_debug(LL_DEBUG1, "nm: tags modify: '%s'\n", buf);
2411 update_tags(msg, buf);
2412 update_email_flags(m, e, buf);
2413 update_email_tags(e, msg);
2416 rc = 0;
2417 e->changed = true;
2419 nm_db_release(m);
2420 if (e->changed)
2421 {
2423 m->mtime.tv_nsec = 0;
2424 }
2425 mutt_debug(LL_DEBUG1, "nm: tags modify done [rc=%d]\n", rc);
2426 return rc;
time_t mutt_date_epoch(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:427
void mutt_set_header_color(struct Mailbox *m, struct Email *e)
Select a colour for a message.
Definition: dlg_index.c:1366
notmuch_database_t * nm_db_get(struct Mailbox *m, bool writable)
Get the Notmuch database.
Definition: db.c:169
int nm_db_release(struct Mailbox *m)
Close the Notmuch database.
Definition: db.c:193
struct NmMboxData * nm_mdata_get(struct Mailbox *m)
Get the Notmuch Mailbox data.
Definition: mdata.c:97
static notmuch_message_t * get_nm_message(notmuch_database_t *db, struct Email *e)
Find a Notmuch message.
Definition: notmuch.c:1031
static int update_tags(notmuch_message_t *msg, const char *tag_str)
Update the tags on a message.
Definition: notmuch.c:1089
static int update_email_tags(struct Email *e, notmuch_message_t *msg)
Update the Email's tags from Notmuch.
Definition: notmuch.c:463
static int update_email_flags(struct Mailbox *m, struct Email *e, const char *tag_str)
Update the Email's flags.
Definition: notmuch.c:1143
bool changed
Email has been edited.
Definition: email.h:75
struct timespec mtime
Time Mailbox was last changed.
Definition: mailbox.h:104
void * mdata
Driver specific data.
Definition: mailbox.h:133
Notmuch-specific Mailbox data -.
Definition: mdata.h:34
long tv_nsec
Number of nanosecond, on top.
Definition: file.h:51
time_t tv_sec
Number of seconds since the epoch.
Definition: file.h:50
+ Here is the call graph for this function: