NeoMutt  2025-12-11-980-ge38c27
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
tags_commit()

Save the tags to a message. More...

+ Collaboration diagram for tags_commit():

Functions

static int comp_tags_commit (struct Mailbox *m, struct Email *e, const char *buf)
 Save the tags to a message - Implements MxOps::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() -.
 
static int nm_tags_commit (struct Mailbox *m, struct Email *e, const char *buf)
 Save the tags to a message - Implements MxOps::tags_commit() -.
 

Detailed Description

Save the tags to a message.

Parameters
mMailbox
eEmail
bufBuffer containing tags
Return values
0Success
-1Failure
Precondition
m is not NULL
e is not NULL
buf is not NULL

Function Documentation

◆ comp_tags_commit()

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

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

Definition at line 846 of file compress.c.

847{
848 if (!m->compress_info)
849 return 0;
850
851 struct CompressInfo *ci = m->compress_info;
852
853 const struct MxOps *ops = ci->child_ops;
854 if (!ops || !ops->tags_commit)
855 return 0;
856
857 return ops->tags_commit(m, e, buf);
858}
Private data for compress.
Definition lib.h:61
const struct MxOps * child_ops
callbacks of de-compressed file
Definition lib.h:66
void * compress_info
Compressed mbox module private data.
Definition mailbox.h:123
Definition mxapi.h:98
int(* tags_commit)(struct Mailbox *m, struct Email *e, const char *buf)
Definition mxapi.h:330

◆ imap_tags_commit()

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

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 2613 of file imap.c.

2614{
2615 char uid[11] = { 0 };
2616
2618 if (!adata)
2619 return -1;
2620
2621 if (*buf == '\0')
2622 buf = NULL;
2623
2624 if (!(m->rights & MUTT_ACL_WRITE))
2625 return 0;
2626
2627 snprintf(uid, sizeof(uid), "%u", imap_edata_get(e)->uid);
2628
2629 /* Remove old custom flags */
2630 if (imap_edata_get(e)->flags_remote)
2631 {
2632 struct Buffer *cmd = buf_pool_get();
2633 buf_addstr(cmd, "UID STORE ");
2634 buf_addstr(cmd, uid);
2635 buf_addstr(cmd, " -FLAGS.SILENT (");
2636 buf_addstr(cmd, imap_edata_get(e)->flags_remote);
2637 buf_addstr(cmd, ")");
2638
2639 /* Should we return here, or we are fine and we could
2640 * continue to add new flags */
2641 int rc = imap_exec(adata, buf_string(cmd), IMAP_CMD_NONE);
2642 buf_pool_release(&cmd);
2643 if (rc != IMAP_EXEC_SUCCESS)
2644 {
2645 return -1;
2646 }
2647 }
2648
2649 /* Add new custom flags */
2650 if (buf)
2651 {
2652 struct Buffer *cmd = buf_pool_get();
2653 buf_addstr(cmd, "UID STORE ");
2654 buf_addstr(cmd, uid);
2655 buf_addstr(cmd, " +FLAGS.SILENT (");
2656 buf_addstr(cmd, buf);
2657 buf_addstr(cmd, ")");
2658
2659 int rc = imap_exec(adata, buf_string(cmd), IMAP_CMD_NONE);
2660 buf_pool_release(&cmd);
2661 if (rc != IMAP_EXEC_SUCCESS)
2662 {
2663 mutt_debug(LL_DEBUG1, "fail to add new flags\n");
2664 return -1;
2665 }
2666 }
2667
2668 /* We are good sync them */
2669 mutt_debug(LL_DEBUG1, "NEW TAGS: %s\n", buf);
2670 driver_tags_replace(&e->tags, buf);
2671 FREE(&imap_edata_get(e)->flags_remote);
2672 struct Buffer *flags_remote = buf_pool_get();
2673 driver_tags_get_with_hidden(&e->tags, flags_remote);
2674 imap_edata_get(e)->flags_remote = buf_strdup(flags_remote);
2675 buf_pool_release(&flags_remote);
2677 return 0;
2678}
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition buffer.c:233
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:577
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
@ MUTT_ACL_WRITE
Write to a message (for flagging or linking threads)
Definition mailbox.h:71
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
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:2225
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition adata.c:162
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:1420
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition edata.c:66
@ IMAP_EXEC_SUCCESS
Imap command executed or queued successfully.
Definition private.h:95
@ IMAP_CMD_NONE
No flags are set.
Definition private.h:82
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:45
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
void * adata
Private data (for Mailbox backends)
Definition account.h:42
String manipulation buffer.
Definition buffer.h:36
struct TagList tags
For drivers that support server tagging.
Definition email.h:72
IMAP-specific Account data -.
Definition adata.h:40
char * buf
Command buffer.
Definition adata.h:61
char * flags_remote
Remote flags.
Definition edata.h:49
AclFlags rights
ACL bits, see AclFlags.
Definition mailbox.h:121
bool driver_tags_replace(struct TagList *tl, const char *tags)
Replace all tags.
Definition tags.c:202
void driver_tags_get_with_hidden(struct TagList *tl, struct Buffer *tags)
Get all tags, also hidden ones, separated by space.
Definition tags.c:175
+ 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 )
static

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

Definition at line 2439 of file notmuch.c.

2440{
2441 if (*buf == '\0')
2442 return 0; /* no tag change, so nothing to do */
2443
2444 struct NmMboxData *mdata = nm_mdata_get(m);
2445 if (!mdata)
2446 return -1;
2447
2448 notmuch_database_t *db = NULL;
2449 notmuch_message_t *msg = NULL;
2450 int rc = -1;
2451
2452 if (!(db = nm_db_get(m, true)) || !(msg = get_nm_message(db, e)))
2453 goto done;
2454
2455 mutt_debug(LL_DEBUG1, "nm: tags modify: '%s'\n", buf);
2456
2457 update_tags(msg, buf);
2458 update_email_flags(m, e, buf);
2459 update_email_tags(e, msg);
2460 email_set_color(m, e);
2461
2462 rc = 0;
2463 e->changed = true;
2464done:
2465 nm_db_release(m);
2466 if (e->changed)
2467 {
2468 mdata->mtime.tv_sec = mutt_date_now();
2469 mdata->mtime.tv_nsec = 0;
2470 }
2471 mutt_debug(LL_DEBUG1, "nm: tags modify done [rc=%d]\n", rc);
2472 return rc;
2473}
void email_set_color(struct Mailbox *m, struct Email *e)
Select an Index colour for an Email.
Definition dlg_index.c:1431
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition date.c:459
notmuch_database_t * nm_db_get(struct Mailbox *m, bool writable)
Get the Notmuch database.
Definition db.c:210
int nm_db_release(struct Mailbox *m)
Close the Notmuch database.
Definition db.c:245
struct NmMboxData * nm_mdata_get(struct Mailbox *m)
Get the Notmuch Mailbox data.
Definition mdata.c:96
static notmuch_message_t * get_nm_message(notmuch_database_t *db, struct Email *e)
Find a Notmuch message.
Definition notmuch.c:1081
static int update_tags(notmuch_message_t *msg, const char *tag_str)
Update the tags on a message.
Definition notmuch.c:1141
static int update_email_tags(struct Email *e, notmuch_message_t *msg)
Update the Email's tags from Notmuch.
Definition notmuch.c:481
static int update_email_flags(struct Mailbox *m, struct Email *e, const char *tag_str)
Update the Email's flags.
Definition notmuch.c:1195
bool changed
Email has been edited.
Definition email.h:77
void * mdata
Driver specific data.
Definition mailbox.h:134
Notmuch-specific Mailbox data -.
Definition mdata.h:35
+ Here is the call graph for this function: