NeoMutt  2025-12-11-58-g09398d
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 851 of file compress.c.

852{
853 if (!m->compress_info)
854 return 0;
855
856 struct CompressInfo *ci = m->compress_info;
857
858 const struct MxOps *ops = ci->child_ops;
859 if (!ops || !ops->tags_commit)
860 return 0;
861
862 return ops->tags_commit(m, e, buf);
863}
Private data for compress.
Definition lib.h:60
const struct MxOps * child_ops
callbacks of de-compressed file
Definition lib.h:65
void * compress_info
Compressed mbox module private data.
Definition mailbox.h:121
Definition mxapi.h:88
int(* tags_commit)(struct Mailbox *m, struct Email *e, const char *buf)
Definition mxapi.h:320

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

2313{
2314 char uid[11] = { 0 };
2315
2317 if (!adata)
2318 return -1;
2319
2320 if (*buf == '\0')
2321 buf = NULL;
2322
2323 if (!(adata->mailbox->rights & MUTT_ACL_WRITE))
2324 return 0;
2325
2326 snprintf(uid, sizeof(uid), "%u", imap_edata_get(e)->uid);
2327
2328 /* Remove old custom flags */
2329 if (imap_edata_get(e)->flags_remote)
2330 {
2331 struct Buffer *cmd = buf_pool_get();
2332 buf_addstr(cmd, "UID STORE ");
2333 buf_addstr(cmd, uid);
2334 buf_addstr(cmd, " -FLAGS.SILENT (");
2335 buf_addstr(cmd, imap_edata_get(e)->flags_remote);
2336 buf_addstr(cmd, ")");
2337
2338 /* Should we return here, or we are fine and we could
2339 * continue to add new flags */
2340 int rc = imap_exec(adata, buf_string(cmd), IMAP_CMD_NO_FLAGS);
2341 buf_pool_release(&cmd);
2342 if (rc != IMAP_EXEC_SUCCESS)
2343 {
2344 return -1;
2345 }
2346 }
2347
2348 /* Add new custom flags */
2349 if (buf)
2350 {
2351 struct Buffer *cmd = buf_pool_get();
2352 buf_addstr(cmd, "UID STORE ");
2353 buf_addstr(cmd, uid);
2354 buf_addstr(cmd, " +FLAGS.SILENT (");
2355 buf_addstr(cmd, buf);
2356 buf_addstr(cmd, ")");
2357
2358 int rc = imap_exec(adata, buf_string(cmd), IMAP_CMD_NO_FLAGS);
2359 buf_pool_release(&cmd);
2360 if (rc != IMAP_EXEC_SUCCESS)
2361 {
2362 mutt_debug(LL_DEBUG1, "fail to add new flags\n");
2363 return -1;
2364 }
2365 }
2366
2367 /* We are good sync them */
2368 mutt_debug(LL_DEBUG1, "NEW TAGS: %s\n", buf);
2369 driver_tags_replace(&e->tags, buf);
2370 FREE(&imap_edata_get(e)->flags_remote);
2371 struct Buffer *flags_remote = buf_pool_get();
2372 driver_tags_get_with_hidden(&e->tags, flags_remote);
2373 imap_edata_get(e)->flags_remote = buf_strdup(flags_remote);
2374 buf_pool_release(&flags_remote);
2376 return 0;
2377}
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition buffer.c:226
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:571
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
#define MUTT_ACL_WRITE
Write to a message (for flagging or linking threads)
Definition mailbox.h:71
#define mutt_debug(LEVEL,...)
Definition logging2.h:90
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:2211
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition adata.c:123
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:1322
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition edata.c:66
#define IMAP_CMD_NO_FLAGS
No flags are set.
Definition private.h:71
@ IMAP_EXEC_SUCCESS
Imap command executed or queued successfully.
Definition private.h:82
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:44
#define FREE(x)
Definition memory.h:62
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:96
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
Definition adata.h:59
char * flags_remote
Definition edata.h:49
bool driver_tags_replace(struct TagList *tl, const char *tags)
Replace all tags.
Definition tags.c:201
void driver_tags_get_with_hidden(struct TagList *tl, struct Buffer *tags)
Get all tags, also hidden ones, separated by space.
Definition tags.c:174
+ 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 2440 of file notmuch.c.

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