NeoMutt  2024-04-25-89-g194907
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 876 of file compress.c.

877{
878 if (!m->compress_info)
879 return 0;
880
881 struct CompressInfo *ci = m->compress_info;
882
883 const struct MxOps *ops = ci->child_ops;
884 if (!ops || !ops->tags_commit)
885 return 0;
886
887 return ops->tags_commit(m, e, buf);
888}
Private data for compress.
Definition: lib.h:58
const struct MxOps * child_ops
callbacks of de-compressed file
Definition: lib.h:63
void * compress_info
Compressed mbox module private data.
Definition: mailbox.h:121
Definition: mxapi.h:91
int(* tags_commit)(struct Mailbox *m, struct Email *e, const char *buf)
Definition: mxapi.h:323

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

2278{
2279 char uid[11] = { 0 };
2280
2282
2283 if (*buf == '\0')
2284 buf = NULL;
2285
2286 if (!(adata->mailbox->rights & MUTT_ACL_WRITE))
2287 return 0;
2288
2289 snprintf(uid, sizeof(uid), "%u", imap_edata_get(e)->uid);
2290
2291 /* Remove old custom flags */
2292 if (imap_edata_get(e)->flags_remote)
2293 {
2294 struct Buffer *cmd = buf_pool_get();
2295 buf_addstr(cmd, "UID STORE ");
2296 buf_addstr(cmd, uid);
2297 buf_addstr(cmd, " -FLAGS.SILENT (");
2298 buf_addstr(cmd, imap_edata_get(e)->flags_remote);
2299 buf_addstr(cmd, ")");
2300
2301 /* Should we return here, or we are fine and we could
2302 * continue to add new flags */
2303 int rc = imap_exec(adata, buf_string(cmd), IMAP_CMD_NO_FLAGS);
2304 buf_pool_release(&cmd);
2305 if (rc != IMAP_EXEC_SUCCESS)
2306 {
2307 return -1;
2308 }
2309 }
2310
2311 /* Add new custom flags */
2312 if (buf)
2313 {
2314 struct Buffer *cmd = buf_pool_get();
2315 buf_addstr(cmd, "UID STORE ");
2316 buf_addstr(cmd, uid);
2317 buf_addstr(cmd, " +FLAGS.SILENT (");
2318 buf_addstr(cmd, buf);
2319 buf_addstr(cmd, ")");
2320
2321 int rc = imap_exec(adata, buf_string(cmd), IMAP_CMD_NO_FLAGS);
2322 buf_pool_release(&cmd);
2323 if (rc != IMAP_EXEC_SUCCESS)
2324 {
2325 mutt_debug(LL_DEBUG1, "fail to add new flags\n");
2326 return -1;
2327 }
2328 }
2329
2330 /* We are good sync them */
2331 mutt_debug(LL_DEBUG1, "NEW TAGS: %s\n", buf);
2332 driver_tags_replace(&e->tags, buf);
2333 FREE(&imap_edata_get(e)->flags_remote);
2334 struct Buffer *flags_remote = buf_pool_get();
2335 driver_tags_get_with_hidden(&e->tags, flags_remote);
2336 imap_edata_get(e)->flags_remote = buf_strdup(flags_remote);
2337 buf_pool_release(&flags_remote);
2339 return 0;
2340}
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:89
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:2192
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:1304
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:67
#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:43
#define FREE(x)
Definition: memory.h:45
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
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 2418 of file notmuch.c.

2419{
2420 if (*buf == '\0')
2421 return 0; /* no tag change, so nothing to do */
2422
2423 struct NmMboxData *mdata = nm_mdata_get(m);
2424 if (!mdata)
2425 return -1;
2426
2427 notmuch_database_t *db = NULL;
2428 notmuch_message_t *msg = NULL;
2429 int rc = -1;
2430
2431 if (!(db = nm_db_get(m, true)) || !(msg = get_nm_message(db, e)))
2432 goto done;
2433
2434 mutt_debug(LL_DEBUG1, "nm: tags modify: '%s'\n", buf);
2435
2436 update_tags(msg, buf);
2437 update_email_flags(m, e, buf);
2438 update_email_tags(e, msg);
2440
2441 rc = 0;
2442 e->changed = true;
2443done:
2444 nm_db_release(m);
2445 if (e->changed)
2446 {
2447 mdata->mtime.tv_sec = mutt_date_now();
2448 mdata->mtime.tv_nsec = 0;
2449 }
2450 mutt_debug(LL_DEBUG1, "nm: tags modify done [rc=%d]\n", rc);
2451 return rc;
2452}
void mutt_set_header_color(struct Mailbox *m, struct Email *e)
Select a colour for a message.
Definition: dlg_index.c:1373
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:456
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:1047
static int update_tags(notmuch_message_t *msg, const char *tag_str)
Update the tags on a message.
Definition: notmuch.c:1105
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:1159
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: