NeoMutt  2025-05-10
Teaching an old dog new tricks
 		DOXYGEN
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
private.h File Reference

Shared constants/structs that are private to IMAP. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "config/lib.h"
+ Include dependency graph for private.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ImapList
 Items in an IMAP browser. More...
 
struct  ImapCommand
 IMAP command structure. More...
 
struct  SeqsetIterator
 UID Sequence Set Iterator. More...
 

Macros

#define IMAP_PORT   143
 Default port for IMAP.
 
#define IMAP_SSL_PORT   993
 Port for IMAP over SSL/TLS.
 
#define IMAP_LOG_CMD   2
 
#define IMAP_LOG_LTRL   3
 
#define IMAP_LOG_PASS   5
 
#define IMAP_RES_NO   -2
 <tag> NO ...
 
#define IMAP_RES_BAD   -1
 <tag> BAD ...
 
#define IMAP_RES_OK   0
 <tag> OK ...
 
#define IMAP_RES_CONTINUE   1
 * ...
 
#define IMAP_RES_RESPOND   2
 +
 
#define IMAP_RES_NEW   3
 ImapCommand.state additions.
 
#define SEQ_LEN   16
 
#define IMAP_OPEN_NO_FLAGS   0
 No flags are set.
 
#define IMAP_REOPEN_ALLOW   (1 << 0)
 Allow re-opening a folder upon expunge.
 
#define IMAP_EXPUNGE_EXPECTED   (1 << 1)
 Messages will be expunged from the server.
 
#define IMAP_EXPUNGE_PENDING   (1 << 2)
 Messages on the server have been expunged.
 
#define IMAP_NEWMAIL_PENDING   (1 << 3)
 New mail is waiting on the server.
 
#define IMAP_FLAGS_PENDING   (1 << 4)
 Flags have changed on the server.
 
#define IMAP_CMD_NO_FLAGS   0
 No flags are set.
 
#define IMAP_CMD_PASS   (1 << 0)
 Command contains a password. Suppress logging.
 
#define IMAP_CMD_QUEUE   (1 << 1)
 Queue a command, do not execute.
 
#define IMAP_CMD_POLL   (1 << 2)
 Poll the tcp connection before running the imap command.
 
#define IMAP_CMD_SINGLE   (1 << 3)
 Run a single command.
 
#define IMAP_DATELEN   27
 
#define IMAP_CAP_NO_FLAGS   0
 No flags are set.
 
#define IMAP_CAP_IMAP4   (1 << 0)
 Server supports IMAP4.
 
#define IMAP_CAP_IMAP4REV1   (1 << 1)
 Server supports IMAP4rev1.
 
#define IMAP_CAP_STATUS   (1 << 2)
 Server supports STATUS command.
 
#define IMAP_CAP_ACL   (1 << 3)
 RFC2086: IMAP4 ACL extension.
 
#define IMAP_CAP_NAMESPACE   (1 << 4)
 RFC2342: IMAP4 Namespace.
 
#define IMAP_CAP_AUTH_CRAM_MD5   (1 << 5)
 RFC2195: CRAM-MD5 authentication.
 
#define IMAP_CAP_AUTH_GSSAPI   (1 << 6)
 RFC1731: GSSAPI authentication.
 
#define IMAP_CAP_AUTH_ANONYMOUS   (1 << 7)
 AUTH=ANONYMOUS.
 
#define IMAP_CAP_AUTH_OAUTHBEARER   (1 << 8)
 RFC7628: AUTH=OAUTHBEARER.
 
#define IMAP_CAP_AUTH_XOAUTH2   (1 << 9)
 AUTH=XOAUTH2, deprecated but used by OWA.
 
#define IMAP_CAP_STARTTLS   (1 << 10)
 RFC2595: STARTTLS.
 
#define IMAP_CAP_LOGINDISABLED   (1 << 11)
 RFC2595: LOGINDISABLED.
 
#define IMAP_CAP_IDLE   (1 << 12)
 RFC2177: IDLE.
 
#define IMAP_CAP_SASL_IR   (1 << 13)
 SASL initial response draft.
 
#define IMAP_CAP_ENABLE   (1 << 14)
 RFC5161.
 
#define IMAP_CAP_CONDSTORE   (1 << 15)
 RFC7162.
 
#define IMAP_CAP_QRESYNC   (1 << 16)
 RFC7162.
 
#define IMAP_CAP_LIST_EXTENDED   (1 << 17)
 RFC5258: IMAP4 LIST Command Extensions.
 
#define IMAP_CAP_COMPRESS   (1 << 18)
 RFC4978: COMPRESS=DEFLATE.
 
#define IMAP_CAP_X_GM_EXT_1   (1 << 19)
 https://developers.google.com/gmail/imap/imap-extensions
 
#define IMAP_CAP_ID   (1 << 20)
 RFC2971: IMAP4 ID extension.
 
#define IMAP_CAP_ALL   ((1 << 21) - 1)
 

Typedefs

typedef uint8_t ImapOpenFlags
 Flags, e.g. MUTT_THREAD_COLLAPSE.
 
typedef uint8_t ImapCmdFlags
 Flags for imap_exec(), e.g. IMAP_CMD_PASS.
 
typedef uint32_t ImapCapFlags
 Capabilities we are interested in.
 

Enumerations

enum  ImapExecResult { IMAP_EXEC_SUCCESS = 0 , IMAP_EXEC_ERROR , IMAP_EXEC_FATAL }
 Imap_exec return code. More...
 
enum  ImapFlags { IMAP_FATAL = 1 , IMAP_BYE }
 IMAP server responses. More...
 
enum  ImapState {
  IMAP_DISCONNECTED = 0 , IMAP_CONNECTED , IMAP_AUTHENTICATED , IMAP_SELECTED ,
  IMAP_IDLE
}
 IMAP connection state. More...
 

Functions

int imap_create_mailbox (struct ImapAccountData *adata, const char *mailbox)
 Create a new mailbox.
 
int imap_rename_mailbox (struct ImapAccountData *adata, char *oldname, const char *newname)
 Rename a mailbox.
 
int imap_open_connection (struct ImapAccountData *adata)
 Open an IMAP connection.
 
void imap_close_connection (struct ImapAccountData *adata)
 Close an IMAP connection.
 
int imap_read_literal (FILE *fp, struct ImapAccountData *adata, unsigned long bytes, struct Progress *progress)
 Read bytes bytes from server into file.
 
void imap_expunge_mailbox (struct Mailbox *m, bool resort)
 Purge messages from the server.
 
int imap_login (struct ImapAccountData *adata)
 Open an IMAP connection.
 
int imap_sync_message_for_copy (struct Mailbox *m, struct Email *e, struct Buffer *cmd, enum QuadOption *err_continue)
 Update server to reflect the flags of a single message.
 
bool imap_has_flag (struct ListHead *flag_list, const char *flag)
 Does the flag exist in the list.
 
int imap_adata_find (const char *path, struct ImapAccountData **adata, struct ImapMboxData **mdata)
 Find the Account data for this path.
 
int imap_authenticate (struct ImapAccountData *adata)
 Authenticate to an IMAP server.
 
int imap_cmd_start (struct ImapAccountData *adata, const char *cmdstr)
 Given an IMAP command, send it to the server.
 
int imap_cmd_step (struct ImapAccountData *adata)
 Reads server responses from an IMAP command.
 
void imap_cmd_finish (struct ImapAccountData *adata)
 Attempt to perform cleanup.
 
bool imap_code (const char *s)
 Was the command successful.
 
const char * imap_cmd_trailer (struct ImapAccountData *adata)
 Extra information after tagged command response if any.
 
int imap_exec (struct ImapAccountData *adata, const char *cmdstr, ImapCmdFlags flags)
 Execute a command and wait for the response from the server.
 
int imap_cmd_idle (struct ImapAccountData *adata)
 Enter the IDLE state.
 
int imap_read_headers (struct Mailbox *m, unsigned int msn_begin, unsigned int msn_end, bool initial_download)
 Read headers from the server.
 
char * imap_set_flags (struct Mailbox *m, struct Email *e, char *s, bool *server_changes)
 Fill the message header according to the server flags.
 
int imap_cache_del (struct Mailbox *m, struct Email *e)
 Delete an email from the body cache.
 
int imap_cache_clean (struct Mailbox *m)
 Delete all the entries in the message cache.
 
int imap_append_message (struct Mailbox *m, struct Message *msg)
 Write an email back to the server.
 
bool imap_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
 Open an email message in a Mailbox - Implements MxOps::msg_open() -.
 
int imap_msg_close (struct Mailbox *m, struct Message *msg)
 Close an email - Implements MxOps::msg_close() -.
 
int imap_msg_commit (struct Mailbox *m, struct Message *msg)
 Save changes to an email - Implements MxOps::msg_commit() -.
 
int imap_msg_save_hcache (struct Mailbox *m, struct Email *e)
 Save message to the header cache - Implements MxOps::msg_save_hcache() -.
 
void imap_hcache_open (struct ImapAccountData *adata, struct ImapMboxData *mdata, bool create)
 Open a header cache.
 
void imap_hcache_close (struct ImapMboxData *mdata)
 Close the header cache.
 
struct Email * imap_hcache_get (struct ImapMboxData *mdata, unsigned int uid)
 Get a header cache entry by its UID.
 
int imap_hcache_put (struct ImapMboxData *mdata, struct Email *e)
 Add an entry to the header cache.
 
int imap_hcache_del (struct ImapMboxData *mdata, unsigned int uid)
 Delete an item from the header cache.
 
int imap_hcache_store_uid_seqset (struct ImapMboxData *mdata)
 Store a UID Sequence Set in the header cache.
 
int imap_hcache_clear_uid_seqset (struct ImapMboxData *mdata)
 Delete a UID Sequence Set from the header cache.
 
char * imap_hcache_get_uid_seqset (struct ImapMboxData *mdata)
 Get a UID Sequence Set from the header cache.
 
enum QuadOption imap_continue (const char *msg, const char *resp)
 Display a message and ask the user if they want to go on.
 
void imap_error (const char *where, const char *msg)
 Show an error and abort.
 
void imap_mdata_cache_reset (struct ImapMboxData *mdata)
 Release and clear cache data of ImapMboxData structure.
 
char * imap_fix_path (const char *mailbox, char *path, size_t plen)
 Fix up the imap path.
 
char * imap_fix_path_with_delim (char delim, const char *mailbox, char *path, size_t plen)
 Fix up the imap path.
 
void imap_cachepath (char delim, const char *mailbox, struct Buffer *dest)
 Generate a cache path for a mailbox.
 
int imap_get_literal_count (const char *buf, unsigned int *bytes)
 Write number of bytes in an IMAP literal into bytes.
 
char * imap_get_qualifier (char *buf)
 Get the qualifier from a tagged response.
 
char * imap_next_word (char *s)
 Find where the next IMAP word begins.
 
void imap_qualify_path (char *buf, size_t buflen, struct ConnAccount *conn_account, char *path)
 Make an absolute IMAP folder target.
 
void imap_buf_qualify_path (struct Buffer *buf, struct ConnAccount *conn_account, char *path)
 Make an absolute IMAP folder target to a buffer.
 
void imap_quote_string (char *dest, size_t dlen, const char *src, bool quote_backtick)
 Quote string according to IMAP rules.
 
void imap_unquote_string (char *s)
 Equally stupid unquoting routine.
 
void imap_munge_mbox_name (bool unicode, char *dest, size_t dlen, const char *src)
 Quote awkward characters in a mailbox name.
 
void imap_unmunge_mbox_name (bool unicode, char *s)
 Remove quoting from a mailbox name.
 
struct SeqsetIterator * mutt_seqset_iterator_new (const char *seqset)
 Create a new Sequence Set Iterator.
 
int mutt_seqset_iterator_next (struct SeqsetIterator *iter, unsigned int *next)
 Get the next UID from a Sequence Set.
 
void mutt_seqset_iterator_free (struct SeqsetIterator **ptr)
 Free a Sequence Set Iterator.
 
bool imap_account_match (const struct ConnAccount *a1, const struct ConnAccount *a2)
 Compare two Accounts.
 
void imap_get_parent (const char *mbox, char delim, char *buf, size_t buflen)
 Get an IMAP folder's parent.
 
bool mutt_account_match (const struct ConnAccount *a1, const struct ConnAccount *a2)
 
void imap_utf_encode (bool unicode, char **s)
 Encode email from local charset to UTF-8.
 
void imap_utf_decode (bool unicode, char **s)
 Decode email from UTF-8 to local charset.
 
void imap_allow_reopen (struct Mailbox *m)
 Allow re-opening a folder upon expunge.
 
void imap_disallow_reopen (struct Mailbox *m)
 Disallow re-opening a folder upon expunge.
 
void cmd_parse_search (struct ImapAccountData *adata, const char *s)
 Store SEARCH response for later use.
 

Detailed Description

Shared constants/structs that are private to IMAP.

Authors
  • Pietro Cerutti
  • Richard Russon
  • Mehdi Abaakouk
Copyright
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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

Macro Definition Documentation

◆ IMAP_PORT

#define IMAP_PORT   143

Default port for IMAP.

Definition at line 44 of file private.h.

◆ IMAP_SSL_PORT

#define IMAP_SSL_PORT   993

Port for IMAP over SSL/TLS.

Definition at line 45 of file private.h.

◆ IMAP_LOG_CMD

#define IMAP_LOG_CMD   2

Definition at line 48 of file private.h.

◆ IMAP_LOG_LTRL

#define IMAP_LOG_LTRL   3

Definition at line 49 of file private.h.

◆ IMAP_LOG_PASS

#define IMAP_LOG_PASS   5

Definition at line 50 of file private.h.

◆ IMAP_RES_NO

#define IMAP_RES_NO   -2

<tag> NO ...

Definition at line 53 of file private.h.

◆ IMAP_RES_BAD

#define IMAP_RES_BAD   -1

<tag> BAD ...

Definition at line 54 of file private.h.

◆ IMAP_RES_OK

#define IMAP_RES_OK   0

<tag> OK ...

Definition at line 55 of file private.h.

◆ IMAP_RES_CONTINUE

#define IMAP_RES_CONTINUE   1

* ...

Definition at line 56 of file private.h.

◆ IMAP_RES_RESPOND

#define IMAP_RES_RESPOND   2

+

Definition at line 57 of file private.h.

◆ IMAP_RES_NEW

#define IMAP_RES_NEW   3

ImapCommand.state additions.

Definition at line 58 of file private.h.

◆ SEQ_LEN

#define SEQ_LEN   16

Definition at line 60 of file private.h.

◆ IMAP_OPEN_NO_FLAGS

#define IMAP_OPEN_NO_FLAGS   0

No flags are set.

Definition at line 63 of file private.h.

◆ IMAP_REOPEN_ALLOW

#define IMAP_REOPEN_ALLOW   (1 << 0)

Allow re-opening a folder upon expunge.

Definition at line 64 of file private.h.

◆ IMAP_EXPUNGE_EXPECTED

#define IMAP_EXPUNGE_EXPECTED   (1 << 1)

Messages will be expunged from the server.

Definition at line 65 of file private.h.

◆ IMAP_EXPUNGE_PENDING

#define IMAP_EXPUNGE_PENDING   (1 << 2)

Messages on the server have been expunged.

Definition at line 66 of file private.h.

◆ IMAP_NEWMAIL_PENDING

#define IMAP_NEWMAIL_PENDING   (1 << 3)

New mail is waiting on the server.

Definition at line 67 of file private.h.

◆ IMAP_FLAGS_PENDING

#define IMAP_FLAGS_PENDING   (1 << 4)

Flags have changed on the server.

Definition at line 68 of file private.h.

◆ IMAP_CMD_NO_FLAGS

#define IMAP_CMD_NO_FLAGS   0

No flags are set.

Definition at line 71 of file private.h.

◆ IMAP_CMD_PASS

#define IMAP_CMD_PASS   (1 << 0)

Command contains a password. Suppress logging.

Definition at line 72 of file private.h.

◆ IMAP_CMD_QUEUE

#define IMAP_CMD_QUEUE   (1 << 1)

Queue a command, do not execute.

Definition at line 73 of file private.h.

◆ IMAP_CMD_POLL

#define IMAP_CMD_POLL   (1 << 2)

Poll the tcp connection before running the imap command.

Definition at line 74 of file private.h.

◆ IMAP_CMD_SINGLE

#define IMAP_CMD_SINGLE   (1 << 3)

Run a single command.

Definition at line 75 of file private.h.

◆ IMAP_DATELEN

#define IMAP_DATELEN   27

Definition at line 88 of file private.h.

◆ IMAP_CAP_NO_FLAGS

#define IMAP_CAP_NO_FLAGS   0

No flags are set.

Definition at line 120 of file private.h.

◆ IMAP_CAP_IMAP4

#define IMAP_CAP_IMAP4   (1 << 0)

Server supports IMAP4.

Definition at line 121 of file private.h.

◆ IMAP_CAP_IMAP4REV1

#define IMAP_CAP_IMAP4REV1   (1 << 1)

Server supports IMAP4rev1.

Definition at line 122 of file private.h.

◆ IMAP_CAP_STATUS

#define IMAP_CAP_STATUS   (1 << 2)

Server supports STATUS command.

Definition at line 123 of file private.h.

◆ IMAP_CAP_ACL

#define IMAP_CAP_ACL   (1 << 3)

RFC2086: IMAP4 ACL extension.

Definition at line 124 of file private.h.

◆ IMAP_CAP_NAMESPACE

#define IMAP_CAP_NAMESPACE   (1 << 4)

RFC2342: IMAP4 Namespace.

Definition at line 125 of file private.h.

◆ IMAP_CAP_AUTH_CRAM_MD5

#define IMAP_CAP_AUTH_CRAM_MD5   (1 << 5)

RFC2195: CRAM-MD5 authentication.

Definition at line 126 of file private.h.

◆ IMAP_CAP_AUTH_GSSAPI

#define IMAP_CAP_AUTH_GSSAPI   (1 << 6)

RFC1731: GSSAPI authentication.

Definition at line 127 of file private.h.

◆ IMAP_CAP_AUTH_ANONYMOUS

#define IMAP_CAP_AUTH_ANONYMOUS   (1 << 7)

AUTH=ANONYMOUS.

Definition at line 128 of file private.h.

◆ IMAP_CAP_AUTH_OAUTHBEARER

#define IMAP_CAP_AUTH_OAUTHBEARER   (1 << 8)

RFC7628: AUTH=OAUTHBEARER.

Definition at line 129 of file private.h.

◆ IMAP_CAP_AUTH_XOAUTH2

#define IMAP_CAP_AUTH_XOAUTH2   (1 << 9)

AUTH=XOAUTH2, deprecated but used by OWA.

Definition at line 130 of file private.h.

◆ IMAP_CAP_STARTTLS

#define IMAP_CAP_STARTTLS   (1 << 10)

RFC2595: STARTTLS.

Definition at line 131 of file private.h.

◆ IMAP_CAP_LOGINDISABLED

#define IMAP_CAP_LOGINDISABLED   (1 << 11)

RFC2595: LOGINDISABLED.

Definition at line 132 of file private.h.

◆ IMAP_CAP_IDLE

#define IMAP_CAP_IDLE   (1 << 12)

RFC2177: IDLE.

Definition at line 133 of file private.h.

◆ IMAP_CAP_SASL_IR

#define IMAP_CAP_SASL_IR   (1 << 13)

SASL initial response draft.

Definition at line 134 of file private.h.

◆ IMAP_CAP_ENABLE

#define IMAP_CAP_ENABLE   (1 << 14)

RFC5161.

Definition at line 135 of file private.h.

◆ IMAP_CAP_CONDSTORE

#define IMAP_CAP_CONDSTORE   (1 << 15)

RFC7162.

Definition at line 136 of file private.h.

◆ IMAP_CAP_QRESYNC

#define IMAP_CAP_QRESYNC   (1 << 16)

RFC7162.

Definition at line 137 of file private.h.

◆ IMAP_CAP_LIST_EXTENDED

#define IMAP_CAP_LIST_EXTENDED   (1 << 17)

RFC5258: IMAP4 LIST Command Extensions.

Definition at line 138 of file private.h.

◆ IMAP_CAP_COMPRESS

#define IMAP_CAP_COMPRESS   (1 << 18)

RFC4978: COMPRESS=DEFLATE.

Definition at line 139 of file private.h.

◆ IMAP_CAP_X_GM_EXT_1

#define IMAP_CAP_X_GM_EXT_1   (1 << 19)

https://developers.google.com/gmail/imap/imap-extensions

Definition at line 140 of file private.h.

◆ IMAP_CAP_ID

#define IMAP_CAP_ID   (1 << 20)

RFC2971: IMAP4 ID extension.

Definition at line 141 of file private.h.

◆ IMAP_CAP_ALL

#define IMAP_CAP_ALL   ((1 << 21) - 1)

Definition at line 143 of file private.h.

Typedef Documentation

◆ ImapOpenFlags

typedef uint8_t ImapOpenFlags

Flags, e.g. MUTT_THREAD_COLLAPSE.

Definition at line 62 of file private.h.

◆ ImapCmdFlags

typedef uint8_t ImapCmdFlags

Flags for imap_exec(), e.g. IMAP_CMD_PASS.

Definition at line 70 of file private.h.

◆ ImapCapFlags

typedef uint32_t ImapCapFlags

Capabilities we are interested in.

Note
This must be kept in the same order as Capabilities. Flags, e.g. IMAP_CAP_IMAP4

Definition at line 119 of file private.h.

Enumeration Type Documentation

◆ ImapExecResult

enum ImapExecResult

Imap_exec return code.

Enumerator
IMAP_EXEC_SUCCESS 

Imap command executed or queued successfully.

IMAP_EXEC_ERROR 

Imap command failure.

IMAP_EXEC_FATAL 

Imap connection failure.

Definition at line 80 of file private.h.

81{
82 IMAP_EXEC_SUCCESS = 0,
83 IMAP_EXEC_ERROR,
84 IMAP_EXEC_FATAL,
85};
IMAP_EXEC_SUCCESS
@ IMAP_EXEC_SUCCESS
Imap command executed or queued successfully.
Definition: private.h:82
IMAP_EXEC_ERROR
@ IMAP_EXEC_ERROR
Imap command failure.
Definition: private.h:83
IMAP_EXEC_FATAL
@ IMAP_EXEC_FATAL
Imap connection failure.
Definition: private.h:84

◆ ImapFlags

enum ImapFlags

IMAP server responses.

Enumerator
IMAP_FATAL 

Unrecoverable error occurred.

IMAP_BYE 

Logged out from server.

Definition at line 93 of file private.h.

94{
95 IMAP_FATAL = 1,
96 IMAP_BYE,
97};
IMAP_BYE
@ IMAP_BYE
Logged out from server.
Definition: private.h:96
IMAP_FATAL
@ IMAP_FATAL
Unrecoverable error occurred.
Definition: private.h:95

◆ ImapState

enum ImapState

IMAP connection state.

Enumerator
IMAP_DISCONNECTED 

Disconnected from server.

IMAP_CONNECTED 

Connected to server.

IMAP_AUTHENTICATED 

Connection is authenticated.

IMAP_SELECTED 

Mailbox is selected.

IMAP_IDLE 

Connection is idle.

Definition at line 102 of file private.h.

103{
104 /* States */
105 IMAP_DISCONNECTED = 0,
106 IMAP_CONNECTED,
107 IMAP_AUTHENTICATED,
108 IMAP_SELECTED,
109
110 /* and pseudo-states */
111 IMAP_IDLE,
112};
IMAP_DISCONNECTED
@ IMAP_DISCONNECTED
Disconnected from server.
Definition: private.h:105
IMAP_IDLE
@ IMAP_IDLE
Connection is idle.
Definition: private.h:111
IMAP_AUTHENTICATED
@ IMAP_AUTHENTICATED
Connection is authenticated.
Definition: private.h:107
IMAP_SELECTED
@ IMAP_SELECTED
Mailbox is selected.
Definition: private.h:108
IMAP_CONNECTED
@ IMAP_CONNECTED
Connected to server.
Definition: private.h:106

Function Documentation

◆ imap_create_mailbox()

int imap_create_mailbox ( struct ImapAccountData *  adata,
const char *  mailbox 
)

Create a new mailbox.

Parameters
adataImap Account data
mailboxMailbox to create
Return values
0Success
-1Failure

Definition at line 436 of file imap.c.

437{
438 char buf[2048] = { 0 };
439 char mbox[1024] = { 0 };
440
441 imap_munge_mbox_name(adata->unicode, mbox, sizeof(mbox), mailbox);
442 snprintf(buf, sizeof(buf), "CREATE %s", mbox);
443
444 if (imap_exec(adata, buf, IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS)
445 {
446 mutt_error(_("CREATE failed: %s"), imap_cmd_trailer(adata));
447 return -1;
448 }
449
450 return 0;
451}
mutt_error
#define mutt_error(...)
Definition: logging2.h:93
imap_cmd_trailer
const char * imap_cmd_trailer(struct ImapAccountData *adata)
Extra information after tagged command response if any.
Definition: command.c:1266
imap_exec
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:1303
IMAP_CMD_NO_FLAGS
#define IMAP_CMD_NO_FLAGS
No flags are set.
Definition: private.h:71
imap_munge_mbox_name
void imap_munge_mbox_name(bool unicode, char *dest, size_t dlen, const char *src)
Quote awkward characters in a mailbox name.
Definition: util.c:960
_
#define _(a)
Definition: message.h:28
ImapAccountData::unicode
bool unicode
If true, we can send UTF-8, and the server will use UTF8 rather than mUTF7.
Definition: adata.h:62
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_rename_mailbox()

int imap_rename_mailbox ( struct ImapAccountData *  adata,
char *  oldname,
const char *  newname 
)

Rename a mailbox.

Parameters
adataImap Account data
oldnameExisting mailbox
newnameNew name for mailbox
Return values
0Success
-1Failure

Definition at line 478 of file imap.c.

479{
480 char oldmbox[1024] = { 0 };
481 char newmbox[1024] = { 0 };
482 int rc = 0;
483
484 imap_munge_mbox_name(adata->unicode, oldmbox, sizeof(oldmbox), oldname);
485 imap_munge_mbox_name(adata->unicode, newmbox, sizeof(newmbox), newname);
486
487 struct Buffer *buf = buf_pool_get();
488 buf_printf(buf, "RENAME %s %s", oldmbox, newmbox);
489
490 if (imap_exec(adata, buf_string(buf), IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS)
491 rc = -1;
492
493 buf_pool_release(&buf);
494
495 return rc;
496}
buf_printf
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:161
buf_string
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
buf_pool_get
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:82
buf_pool_release
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:96
Buffer
String manipulation buffer.
Definition: buffer.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_open_connection()

int imap_open_connection ( struct ImapAccountData *  adata)

Open an IMAP connection.

Parameters
adataImap Account data
Return values
0Success
-1Failure

Definition at line 744 of file imap.c.

745{
746 if (mutt_socket_open(adata->conn) < 0)
747 return -1;
748
749 adata->state = IMAP_CONNECTED;
750
751 if (imap_cmd_step(adata) != IMAP_RES_OK)
752 {
753 imap_close_connection(adata);
754 return -1;
755 }
756
757 if (mutt_istr_startswith(adata->buf, "* OK"))
758 {
759 if (!mutt_istr_startswith(adata->buf, "* OK [CAPABILITY") && check_capabilities(adata))
760 {
761 goto bail;
762 }
763#ifdef USE_SSL
764 /* Attempt STARTTLS if available and desired. */
765 const bool c_ssl_force_tls = cs_subset_bool(NeoMutt->sub, "ssl_force_tls");
766 if ((adata->conn->ssf == 0) &&
767 (c_ssl_force_tls || (adata->capabilities & IMAP_CAP_STARTTLS)))
768 {
769 enum QuadOption ans;
770
771 if (c_ssl_force_tls)
772 {
773 ans = MUTT_YES;
774 }
775 else if ((ans = query_quadoption(_("Secure connection with TLS?"),
776 NeoMutt->sub, "ssl_starttls")) == MUTT_ABORT)
777 {
778 goto bail;
779 }
780 if (ans == MUTT_YES)
781 {
782 enum ImapExecResult rc = imap_exec(adata, "STARTTLS", IMAP_CMD_SINGLE);
783 // Clear any data after the STARTTLS acknowledgement
784 mutt_socket_empty(adata->conn);
785
786 if (rc == IMAP_EXEC_FATAL)
787 goto bail;
788 if (rc != IMAP_EXEC_ERROR)
789 {
790 if (mutt_ssl_starttls(adata->conn))
791 {
792 mutt_error(_("Could not negotiate TLS connection"));
793 goto bail;
794 }
795 else
796 {
797 /* RFC2595 demands we recheck CAPABILITY after TLS completes. */
798 if (imap_exec(adata, "CAPABILITY", IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS)
799 goto bail;
800 }
801 }
802 }
803 }
804
805 if (c_ssl_force_tls && (adata->conn->ssf == 0))
806 {
807 mutt_error(_("Encrypted connection unavailable"));
808 goto bail;
809 }
810#endif
811 }
812 else if (mutt_istr_startswith(adata->buf, "* PREAUTH"))
813 {
814#ifdef USE_SSL
815 /* Unless using a secure $tunnel, an unencrypted PREAUTH response may be a
816 * MITM attack. The only way to stop "STARTTLS" MITM attacks is via
817 * $ssl_force_tls: an attacker can easily spoof "* OK" and strip the
818 * STARTTLS capability. So consult $ssl_force_tls, not $ssl_starttls, to
819 * decide whether to abort. Note that if using $tunnel and
820 * $tunnel_is_secure, adata->conn->ssf will be set to 1. */
821 const bool c_ssl_force_tls = cs_subset_bool(NeoMutt->sub, "ssl_force_tls");
822 if ((adata->conn->ssf == 0) && c_ssl_force_tls)
823 {
824 mutt_error(_("Encrypted connection unavailable"));
825 goto bail;
826 }
827#endif
828
829 adata->state = IMAP_AUTHENTICATED;
830 if (check_capabilities(adata) != 0)
831 goto bail;
832 FREE(&adata->capstr);
833 }
834 else
835 {
836 imap_error("imap_open_connection()", adata->buf);
837 goto bail;
838 }
839
840 return 0;
841
842bail:
843 imap_close_connection(adata);
844 FREE(&adata->capstr);
845 return -1;
846}
cs_subset_bool
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
mutt_ssl_starttls
int mutt_ssl_starttls(struct Connection *conn)
Negotiate TLS over an already opened connection.
Definition: gnutls.c:1149
imap_cmd_step
int imap_cmd_step(struct ImapAccountData *adata)
Reads server responses from an IMAP command.
Definition: command.c:1128
IMAP_RES_OK
#define IMAP_RES_OK
<tag> OK ...
Definition: private.h:55
IMAP_CAP_STARTTLS
#define IMAP_CAP_STARTTLS
RFC2595: STARTTLS.
Definition: private.h:131
ImapExecResult
ImapExecResult
Imap_exec return code.
Definition: private.h:81
imap_error
void imap_error(const char *where, const char *msg)
Show an error and abort.
Definition: util.c:660
IMAP_CMD_SINGLE
#define IMAP_CMD_SINGLE
Run a single command.
Definition: private.h:75
imap_close_connection
void imap_close_connection(struct ImapAccountData *adata)
Close an IMAP connection.
Definition: imap.c:852
check_capabilities
static int check_capabilities(struct ImapAccountData *adata)
Make sure we can log in to this server.
Definition: imap.c:107
FREE
#define FREE(x)
Definition: memory.h:55
mutt_istr_startswith
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:243
QuadOption
QuadOption
Possible values for a quad-option.
Definition: quad.h:36
MUTT_ABORT
@ MUTT_ABORT
User aborted the question (with Ctrl-G)
Definition: quad.h:37
MUTT_YES
@ MUTT_YES
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:39
query_quadoption
enum QuadOption query_quadoption(const char *prompt, struct ConfigSubset *sub, const char *name)
Ask the user a quad-question.
Definition: question.c:379
mutt_socket_empty
void mutt_socket_empty(struct Connection *conn)
Clear out any queued data.
Definition: socket.c:306
mutt_socket_open
int mutt_socket_open(struct Connection *conn)
Simple wrapper.
Definition: socket.c:76
Connection::ssf
unsigned int ssf
Security strength factor, in bits (see notes)
Definition: connection.h:50
ImapAccountData::capabilities
ImapCapFlags capabilities
Capability flags.
Definition: adata.h:55
ImapAccountData::state
unsigned char state
ImapState, e.g. IMAP_AUTHENTICATED.
Definition: adata.h:44
ImapAccountData::capstr
char * capstr
Capability string from the server.
Definition: adata.h:54
ImapAccountData::buf
char * buf
Definition: adata.h:59
ImapAccountData::conn
struct Connection * conn
Connection to IMAP server.
Definition: adata.h:41
NeoMutt
Container for Accounts, Notifications.
Definition: neomutt.h:43
NeoMutt::sub
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:47
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_close_connection()

void imap_close_connection ( struct ImapAccountData *  adata)

Close an IMAP connection.

Parameters
adataImap Account data

Definition at line 852 of file imap.c.

853{
854 if (adata->state != IMAP_DISCONNECTED)
855 {
856 mutt_socket_close(adata->conn);
857 adata->state = IMAP_DISCONNECTED;
858 }
859 adata->seqno = 0;
860 adata->nextcmd = 0;
861 adata->lastcmd = 0;
862 adata->status = 0;
863 memset(adata->cmds, 0, sizeof(struct ImapCommand) * adata->cmdslots);
864}
mutt_socket_close
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:100
ImapAccountData::lastcmd
int lastcmd
Last command in the queue.
Definition: adata.h:72
ImapAccountData::nextcmd
int nextcmd
Next command to be sent.
Definition: adata.h:71
ImapAccountData::cmds
struct ImapCommand * cmds
Queue of commands for the server.
Definition: adata.h:69
ImapAccountData::status
unsigned char status
ImapFlags, e.g. IMAP_FATAL.
Definition: adata.h:45
ImapAccountData::cmdslots
int cmdslots
Size of the command queue.
Definition: adata.h:70
ImapAccountData::seqno
unsigned int seqno
tag sequence number, e.g. '{seqid}0001'
Definition: adata.h:57
ImapCommand
IMAP command structure.
Definition: private.h:160
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_read_literal()

int imap_read_literal ( FILE *  fp,
struct ImapAccountData *  adata,
unsigned long  bytes,
struct Progress *  progress 
)

Read bytes bytes from server into file.

Parameters
fpFile handle for email file
adataImap Account data
bytesNumber of bytes to read
progressProgress bar
Return values
0Success
-1Failure

Not explicitly buffered, relies on FILE buffering.

Note
Strips \r from \r\n. Apparently even literals use \r\n-terminated strings ?!

Definition at line 593 of file imap.c.

595{
596 char c;
597 bool r = false;
598 struct Buffer buf = { 0 }; // Do not allocate, maybe it won't be used
599
600 const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
601 if (c_debug_level >= IMAP_LOG_LTRL)
602 buf_alloc(&buf, bytes + 1);
603
604 mutt_debug(LL_DEBUG2, "reading %lu bytes\n", bytes);
605
606 for (unsigned long pos = 0; pos < bytes; pos++)
607 {
608 if (mutt_socket_readchar(adata->conn, &c) != 1)
609 {
610 mutt_debug(LL_DEBUG1, "error during read, %lu bytes read\n", pos);
611 adata->status = IMAP_FATAL;
612
613 buf_dealloc(&buf);
614 return -1;
615 }
616
617 if (r && (c != '\n'))
618 fputc('\r', fp);
619
620 if (c == '\r')
621 {
622 r = true;
623 continue;
624 }
625 else
626 {
627 r = false;
628 }
629
630 fputc(c, fp);
631
632 if ((pos % 1024) == 0)
633 progress_update(progress, pos, -1);
634 if (c_debug_level >= IMAP_LOG_LTRL)
635 buf_addch(&buf, c);
636 }
637
638 if (c_debug_level >= IMAP_LOG_LTRL)
639 {
640 mutt_debug(IMAP_LOG_LTRL, "\n%s", buf.data);
641 buf_dealloc(&buf);
642 }
643 return 0;
644}
buf_dealloc
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:377
buf_addch
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:241
buf_alloc
void buf_alloc(struct Buffer *buf, size_t new_size)
Make sure a buffer can store at least new_size bytes.
Definition: buffer.c:337
cs_subset_number
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:143
mutt_debug
#define mutt_debug(LEVEL,...)
Definition: logging2.h:90
IMAP_LOG_LTRL
#define IMAP_LOG_LTRL
Definition: private.h:49
LL_DEBUG2
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:45
LL_DEBUG1
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:44
progress_update
bool progress_update(struct Progress *progress, size_t pos, int percent)
Update the state of the progress bar.
Definition: progress.c:80
mutt_socket_readchar
int mutt_socket_readchar(struct Connection *conn, char *c)
Simple read buffering to speed things up.
Definition: socket.c:200
Buffer::data
char * data
Pointer to data.
Definition: buffer.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_expunge_mailbox()

void imap_expunge_mailbox ( struct Mailbox *  m,
bool  resort 
)

Purge messages from the server.

Parameters
mMailbox
resortTrigger a resort?

Purge IMAP portion of expunged messages from the context. Must not be done while something has a handle on any headers (eg inside pager or editor). That is, check IMAP_REOPEN_ALLOW.

Definition at line 672 of file imap.c.

673{
674 struct ImapAccountData *adata = imap_adata_get(m);
675 struct ImapMboxData *mdata = imap_mdata_get(m);
676 if (!adata || !mdata)
677 return;
678
679 struct Email *e = NULL;
680
681#ifdef USE_HCACHE
682 imap_hcache_open(adata, mdata, false);
683#endif
684
685 for (int i = 0; i < m->msg_count; i++)
686 {
687 e = m->emails[i];
688 if (!e)
689 break;
690
691 if (e->index == INT_MAX)
692 {
693 mutt_debug(LL_DEBUG2, "Expunging message UID %u\n", imap_edata_get(e)->uid);
694
695 e->deleted = true;
696
697 imap_cache_del(m, e);
698#ifdef USE_HCACHE
699 imap_hcache_del(mdata, imap_edata_get(e)->uid);
700#endif
701
702 mutt_hash_int_delete(mdata->uid_hash, imap_edata_get(e)->uid, e);
703
704 imap_edata_free((void **) &e->edata);
705 }
706 else
707 {
708 /* NeoMutt has several places where it turns off e->active as a
709 * hack. For example to avoid FLAG updates, or to exclude from
710 * imap_exec_msg_set.
711 *
712 * Unfortunately, when a reopen is allowed and the IMAP_EXPUNGE_PENDING
713 * flag becomes set (e.g. a flag update to a modified header),
714 * this function will be called by imap_cmd_finish().
715 *
716 * The ctx_update_tables() will free and remove these "inactive" headers,
717 * despite that an EXPUNGE was not received for them.
718 * This would result in memory leaks and segfaults due to dangling
719 * pointers in the msn_index and uid_hash.
720 *
721 * So this is another hack to work around the hacks. We don't want to
722 * remove the messages, so make sure active is on. */
723 e->active = true;
724 }
725 }
726
727#ifdef USE_HCACHE
728 imap_hcache_close(mdata);
729#endif
730
731 mailbox_changed(m, NT_MAILBOX_UPDATE);
732 if (resort)
733 {
734 mailbox_changed(m, NT_MAILBOX_RESORT);
735 }
736}
mailbox_changed
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition: mailbox.c:233
NT_MAILBOX_RESORT
@ NT_MAILBOX_RESORT
Email list needs resorting.
Definition: mailbox.h:190
NT_MAILBOX_UPDATE
@ NT_MAILBOX_UPDATE
Update internal tables.
Definition: mailbox.h:191
imap_edata_free
void imap_edata_free(void **ptr)
Free the private Email data - Implements Email::edata_free() -.
Definition: edata.c:40
mutt_hash_int_delete
void mutt_hash_int_delete(struct HashTable *table, unsigned int intkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:444
imap_adata_get
struct ImapAccountData * imap_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:123
imap_edata_get
struct ImapEmailData * imap_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:67
imap_mdata_get
struct ImapMboxData * imap_mdata_get(struct Mailbox *m)
Get the Mailbox data for this mailbox.
Definition: mdata.c:61
imap_cache_del
int imap_cache_del(struct Mailbox *m, struct Email *e)
Delete an email from the body cache.
Definition: message.c:1869
imap_hcache_open
void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata, bool create)
Open a header cache.
Definition: util.c:302
imap_hcache_close
void imap_hcache_close(struct ImapMboxData *mdata)
Close the header cache.
Definition: util.c:343
imap_hcache_del
int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid)
Delete an item from the header cache.
Definition: util.c:401
Account::adata
void * adata
Private data (for Mailbox backends)
Definition: account.h:42
Email
The envelope/body of an email.
Definition: email.h:39
Email::edata
void * edata
Driver-specific data.
Definition: email.h:74
Email::active
bool active
Message is not to be removed.
Definition: email.h:76
Email::deleted
bool deleted
Email is deleted.
Definition: email.h:78
Email::index
int index
The absolute (unsorted) message number.
Definition: email.h:110
ImapAccountData
IMAP-specific Account data -.
Definition: adata.h:40
ImapMboxData
IMAP-specific Mailbox data -.
Definition: mdata.h:40
ImapMboxData::uid_hash
struct HashTable * uid_hash
Hash Table: "uid" -> Email.
Definition: mdata.h:59
Mailbox::msg_count
int msg_count
Total number of messages.
Definition: mailbox.h:88
Mailbox::mdata
void * mdata
Driver specific data.
Definition: mailbox.h:132
Mailbox::emails
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_login()

int imap_login ( struct ImapAccountData *  adata)

Open an IMAP connection.

Parameters
adataImap Account data
Return values
0Success
-1Failure

Ensure ImapAccountData is connected and logged into the imap server.

Definition at line 1782 of file imap.c.

1783{
1784 if (!adata)
1785 return -1;
1786
1787 if (adata->state == IMAP_DISCONNECTED)
1788 {
1789 buf_reset(&adata->cmdbuf); // purge outstanding queued commands
1790 imap_open_connection(adata);
1791 }
1792 if (adata->state == IMAP_CONNECTED)
1793 {
1794 if (imap_authenticate(adata) == IMAP_AUTH_SUCCESS)
1795 {
1796 adata->state = IMAP_AUTHENTICATED;
1797 FREE(&adata->capstr);
1798 if (adata->conn->ssf != 0)
1799 {
1800 mutt_debug(LL_DEBUG2, "Communication encrypted at %d bits\n",
1801 adata->conn->ssf);
1802 }
1803 }
1804 else
1805 {
1806 mutt_account_unsetpass(&adata->conn->account);
1807 }
1808 }
1809 if (adata->state == IMAP_AUTHENTICATED)
1810 {
1811 /* capabilities may have changed */
1812 imap_exec(adata, "CAPABILITY", IMAP_CMD_PASS);
1813
1814#ifdef USE_ZLIB
1815 /* RFC4978 */
1816 const bool c_imap_deflate = cs_subset_bool(NeoMutt->sub, "imap_deflate");
1817 if ((adata->capabilities & IMAP_CAP_COMPRESS) && c_imap_deflate &&
1818 (imap_exec(adata, "COMPRESS DEFLATE", IMAP_CMD_PASS) == IMAP_EXEC_SUCCESS))
1819 {
1820 mutt_debug(LL_DEBUG2, "IMAP compression is enabled on connection to %s\n",
1821 adata->conn->account.host);
1822 mutt_zstrm_wrap_conn(adata->conn);
1823 }
1824#endif
1825
1826 /* enable RFC2971, if the server supports that */
1827 const bool c_imap_send_id = cs_subset_bool(NeoMutt->sub, "imap_send_id");
1828 if (c_imap_send_id && (adata->capabilities & IMAP_CAP_ID))
1829 {
1830 imap_exec(adata, "ID (\"name\" \"NeoMutt\" \"version\" \"" PACKAGE_VERSION "\")",
1831 IMAP_CMD_QUEUE);
1832 }
1833
1834 /* enable RFC6855, if the server supports that */
1835 const bool c_imap_rfc5161 = cs_subset_bool(NeoMutt->sub, "imap_rfc5161");
1836 if (c_imap_rfc5161 && (adata->capabilities & IMAP_CAP_ENABLE))
1837 imap_exec(adata, "ENABLE UTF8=ACCEPT", IMAP_CMD_QUEUE);
1838
1839 /* enable QRESYNC. Advertising QRESYNC also means CONDSTORE
1840 * is supported (even if not advertised), so flip that bit. */
1841 if (adata->capabilities & IMAP_CAP_QRESYNC)
1842 {
1843 adata->capabilities |= IMAP_CAP_CONDSTORE;
1844 const bool c_imap_qresync = cs_subset_bool(NeoMutt->sub, "imap_qresync");
1845 if (c_imap_rfc5161 && c_imap_qresync)
1846 imap_exec(adata, "ENABLE QRESYNC", IMAP_CMD_QUEUE);
1847 }
1848
1849 /* get root delimiter, '/' as default */
1850 adata->delim = '/';
1851 imap_exec(adata, "LIST \"\" \"\"", IMAP_CMD_QUEUE);
1852
1853 /* we may need the root delimiter before we open a mailbox */
1854 imap_exec(adata, NULL, IMAP_CMD_NO_FLAGS);
1855
1856 /* select the mailbox that used to be open before disconnect */
1857 if (adata->mailbox)
1858 {
1859 imap_mbox_select(adata->mailbox);
1860 }
1861 }
1862
1863 if (adata->state < IMAP_AUTHENTICATED)
1864 return -1;
1865
1866 return 0;
1867}
IMAP_AUTH_SUCCESS
@ IMAP_AUTH_SUCCESS
Authentication successful.
Definition: auth.h:40
buf_reset
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:76
mutt_account_unsetpass
void mutt_account_unsetpass(struct ConnAccount *cac)
Unset ConnAccount's password.
Definition: connaccount.c:178
imap_authenticate
int imap_authenticate(struct ImapAccountData *adata)
Authenticate to an IMAP server.
Definition: auth.c:115
IMAP_CAP_ENABLE
#define IMAP_CAP_ENABLE
RFC5161.
Definition: private.h:135
IMAP_CAP_ID
#define IMAP_CAP_ID
RFC2971: IMAP4 ID extension.
Definition: private.h:141
IMAP_CMD_PASS
#define IMAP_CMD_PASS
Command contains a password. Suppress logging.
Definition: private.h:72
IMAP_CAP_QRESYNC
#define IMAP_CAP_QRESYNC
RFC7162.
Definition: private.h:137
IMAP_CAP_COMPRESS
#define IMAP_CAP_COMPRESS
RFC4978: COMPRESS=DEFLATE.
Definition: private.h:139
IMAP_CAP_CONDSTORE
#define IMAP_CAP_CONDSTORE
RFC7162.
Definition: private.h:136
IMAP_CMD_QUEUE
#define IMAP_CMD_QUEUE
Queue a command, do not execute.
Definition: private.h:73
imap_open_connection
int imap_open_connection(struct ImapAccountData *adata)
Open an IMAP connection.
Definition: imap.c:744
imap_mbox_select
static void imap_mbox_select(struct Mailbox *m)
Select a Mailbox.
Definition: imap.c:1749
ConnAccount::host
char host[128]
Server to login to.
Definition: connaccount.h:54
Connection::account
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:49
ImapAccountData::delim
char delim
Path delimiter.
Definition: adata.h:75
ImapAccountData::mailbox
struct Mailbox * mailbox
Current selected mailbox.
Definition: adata.h:76
ImapAccountData::cmdbuf
struct Buffer cmdbuf
Definition: adata.h:73
mutt_zstrm_wrap_conn
void mutt_zstrm_wrap_conn(struct Connection *conn)
Wrap a compression layer around a Connection.
Definition: zstrm.c:291
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_sync_message_for_copy()

int imap_sync_message_for_copy ( struct Mailbox *  m,
struct Email *  e,
struct Buffer *  cmd,
enum QuadOption *  err_continue 
)

Update server to reflect the flags of a single message.

Parameters
[in]mMailbox
[in]eEmail
[in]cmdBuffer for the command string
[out]err_continueDid the user force a continue?
Return values
0Success
-1Failure

Update the IMAP server to reflect the flags for a single message before performing a "UID COPY".

Note
This does not sync the "deleted" flag state, because it is not desirable to propagate that flag into the copy.

Definition at line 929 of file imap.c.

931{
932 struct ImapAccountData *adata = imap_adata_get(m);
933 struct ImapEmailData *edata = imap_edata_get(e);
934
935 if (!adata || (adata->mailbox != m) || !e)
936 return -1;
937
938 if (!compare_flags_for_copy(e))
939 {
940 if (e->deleted == edata->deleted)
941 e->changed = false;
942 return 0;
943 }
944
945 buf_printf(cmd, "UID STORE %u", edata->uid);
946
947 struct Buffer *flags = buf_pool_get();
948
949 set_flag(m, MUTT_ACL_SEEN, e->read, "\\Seen ", flags);
950 set_flag(m, MUTT_ACL_WRITE, e->old, "Old ", flags);
951 set_flag(m, MUTT_ACL_WRITE, e->flagged, "\\Flagged ", flags);
952 set_flag(m, MUTT_ACL_WRITE, e->replied, "\\Answered ", flags);
953 set_flag(m, MUTT_ACL_DELETE, edata->deleted, "\\Deleted ", flags);
954
955 if (m->rights & MUTT_ACL_WRITE)
956 {
957 /* restore system flags */
958 if (edata->flags_system)
959 buf_addstr(flags, edata->flags_system);
960
961 /* set custom flags */
962 struct Buffer *tags = buf_pool_get();
963 driver_tags_get_with_hidden(&e->tags, tags);
964 if (!buf_is_empty(tags))
965 buf_addstr(flags, buf_string(tags));
966 buf_pool_release(&tags);
967 }
968
969 mutt_str_remove_trailing_ws(flags->data);
970 buf_fix_dptr(flags);
971
972 /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
973 * explicitly revoke all system flags (if we have permission) */
974 if (buf_is_empty(flags))
975 {
976 set_flag(m, MUTT_ACL_SEEN, true, "\\Seen ", flags);
977 set_flag(m, MUTT_ACL_WRITE, true, "Old ", flags);
978 set_flag(m, MUTT_ACL_WRITE, true, "\\Flagged ", flags);
979 set_flag(m, MUTT_ACL_WRITE, true, "\\Answered ", flags);
980 set_flag(m, MUTT_ACL_DELETE, !edata->deleted, "\\Deleted ", flags);
981
982 /* erase custom flags */
983 if ((m->rights & MUTT_ACL_WRITE) && edata->flags_remote)
984 buf_addstr(flags, edata->flags_remote);
985
986 mutt_str_remove_trailing_ws(flags->data);
987 buf_fix_dptr(flags);
988
989 buf_addstr(cmd, " -FLAGS.SILENT (");
990 }
991 else
992 {
993 buf_addstr(cmd, " FLAGS.SILENT (");
994 }
995
996 buf_addstr(cmd, buf_string(flags));
997 buf_addstr(cmd, ")");
998
999 int rc = -1;
1000
1001 /* after all this it's still possible to have no flags, if you
1002 * have no ACL rights */
1003 if (!buf_is_empty(flags) &&
1004 (imap_exec(adata, cmd->data, IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS) &&
1005 err_continue && (*err_continue != MUTT_YES))
1006 {
1007 *err_continue = imap_continue("imap_sync_message: STORE failed", adata->buf);
1008 if (*err_continue != MUTT_YES)
1009 goto done;
1010 }
1011
1012 /* server have now the updated flags */
1013 FREE(&edata->flags_remote);
1014 struct Buffer *flags_remote = buf_pool_get();
1015 driver_tags_get_with_hidden(&e->tags, flags_remote);
1016 edata->flags_remote = buf_strdup(flags_remote);
1017 buf_pool_release(&flags_remote);
1018
1019 if (e->deleted == edata->deleted)
1020 e->changed = false;
1021
1022 rc = 0;
1023
1024done:
1025 buf_pool_release(&flags);
1026 return rc;
1027}
buf_is_empty
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:291
buf_fix_dptr
void buf_fix_dptr(struct Buffer *buf)
Move the dptr to end of the Buffer.
Definition: buffer.c:182
buf_addstr
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:226
buf_strdup
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition: buffer.c:571
MUTT_ACL_DELETE
#define MUTT_ACL_DELETE
Delete a message.
Definition: mailbox.h:63
MUTT_ACL_WRITE
#define MUTT_ACL_WRITE
Write to a message (for flagging or linking threads)
Definition: mailbox.h:71
MUTT_ACL_SEEN
#define MUTT_ACL_SEEN
Change the 'seen' status of a message.
Definition: mailbox.h:70
imap_continue
enum QuadOption imap_continue(const char *msg, const char *resp)
Display a message and ask the user if they want to go on.
Definition: util.c:649
set_flag
static void set_flag(struct Mailbox *m, AclFlags aclflag, bool flag, const char *str, struct Buffer *flags)
Append str to flags if we currently have permission according to aclflag.
Definition: imap.c:187
compare_flags_for_copy
static bool compare_flags_for_copy(struct Email *e)
Compare local flags against the server.
Definition: imap.c:203
mutt_str_remove_trailing_ws
void mutt_str_remove_trailing_ws(char *s)
Trim trailing whitespace from a string.
Definition: string.c:566
Email::read
bool read
Email is read.
Definition: email.h:50
Email::old
bool old
Email is seen, but unread.
Definition: email.h:49
Email::changed
bool changed
Email has been edited.
Definition: email.h:77
Email::flagged
bool flagged
Marked important?
Definition: email.h:47
Email::replied
bool replied
Email has been replied to.
Definition: email.h:51
Email::tags
struct TagList tags
For drivers that support server tagging.
Definition: email.h:72
ImapEmailData
IMAP-specific Email data -.
Definition: edata.h:35
ImapEmailData::flags_remote
char * flags_remote
Definition: edata.h:49
ImapEmailData::deleted
bool deleted
Email has been deleted.
Definition: edata.h:39
ImapEmailData::flags_system
char * flags_system
Definition: edata.h:48
Mailbox::rights
AclFlags rights
ACL bits, see AclFlags.
Definition: mailbox.h:119
driver_tags_get_with_hidden
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:
+ Here is the caller graph for this function:

◆ imap_has_flag()

bool imap_has_flag ( struct ListHead *  flag_list,
const char *  flag 
)

Does the flag exist in the list.

Parameters
flag_listList of server flags
flagFlag to find
Return values
trueFlag exists

Do a caseless comparison of the flag against a flag list, return true if found or flag list has '*'. Note that "flag" might contain additional whitespace at the end, so we really need to compare up to the length of each element in "flag_list".

Definition at line 877 of file imap.c.

878{
879 if (STAILQ_EMPTY(flag_list))
880 return false;
881
882 const size_t flaglen = mutt_str_len(flag);
883 struct ListNode *np = NULL;
884 STAILQ_FOREACH(np, flag_list, entries)
885 {
886 const size_t nplen = strlen(np->data);
887 if ((flaglen >= nplen) && ((flag[nplen] == '\0') || (flag[nplen] == ' ')) &&
888 mutt_istrn_equal(np->data, flag, nplen))
889 {
890 return true;
891 }
892
893 if (mutt_str_equal(np->data, "\\*"))
894 return true;
895 }
896
897 return false;
898}
mutt_str_equal
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:661
mutt_str_len
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:497
mutt_istrn_equal
bool mutt_istrn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings ignoring case (to a maximum), safely.
Definition: string.c:454
STAILQ_FOREACH
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:390
STAILQ_EMPTY
#define STAILQ_EMPTY(head)
Definition: queue.h:382
ListNode
A List node for strings.
Definition: list.h:37
ListNode::data
char * data
String.
Definition: list.h:38
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_adata_find()

int imap_adata_find ( const char *  path,
struct ImapAccountData **  adata,
struct ImapMboxData **  mdata 
)

Find the Account data for this path.

Parameters
pathPath to search for
adataImap Account data
mdataImap Mailbox data
Return values
0Success
-1Failure

Definition at line 72 of file util.c.

74{
75 struct ConnAccount cac = { { 0 } };
76 struct ImapAccountData *tmp_adata = NULL;
77 char tmp[1024] = { 0 };
78
79 if (imap_parse_path(path, &cac, tmp, sizeof(tmp)) < 0)
80 return -1;
81
82 struct Account *np = NULL;
83 TAILQ_FOREACH(np, &NeoMutt->accounts, entries)
84 {
85 if (np->type != MUTT_IMAP)
86 continue;
87
88 tmp_adata = np->adata;
89 if (!tmp_adata)
90 continue;
91 if (imap_account_match(&tmp_adata->conn->account, &cac))
92 {
93 if (mdata)
94 {
95 *mdata = imap_mdata_new(tmp_adata, tmp);
96 }
97 *adata = tmp_adata;
98 return 0;
99 }
100 }
101 mutt_debug(LL_DEBUG3, "no ImapAccountData found\n");
102 return -1;
103}
MUTT_IMAP
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
imap_mdata_new
struct ImapMboxData * imap_mdata_new(struct ImapAccountData *adata, const char *name)
Allocate and initialise a new ImapMboxData structure.
Definition: mdata.c:74
LL_DEBUG3
@ LL_DEBUG3
Log at debug level 3.
Definition: logging2.h:46
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:782
Account
A group of associated Mailboxes.
Definition: account.h:36
Account::type
enum MailboxType type
Type of Mailboxes this Account contains.
Definition: account.h:37
ConnAccount
Login details for a remote server.
Definition: connaccount.h:53
NeoMutt::accounts
struct AccountList accounts
List of all Accounts.
Definition: neomutt.h:48
imap_parse_path
int imap_parse_path(const char *path, struct ConnAccount *cac, char *mailbox, size_t mailboxlen)
Parse an IMAP mailbox name into ConnAccount, name.
Definition: util.c:477
imap_account_match
bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2)
Compare two Accounts.
Definition: util.c:1093
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_authenticate()

int imap_authenticate ( struct ImapAccountData *  adata)

Authenticate to an IMAP server.

Parameters
adataImap Account data
Return values
enumImapAuthRes, e.g. IMAP_AUTH_SUCCESS

Attempt to authenticate using either user-specified authentication method if specified, or any.

Definition at line 115 of file auth.c.

116{
117 int rc = IMAP_AUTH_FAILURE;
118
119 const struct Slist *c_imap_authenticators = cs_subset_slist(NeoMutt->sub, "imap_authenticators");
120 if (c_imap_authenticators && (c_imap_authenticators->count > 0))
121 {
122 mutt_debug(LL_DEBUG2, "Trying user-defined imap_authenticators\n");
123
124 /* Try user-specified list of authentication methods */
125 struct ListNode *np = NULL;
126 STAILQ_FOREACH(np, &c_imap_authenticators->head, entries)
127 {
128 mutt_debug(LL_DEBUG2, "Trying method %s\n", np->data);
129
130 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
131 {
132 const struct ImapAuth *auth = &ImapAuthenticators[i];
133 if (!auth->method || mutt_istr_equal(auth->method, np->data))
134 {
135 rc = auth->authenticate(adata, np->data);
136 if (rc == IMAP_AUTH_SUCCESS)
137 {
138 return rc;
139 }
140 }
141 }
142 }
143 }
144 else
145 {
146 /* Fall back to default: any authenticator */
147 mutt_debug(LL_DEBUG2, "Trying pre-defined imap_authenticators\n");
148
149 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
150 {
151 rc = ImapAuthenticators[i].authenticate(adata, NULL);
152 if (rc == IMAP_AUTH_SUCCESS)
153 return rc;
154 }
155 }
156
157 mutt_error(_("No authenticators available or wrong credentials"));
158 return rc;
159}
IMAP_AUTH_FAILURE
@ IMAP_AUTH_FAILURE
Authentication failed.
Definition: auth.h:41
cs_subset_slist
const struct Slist * cs_subset_slist(const struct ConfigSubset *sub, const char *name)
Get a string-list config item by name.
Definition: helpers.c:242
ImapAuthenticators
static const struct ImapAuth ImapAuthenticators[]
Accepted authentication methods.
Definition: auth.c:64
mutt_array_size
#define mutt_array_size(x)
Definition: memory.h:38
mutt_istr_equal
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:673
ImapAuth
IMAP authentication multiplexor.
Definition: auth.c:46
ImapAuth::authenticate
enum ImapAuthRes(* authenticate)(struct ImapAccountData *adata, const char *method)
Definition: auth.c:55
ImapAuth::method
const char * method
Name of authentication method supported, NULL means variable.
Definition: auth.c:57
Slist
String list.
Definition: slist.h:37
Slist::head
struct ListHead head
List containing values.
Definition: slist.h:38
Slist::count
size_t count
Number of values in list.
Definition: slist.h:39
+ Here is the caller graph for this function:

◆ imap_cmd_start()

int imap_cmd_start ( struct ImapAccountData *  adata,
const char *  cmdstr 
)

Given an IMAP command, send it to the server.

Parameters
adataImap Account data
cmdstrCommand string to send
Return values
0Success
<0Failure, e.g. IMAP_RES_BAD

If cmdstr is NULL, sends queued commands.

Definition at line 1114 of file command.c.

1115{
1116 return cmd_start(adata, cmdstr, IMAP_CMD_NO_FLAGS);
1117}
cmd_start
static int cmd_start(struct ImapAccountData *adata, const char *cmdstr, ImapCmdFlags flags)
Start a new IMAP command.
Definition: command.c:203
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_cmd_step()

int imap_cmd_step ( struct ImapAccountData *  adata)

Reads server responses from an IMAP command.

Parameters
adataImap Account data
Return values
0Success
<0Failure, e.g. IMAP_RES_BAD

detects tagged completion response, handles untagged messages, can read arbitrarily large strings (using malloc, so don't make it too large!).

Definition at line 1128 of file command.c.

1129{
1130 if (!adata)
1131 return -1;
1132
1133 size_t len = 0;
1134 int c;
1135 int rc;
1136 int stillrunning = 0;
1137 struct ImapCommand *cmd = NULL;
1138
1139 if (adata->status == IMAP_FATAL)
1140 {
1141 cmd_handle_fatal(adata);
1142 return IMAP_RES_BAD;
1143 }
1144
1145 /* read into buffer, expanding buffer as necessary until we have a full
1146 * line */
1147 do
1148 {
1149 if (len == adata->blen)
1150 {
1151 MUTT_MEM_REALLOC(&adata->buf, adata->blen + IMAP_CMD_BUFSIZE, char);
1152 adata->blen = adata->blen + IMAP_CMD_BUFSIZE;
1153 mutt_debug(LL_DEBUG3, "grew buffer to %zu bytes\n", adata->blen);
1154 }
1155
1156 /* back up over '\0' */
1157 if (len)
1158 len--;
1159 c = mutt_socket_readln_d(adata->buf + len, adata->blen - len, adata->conn, MUTT_SOCK_LOG_FULL);
1160 if (c <= 0)
1161 {
1162 mutt_debug(LL_DEBUG1, "Error reading server response\n");
1163 cmd_handle_fatal(adata);
1164 return IMAP_RES_BAD;
1165 }
1166
1167 len += c;
1168 }
1169 /* if we've read all the way to the end of the buffer, we haven't read a
1170 * full line (mutt_socket_readln strips the \r, so we always have at least
1171 * one character free when we've read a full line) */
1172 while (len == adata->blen);
1173
1174 /* don't let one large string make cmd->buf hog memory forever */
1175 if ((adata->blen > IMAP_CMD_BUFSIZE) && (len <= IMAP_CMD_BUFSIZE))
1176 {
1177 MUTT_MEM_REALLOC(&adata->buf, IMAP_CMD_BUFSIZE, char);
1178 adata->blen = IMAP_CMD_BUFSIZE;
1179 mutt_debug(LL_DEBUG3, "shrank buffer to %zu bytes\n", adata->blen);
1180 }
1181
1182 adata->lastread = mutt_date_now();
1183
1184 /* handle untagged messages. The caller still gets its shot afterwards. */
1185 if ((mutt_str_startswith(adata->buf, "* ") ||
1186 mutt_str_startswith(imap_next_word(adata->buf), "OK [")) &&
1187 cmd_handle_untagged(adata))
1188 {
1189 return IMAP_RES_BAD;
1190 }
1191
1192 /* server demands a continuation response from us */
1193 if (adata->buf[0] == '+')
1194 return IMAP_RES_RESPOND;
1195
1196 /* Look for tagged command completions.
1197 *
1198 * Some response handlers can end up recursively calling
1199 * imap_cmd_step() and end up handling all tagged command
1200 * completions.
1201 * (e.g. FETCH->set_flag->set_header_color->~h pattern match.)
1202 *
1203 * Other callers don't even create an adata->cmds entry.
1204 *
1205 * For both these cases, we default to returning OK */
1206 rc = IMAP_RES_OK;
1207 c = adata->lastcmd;
1208 do
1209 {
1210 cmd = &adata->cmds[c];
1211 if (cmd->state == IMAP_RES_NEW)
1212 {
1213 if (mutt_str_startswith(adata->buf, cmd->seq))
1214 {
1215 if (!stillrunning)
1216 {
1217 /* first command in queue has finished - move queue pointer up */
1218 adata->lastcmd = (adata->lastcmd + 1) % adata->cmdslots;
1219 }
1220 cmd->state = cmd_status(adata->buf);
1221 rc = cmd->state;
1222 if (cmd->state == IMAP_RES_NO || cmd->state == IMAP_RES_BAD)
1223 {
1224 mutt_message(_("IMAP command failed: %s"), adata->buf);
1225 }
1226 }
1227 else
1228 {
1229 stillrunning++;
1230 }
1231 }
1232
1233 c = (c + 1) % adata->cmdslots;
1234 } while (c != adata->nextcmd);
1235
1236 if (stillrunning)
1237 {
1238 rc = IMAP_RES_CONTINUE;
1239 }
1240 else
1241 {
1242 mutt_debug(LL_DEBUG3, "IMAP queue drained\n");
1243 imap_cmd_finish(adata);
1244 }
1245
1246 return rc;
1247}
mutt_message
#define mutt_message(...)
Definition: logging2.h:92
cmd_handle_untagged
static int cmd_handle_untagged(struct ImapAccountData *adata)
Fallback parser for otherwise unhandled messages.
Definition: command.c:1018
cmd_status
static int cmd_status(const char *s)
Parse response line for tagged OK/NO/BAD.
Definition: command.c:239
cmd_handle_fatal
static void cmd_handle_fatal(struct ImapAccountData *adata)
When ImapAccountData is in fatal state, do what we can.
Definition: command.c:169
IMAP_CMD_BUFSIZE
#define IMAP_CMD_BUFSIZE
Definition: command.c:60
imap_cmd_finish
void imap_cmd_finish(struct ImapAccountData *adata)
Attempt to perform cleanup.
Definition: command.c:1368
IMAP_RES_RESPOND
#define IMAP_RES_RESPOND
+
Definition: private.h:57
IMAP_RES_NEW
#define IMAP_RES_NEW
ImapCommand.state additions.
Definition: private.h:58
IMAP_RES_NO
#define IMAP_RES_NO
<tag> NO ...
Definition: private.h:53
IMAP_RES_CONTINUE
#define IMAP_RES_CONTINUE
* ...
Definition: private.h:56
imap_next_word
char * imap_next_word(char *s)
Find where the next IMAP word begins.
Definition: util.c:824
IMAP_RES_BAD
#define IMAP_RES_BAD
<tag> BAD ...
Definition: private.h:54
MUTT_MEM_REALLOC
#define MUTT_MEM_REALLOC(pptr, n, type)
Definition: memory.h:43
mutt_date_now
time_t mutt_date_now(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:456
mutt_str_startswith
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:231
mutt_socket_readln_d
int mutt_socket_readln_d(char *buf, size_t buflen, struct Connection *conn, int dbg)
Read a line from a socket.
Definition: socket.c:238
MUTT_SOCK_LOG_FULL
#define MUTT_SOCK_LOG_FULL
Definition: socket.h:54
ImapAccountData::lastread
time_t lastread
last time we read a command for the server
Definition: adata.h:58
ImapAccountData::blen
size_t blen
Definition: adata.h:60
ImapCommand::state
int state
Command state, e.g. IMAP_RES_NEW.
Definition: private.h:162
ImapCommand::seq
char seq[SEQ_LEN+1]
Command tag, e.g. 'a0001'.
Definition: private.h:161
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_cmd_finish()

void imap_cmd_finish ( struct ImapAccountData *  adata)

Attempt to perform cleanup.

Parameters
adataImap Account data

If a reopen is allowed, it attempts to perform cleanup (eg fetch new mail if detected, do expunge). Called automatically by imap_cmd_step(), but may be called at any time.

mdata->check_status is set and will be used later by imap_check_mailbox().

Definition at line 1368 of file command.c.

1369{
1370 if (!adata)
1371 return;
1372
1373 if (adata->status == IMAP_FATAL)
1374 {
1375 adata->closing = false;
1376 cmd_handle_fatal(adata);
1377 return;
1378 }
1379
1380 if (!(adata->state >= IMAP_SELECTED) || (adata->mailbox && adata->closing))
1381 {
1382 adata->closing = false;
1383 return;
1384 }
1385
1386 adata->closing = false;
1387
1388 struct ImapMboxData *mdata = imap_mdata_get(adata->mailbox);
1389
1390 if (mdata && mdata->reopen & IMAP_REOPEN_ALLOW)
1391 {
1392 // First remove expunged emails from the msn_index
1393 if (mdata->reopen & IMAP_EXPUNGE_PENDING)
1394 {
1395 mutt_debug(LL_DEBUG2, "Expunging mailbox\n");
1396 imap_expunge_mailbox(adata->mailbox, true);
1397 /* Detect whether we've gotten unexpected EXPUNGE messages */
1398 if (!(mdata->reopen & IMAP_EXPUNGE_EXPECTED))
1399 mdata->check_status |= IMAP_EXPUNGE_PENDING;
1400 mdata->reopen &= ~(IMAP_EXPUNGE_PENDING | IMAP_EXPUNGE_EXPECTED);
1401 }
1402
1403 // Then add new emails to it
1404 if (mdata->reopen & IMAP_NEWMAIL_PENDING)
1405 {
1406 const size_t max_msn = imap_msn_highest(&mdata->msn);
1407 if (mdata->new_mail_count > max_msn)
1408 {
1409 if (!(mdata->reopen & IMAP_EXPUNGE_PENDING))
1410 mdata->check_status |= IMAP_NEWMAIL_PENDING;
1411
1412 mutt_debug(LL_DEBUG2, "Fetching new mails from %zd to %u\n",
1413 max_msn + 1, mdata->new_mail_count);
1414 imap_read_headers(adata->mailbox, max_msn + 1, mdata->new_mail_count, false);
1415 }
1416 }
1417
1418 // And to finish inform about MUTT_REOPEN if needed
1419 if (mdata->reopen & IMAP_EXPUNGE_PENDING && !(mdata->reopen & IMAP_EXPUNGE_EXPECTED))
1420 mdata->check_status |= IMAP_EXPUNGE_PENDING;
1421
1422 if (mdata->reopen & IMAP_EXPUNGE_PENDING)
1423 mdata->reopen &= ~(IMAP_EXPUNGE_PENDING | IMAP_EXPUNGE_EXPECTED);
1424 }
1425
1426 adata->status = 0;
1427}
imap_read_headers
int imap_read_headers(struct Mailbox *m, unsigned int msn_begin, unsigned int msn_end, bool initial_download)
Read headers from the server.
Definition: message.c:1340
IMAP_EXPUNGE_PENDING
#define IMAP_EXPUNGE_PENDING
Messages on the server have been expunged.
Definition: private.h:66
IMAP_EXPUNGE_EXPECTED
#define IMAP_EXPUNGE_EXPECTED
Messages will be expunged from the server.
Definition: private.h:65
IMAP_REOPEN_ALLOW
#define IMAP_REOPEN_ALLOW
Allow re-opening a folder upon expunge.
Definition: private.h:64
IMAP_NEWMAIL_PENDING
#define IMAP_NEWMAIL_PENDING
New mail is waiting on the server.
Definition: private.h:67
imap_expunge_mailbox
void imap_expunge_mailbox(struct Mailbox *m, bool resort)
Purge messages from the server.
Definition: imap.c:672
imap_msn_highest
size_t imap_msn_highest(const struct MSNArray *msn)
Return the highest MSN in use.
Definition: msn.c:72
ImapAccountData::closing
bool closing
If true, we are waiting for CLOSE completion.
Definition: adata.h:43
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_code()

bool imap_code ( const char *  s)

Was the command successful.

Parameters
sIMAP command status
Return values
1Command result was OK
0NO or BAD

Definition at line 1255 of file command.c.

1256{
1257 return cmd_status(s) == IMAP_RES_OK;
1258}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_cmd_trailer()

const char * imap_cmd_trailer ( struct ImapAccountData *  adata)

Extra information after tagged command response if any.

Parameters
adataImap Account data
Return values
ptrExtra command information (pointer into adata->buf)
""Error (static string)

Definition at line 1266 of file command.c.

1267{
1268 static const char *notrailer = "";
1269 const char *s = adata->buf;
1270
1271 if (!s)
1272 {
1273 mutt_debug(LL_DEBUG2, "not a tagged response\n");
1274 return notrailer;
1275 }
1276
1277 s = imap_next_word((char *) s);
1278 if (!s || (!mutt_istr_startswith(s, "OK") && !mutt_istr_startswith(s, "NO") &&
1279 !mutt_istr_startswith(s, "BAD")))
1280 {
1281 mutt_debug(LL_DEBUG2, "not a command completion: %s\n", adata->buf);
1282 return notrailer;
1283 }
1284
1285 s = imap_next_word((char *) s);
1286 if (!s)
1287 return notrailer;
1288
1289 return s;
1290}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_exec()

int imap_exec ( struct ImapAccountData *  adata,
const char *  cmdstr,
ImapCmdFlags  flags 
)

Execute a command and wait for the response from the server.

Parameters
adataImap Account data
cmdstrCommand to execute
flagsFlags, see ImapCmdFlags
Return values
IMAP_EXEC_SUCCESSCommand successful or queued
IMAP_EXEC_ERRORCommand returned an error
IMAP_EXEC_FATALImap connection failure

Also, handle untagged responses.

Definition at line 1303 of file command.c.

1304{
1305 int rc;
1306
1307 if (flags & IMAP_CMD_SINGLE)
1308 {
1309 // Process any existing commands
1310 if (adata->nextcmd != adata->lastcmd)
1311 imap_exec(adata, NULL, IMAP_CMD_POLL);
1312 }
1313
1314 rc = cmd_start(adata, cmdstr, flags);
1315 if (rc < 0)
1316 {
1317 cmd_handle_fatal(adata);
1318 return IMAP_EXEC_FATAL;
1319 }
1320
1321 if (flags & IMAP_CMD_QUEUE)
1322 return IMAP_EXEC_SUCCESS;
1323
1324 const short c_imap_poll_timeout = cs_subset_number(NeoMutt->sub, "imap_poll_timeout");
1325 if ((flags & IMAP_CMD_POLL) && (c_imap_poll_timeout > 0) &&
1326 ((mutt_socket_poll(adata->conn, c_imap_poll_timeout)) == 0))
1327 {
1328 mutt_error(_("Connection to %s timed out"), adata->conn->account.host);
1329 cmd_handle_fatal(adata);
1330 return IMAP_EXEC_FATAL;
1331 }
1332
1333 /* Allow interruptions, particularly useful if there are network problems. */
1334 mutt_sig_allow_interrupt(true);
1335 do
1336 {
1337 rc = imap_cmd_step(adata);
1338 // The queue is empty, so the single command has been processed
1339 if ((flags & IMAP_CMD_SINGLE) && (adata->nextcmd == adata->lastcmd))
1340 break;
1341 } while (rc == IMAP_RES_CONTINUE);
1342 mutt_sig_allow_interrupt(false);
1343
1344 if (rc == IMAP_RES_NO)
1345 return IMAP_EXEC_ERROR;
1346 if (rc != IMAP_RES_OK)
1347 {
1348 if (adata->status != IMAP_FATAL)
1349 return IMAP_EXEC_ERROR;
1350
1351 mutt_debug(LL_DEBUG1, "command failed: %s\n", adata->buf);
1352 return IMAP_EXEC_FATAL;
1353 }
1354
1355 return IMAP_EXEC_SUCCESS;
1356}
IMAP_CMD_POLL
#define IMAP_CMD_POLL
Poll the tcp connection before running the imap command.
Definition: private.h:74
mutt_sig_allow_interrupt
void mutt_sig_allow_interrupt(bool allow)
Allow/disallow Ctrl-C (SIGINT)
Definition: signal.c:316
mutt_socket_poll
int mutt_socket_poll(struct Connection *conn, time_t wait_secs)
Checks whether reads would block.
Definition: socket.c:182
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_cmd_idle()

int imap_cmd_idle ( struct ImapAccountData *  adata)

Enter the IDLE state.

Parameters
adataImap Account data
Return values
0Success
<0Failure, e.g. IMAP_RES_BAD

Definition at line 1435 of file command.c.

1436{
1437 int rc;
1438
1439 if (cmd_start(adata, "IDLE", IMAP_CMD_POLL) < 0)
1440 {
1441 cmd_handle_fatal(adata);
1442 return -1;
1443 }
1444
1445 const short c_imap_poll_timeout = cs_subset_number(NeoMutt->sub, "imap_poll_timeout");
1446 if ((c_imap_poll_timeout > 0) &&
1447 ((mutt_socket_poll(adata->conn, c_imap_poll_timeout)) == 0))
1448 {
1449 mutt_error(_("Connection to %s timed out"), adata->conn->account.host);
1450 cmd_handle_fatal(adata);
1451 return -1;
1452 }
1453
1454 do
1455 {
1456 rc = imap_cmd_step(adata);
1457 } while (rc == IMAP_RES_CONTINUE);
1458
1459 if (rc == IMAP_RES_RESPOND)
1460 {
1461 /* successfully entered IDLE state */
1462 adata->state = IMAP_IDLE;
1463 /* queue automatic exit when next command is issued */
1464 buf_addstr(&adata->cmdbuf, "DONE\r\n");
1465 rc = IMAP_RES_OK;
1466 }
1467 if (rc != IMAP_RES_OK)
1468 {
1469 mutt_debug(LL_DEBUG1, "error starting IDLE\n");
1470 return -1;
1471 }
1472
1473 return 0;
1474}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_read_headers()

int imap_read_headers ( struct Mailbox *  m,
unsigned int  msn_begin,
unsigned int  msn_end,
bool  initial_download 
)

Read headers from the server.

Parameters
mImap Selected Mailbox
msn_beginFirst Message Sequence Number
msn_endLast Message Sequence Number
initial_downloadtrue, if this is the first opening of the mailbox
Return values
numLast MSN
-1Failure

Changed to read many headers instead of just one. It will return the msn of the last message read. It will return a value other than msn_end if mail comes in while downloading headers (in theory).

Definition at line 1340 of file message.c.

1342{
1343 unsigned int maxuid = 0;
1344 int rc = -1;
1345 bool evalhc = false;
1346
1347#ifdef USE_HCACHE
1348 uint32_t uidvalidity = 0;
1349 unsigned int uid_next = 0;
1350 unsigned long long modseq = 0;
1351 bool has_condstore = false;
1352 bool has_qresync = false;
1353 bool eval_condstore = false;
1354 bool eval_qresync = false;
1355 char *uid_seqset = NULL;
1356 const unsigned int msn_begin_save = msn_begin;
1357#endif /* USE_HCACHE */
1358
1359 struct ImapAccountData *adata = imap_adata_get(m);
1360 struct ImapMboxData *mdata = imap_mdata_get(m);
1361 if (!adata || (adata->mailbox != m))
1362 return -1;
1363
1364#ifdef USE_HCACHE
1365retry:
1366#endif /* USE_HCACHE */
1367
1368 /* make sure context has room to hold the mailbox */
1369 mx_alloc_memory(m, msn_end);
1370 imap_msn_reserve(&mdata->msn, msn_end);
1371 imap_alloc_uid_hash(adata, msn_end);
1372
1373 mdata->reopen &= ~(IMAP_REOPEN_ALLOW | IMAP_NEWMAIL_PENDING);
1374 mdata->new_mail_count = 0;
1375
1376#ifdef USE_HCACHE
1377 imap_hcache_open(adata, mdata, true);
1378
1379 if (mdata->hcache && initial_download)
1380 {
1381 hcache_fetch_raw_obj(mdata->hcache, "UIDVALIDITY", 11, &uidvalidity);
1382 hcache_fetch_raw_obj(mdata->hcache, "UIDNEXT", 7, &uid_next);
1383 if (mdata->modseq)
1384 {
1385 const bool c_imap_condstore = cs_subset_bool(NeoMutt->sub, "imap_condstore");
1386 if ((adata->capabilities & IMAP_CAP_CONDSTORE) && c_imap_condstore)
1387 has_condstore = true;
1388
1389 /* If IMAP_CAP_QRESYNC and ImapQResync then NeoMutt sends ENABLE QRESYNC.
1390 * If we receive an ENABLED response back, then adata->qresync is set. */
1391 if (adata->qresync)
1392 has_qresync = true;
1393 }
1394
1395 if (uidvalidity && uid_next && (uidvalidity == mdata->uidvalidity))
1396 {
1397 evalhc = true;
1398 if (hcache_fetch_raw_obj(mdata->hcache, "MODSEQ", 6, &modseq))
1399 {
1400 if (has_qresync)
1401 {
1402 uid_seqset = imap_hcache_get_uid_seqset(mdata);
1403 if (uid_seqset)
1404 eval_qresync = true;
1405 }
1406
1407 if (!eval_qresync && has_condstore)
1408 eval_condstore = true;
1409 }
1410 }
1411 }
1412 if (evalhc)
1413 {
1414 if (eval_qresync)
1415 {
1416 if (read_headers_qresync_eval_cache(adata, uid_seqset) < 0)
1417 goto bail;
1418 }
1419 else
1420 {
1421 if (read_headers_normal_eval_cache(adata, msn_end, uid_next, has_condstore || has_qresync,
1422 eval_condstore) < 0)
1423 goto bail;
1424 }
1425
1426 if ((eval_condstore || eval_qresync) && (modseq != mdata->modseq))
1427 {
1428 if (read_headers_condstore_qresync_updates(adata, msn_end, uid_next,
1429 modseq, eval_qresync) < 0)
1430 {
1431 goto bail;
1432 }
1433 }
1434
1435 /* Look for the first empty MSN and start there */
1436 while (msn_begin <= msn_end)
1437 {
1438 if (!imap_msn_get(&mdata->msn, msn_begin - 1))
1439 break;
1440 msn_begin++;
1441 }
1442 }
1443#endif /* USE_HCACHE */
1444
1445 if (read_headers_fetch_new(m, msn_begin, msn_end, evalhc, &maxuid, initial_download) < 0)
1446 goto bail;
1447
1448#ifdef USE_HCACHE
1449 if (eval_qresync && initial_download)
1450 {
1451 if (imap_verify_qresync(m) != 0)
1452 {
1453 eval_qresync = false;
1454 eval_condstore = false;
1455 evalhc = false;
1456 modseq = 0;
1457 maxuid = 0;
1458 FREE(&uid_seqset);
1459 uidvalidity = 0;
1460 uid_next = 0;
1461 msn_begin = msn_begin_save;
1462
1463 goto retry;
1464 }
1465 }
1466#endif /* USE_HCACHE */
1467
1468 if (maxuid && (mdata->uid_next < maxuid + 1))
1469 mdata->uid_next = maxuid + 1;
1470
1471#ifdef USE_HCACHE
1472 hcache_store_raw(mdata->hcache, "UIDVALIDITY", 11, &mdata->uidvalidity,
1473 sizeof(mdata->uidvalidity));
1474 if (maxuid && (mdata->uid_next < maxuid + 1))
1475 {
1476 mutt_debug(LL_DEBUG2, "Overriding UIDNEXT: %u -> %u\n", mdata->uid_next, maxuid + 1);
1477 mdata->uid_next = maxuid + 1;
1478 }
1479 if (mdata->uid_next > 1)
1480 {
1481 hcache_store_raw(mdata->hcache, "UIDNEXT", 7, &mdata->uid_next, sizeof(mdata->uid_next));
1482 }
1483
1484 /* We currently only sync CONDSTORE and QRESYNC on the initial download.
1485 * To do it more often, we'll need to deal with flag updates combined with
1486 * unsync'ed local flag changes. We'll also need to properly sync flags to
1487 * the header cache on close. I'm not sure it's worth the added complexity. */
1488 if (initial_download)
1489 {
1490 if (has_condstore || has_qresync)
1491 {
1492 hcache_store_raw(mdata->hcache, "MODSEQ", 6, &mdata->modseq, sizeof(mdata->modseq));
1493 }
1494 else
1495 {
1496 hcache_delete_raw(mdata->hcache, "MODSEQ", 6);
1497 }
1498
1499 if (has_qresync)
1500 imap_hcache_store_uid_seqset(mdata);
1501 else
1502 imap_hcache_clear_uid_seqset(mdata);
1503 }
1504#endif /* USE_HCACHE */
1505
1506 /* TODO: it's not clear to me why we are calling mx_alloc_memory yet again. */
1507 mx_alloc_memory(m, m->msg_count);
1508
1509 mdata->reopen |= IMAP_REOPEN_ALLOW;
1510
1511 rc = msn_end;
1512
1513bail:
1514#ifdef USE_HCACHE
1515 imap_hcache_close(mdata);
1516 FREE(&uid_seqset);
1517#endif /* USE_HCACHE */
1518
1519 return rc;
1520}
hcache_delete_raw
int hcache_delete_raw(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:752
hcache_store_raw
int hcache_store_raw(struct HeaderCache *hc, const char *key, size_t keylen, void *data, size_t dlen)
Store a key / data pair.
Definition: hcache.c:724
hcache_fetch_raw_obj
#define hcache_fetch_raw_obj(hc, key, keylen, dst)
Definition: lib.h:162
imap_verify_qresync
static int imap_verify_qresync(struct Mailbox *m)
Check to see if QRESYNC got jumbled.
Definition: message.c:1013
read_headers_condstore_qresync_updates
static int read_headers_condstore_qresync_updates(struct ImapAccountData *adata, unsigned int msn_end, unsigned int uid_next, unsigned long long hc_modseq, bool eval_qresync)
Retrieve updates from the server.
Definition: message.c:914
read_headers_fetch_new
static int read_headers_fetch_new(struct Mailbox *m, unsigned int msn_begin, unsigned int msn_end, bool evalhc, unsigned int *maxuid, bool initial_download)
Retrieve new messages from the server.
Definition: message.c:1090
read_headers_normal_eval_cache
static int read_headers_normal_eval_cache(struct ImapAccountData *adata, unsigned int msn_end, unsigned int uid_next, bool store_flag_updates, bool eval_condstore)
Retrieve data from the header cache.
Definition: message.c:683
read_headers_qresync_eval_cache
static int read_headers_qresync_eval_cache(struct ImapAccountData *adata, char *uid_seqset)
Retrieve data from the header cache.
Definition: message.c:828
imap_alloc_uid_hash
static void imap_alloc_uid_hash(struct ImapAccountData *adata, unsigned int msn_count)
Create a Hash Table for the UIDs.
Definition: message.c:527
imap_hcache_store_uid_seqset
int imap_hcache_store_uid_seqset(struct ImapMboxData *mdata)
Store a UID Sequence Set in the header cache.
Definition: util.c:418
imap_hcache_get_uid_seqset
char * imap_hcache_get_uid_seqset(struct ImapMboxData *mdata)
Get a UID Sequence Set from the header cache.
Definition: util.c:453
imap_hcache_clear_uid_seqset
int imap_hcache_clear_uid_seqset(struct ImapMboxData *mdata)
Delete a UID Sequence Set from the header cache.
Definition: util.c:439
imap_msn_get
struct Email * imap_msn_get(const struct MSNArray *msn, int idx)
Return the Email associated with an msn.
Definition: msn.c:83
imap_msn_reserve
void imap_msn_reserve(struct MSNArray *msn, size_t num)
Create / reallocate the cache.
Definition: msn.c:44
mx_alloc_memory
void mx_alloc_memory(struct Mailbox *m, int req_size)
Create storage for the emails.
Definition: mx.c:1211
ImapAccountData::qresync
bool qresync
true, if QRESYNC is successfully ENABLE'd
Definition: adata.h:63
ImapMboxData::uid_next
unsigned int uid_next
Definition: mdata.h:52
ImapMboxData::modseq
unsigned long long modseq
Definition: mdata.h:53
ImapMboxData::uidvalidity
uint32_t uidvalidity
Definition: mdata.h:51
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_set_flags()

char * imap_set_flags ( struct Mailbox *  m,
struct Email *  e,
char *  s,
bool *  server_changes 
)

Fill the message header according to the server flags.

Parameters
[in]mImap Selected Mailbox
[in]eEmail
[in]sCommand string
[out]server_changesSet to true if the flags have changed
Return values
ptrThe end of flags string
NULLFailure

Expects a flags line of the form "FLAGS (flag flag ...)"

imap_set_flags: fill out the message header according to the flags from the server. Expects a flags line of the form "FLAGS (flag flag ...)"

Sets server_changes to 1 if a change to a flag is made, or in the case of e->changed, if a change to a flag would have been made.

Definition at line 1920 of file message.c.

1921{
1922 struct ImapAccountData *adata = imap_adata_get(m);
1923 if (!adata || (adata->mailbox != m))
1924 return NULL;
1925
1926 struct ImapHeader newh = { 0 };
1927 struct ImapEmailData old_edata = { 0 };
1928 int local_changes = e->changed;
1929
1930 struct ImapEmailData *edata = e->edata;
1931 newh.edata = edata;
1932
1933 mutt_debug(LL_DEBUG2, "parsing FLAGS\n");
1934 s = msg_parse_flags(&newh, s);
1935 if (!s)
1936 return NULL;
1937
1938 /* Update tags system */
1939 /* We take a copy of the tags so we can split the string */
1940 char *tags_copy = mutt_str_dup(edata->flags_remote);
1941 driver_tags_replace(&e->tags, tags_copy);
1942 FREE(&tags_copy);
1943
1944 /* YAUH (yet another ugly hack): temporarily set context to
1945 * read-write even if it's read-only, so *server* updates of
1946 * flags can be processed by mutt_set_flag. mailbox->changed must
1947 * be restored afterwards */
1948 bool readonly = m->readonly;
1949 m->readonly = false;
1950
1951 /* This is redundant with the following two checks. Removing:
1952 * mutt_set_flag (m, e, MUTT_NEW, !(edata->read || edata->old), true); */
1953 set_changed_flag(m, e, local_changes, server_changes, MUTT_OLD, old_edata.old,
1954 edata->old, e->old);
1955 set_changed_flag(m, e, local_changes, server_changes, MUTT_READ,
1956 old_edata.read, edata->read, e->read);
1957 set_changed_flag(m, e, local_changes, server_changes, MUTT_DELETE,
1958 old_edata.deleted, edata->deleted, e->deleted);
1959 set_changed_flag(m, e, local_changes, server_changes, MUTT_FLAG,
1960 old_edata.flagged, edata->flagged, e->flagged);
1961 set_changed_flag(m, e, local_changes, server_changes, MUTT_REPLIED,
1962 old_edata.replied, edata->replied, e->replied);
1963
1964 /* this message is now definitively *not* changed (mutt_set_flag
1965 * marks things changed as a side-effect) */
1966 if (local_changes == 0)
1967 e->changed = false;
1968 m->changed &= !readonly;
1969 m->readonly = readonly;
1970
1971 return s;
1972}
set_changed_flag
static void set_changed_flag(struct Mailbox *m, struct Email *e, int local_changes, bool *server_changes, enum MessageType flag_name, bool old_hd_flag, bool new_hd_flag, bool h_flag)
Have the flags of an email changed.
Definition: message.c:643
msg_parse_flags
static char * msg_parse_flags(struct ImapHeader *h, char *s)
Read a FLAGS token into an ImapHeader.
Definition: message.c:192
mutt_str_dup
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:254
MUTT_READ
@ MUTT_READ
Messages that have been read.
Definition: mutt.h:73
MUTT_OLD
@ MUTT_OLD
Old messages.
Definition: mutt.h:71
MUTT_FLAG
@ MUTT_FLAG
Flagged messages.
Definition: mutt.h:79
MUTT_DELETE
@ MUTT_DELETE
Messages to be deleted.
Definition: mutt.h:75
MUTT_REPLIED
@ MUTT_REPLIED
Messages that have been replied to.
Definition: mutt.h:72
ImapEmailData::old
bool old
Email has been seen.
Definition: edata.h:38
ImapEmailData::read
bool read
Email has been read.
Definition: edata.h:37
ImapEmailData::flagged
bool flagged
Email has been flagged.
Definition: edata.h:40
ImapEmailData::replied
bool replied
Email has been replied to.
Definition: edata.h:41
ImapHeader
IMAP-specific header.
Definition: message.h:34
ImapHeader::edata
struct ImapEmailData * edata
Definition: message.h:35
Mailbox::changed
bool changed
Mailbox has been modified.
Definition: mailbox.h:110
Mailbox::readonly
bool readonly
Don't allow changes to the mailbox.
Definition: mailbox.h:116
driver_tags_replace
bool driver_tags_replace(struct TagList *tl, const char *tags)
Replace all tags.
Definition: tags.c:201
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_cache_del()

int imap_cache_del ( struct Mailbox *  m,
struct Email *  e 
)

Delete an email from the body cache.

Parameters
mSelected Imap Mailbox
eEmail
Return values
0Success
-1Failure

Definition at line 1869 of file message.c.

1870{
1871 struct ImapAccountData *adata = imap_adata_get(m);
1872 struct ImapMboxData *mdata = imap_mdata_get(m);
1873
1874 if (!e || !adata || (adata->mailbox != m))
1875 return -1;
1876
1877 mdata->bcache = imap_bcache_open(m);
1878 char id[64] = { 0 };
1879 snprintf(id, sizeof(id), "%u-%u", mdata->uidvalidity, imap_edata_get(e)->uid);
1880 return mutt_bcache_del(mdata->bcache, id);
1881}
mutt_bcache_del
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition: bcache.c:269
imap_bcache_open
static struct BodyCache * imap_bcache_open(struct Mailbox *m)
Open a message cache.
Definition: message.c:81
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_cache_clean()

int imap_cache_clean ( struct Mailbox *  m)

Delete all the entries in the message cache.

Parameters
mSelectedImap Mailbox
Return values
0Always

Definition at line 1888 of file message.c.

1889{
1890 struct ImapAccountData *adata = imap_adata_get(m);
1891 struct ImapMboxData *mdata = imap_mdata_get(m);
1892
1893 if (!adata || (adata->mailbox != m))
1894 return -1;
1895
1896 mdata->bcache = imap_bcache_open(m);
1897 mutt_bcache_list(mdata->bcache, imap_bcache_delete, mdata);
1898
1899 return 0;
1900}
mutt_bcache_list
int mutt_bcache_list(struct BodyCache *bcache, bcache_list_t want_id, void *data)
Find matching entries in the Body Cache.
Definition: bcache.c:334
imap_bcache_delete
static int imap_bcache_delete(const char *id, struct BodyCache *bcache, void *data)
Delete an entry from the message cache - Implements bcache_list_t -.
Definition: message.c:169
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_append_message()

int imap_append_message ( struct Mailbox *  m,
struct Message *  msg 
)

Write an email back to the server.

Parameters
mMailbox
msgMessage to save
Return values
0Success
-1Failure

Definition at line 1529 of file message.c.

1530{
1531 if (!m || !msg)
1532 return -1;
1533
1534 FILE *fp = NULL;
1535 char buf[2048] = { 0 };
1536 struct Buffer *internaldate = NULL;
1537 struct Buffer *imap_flags = NULL;
1538 size_t len;
1539 struct Progress *progress = NULL;
1540 size_t sent;
1541 int c, last;
1542 int rc;
1543
1544 struct ImapAccountData *adata = imap_adata_get(m);
1545 struct ImapMboxData *mdata = imap_mdata_get(m);
1546
1547 fp = mutt_file_fopen(msg->path, "r");
1548 if (!fp)
1549 {
1550 mutt_perror("%s", msg->path);
1551 goto fail;
1552 }
1553
1554 /* currently we set the \Seen flag on all messages, but probably we
1555 * should scan the message Status header for flag info. Since we're
1556 * already rereading the whole file for length it isn't any more
1557 * expensive (it'd be nice if we had the file size passed in already
1558 * by the code that writes the file, but that's a lot of changes.
1559 * Ideally we'd have an Email structure with flag info here... */
1560 for (last = EOF, len = 0; (c = fgetc(fp)) != EOF; last = c)
1561 {
1562 if ((c == '\n') && (last != '\r'))
1563 len++;
1564
1565 len++;
1566 }
1567 rewind(fp);
1568
1569 if (m->verbose)
1570 {
1571 progress = progress_new(MUTT_PROGRESS_NET, len);
1572 progress_set_message(progress, _("Uploading message..."));
1573 }
1574
1575 internaldate = buf_pool_get();
1576 mutt_date_make_imap(internaldate, msg->received);
1577
1578 imap_flags = buf_pool_get();
1579
1580 if (msg->flags.read)
1581 buf_addstr(imap_flags, " \\Seen");
1582 if (msg->flags.replied)
1583 buf_addstr(imap_flags, " \\Answered");
1584 if (msg->flags.flagged)
1585 buf_addstr(imap_flags, " \\Flagged");
1586 if (msg->flags.draft)
1587 buf_addstr(imap_flags, " \\Draft");
1588
1589 snprintf(buf, sizeof(buf), "APPEND %s (%s) \"%s\" {%lu}", mdata->munge_name,
1590 imap_flags->data + 1, buf_string(internaldate), (unsigned long) len);
1591 buf_pool_release(&internaldate);
1592
1593 imap_cmd_start(adata, buf);
1594
1595 do
1596 {
1597 rc = imap_cmd_step(adata);
1598 } while (rc == IMAP_RES_CONTINUE);
1599
1600 if (rc != IMAP_RES_RESPOND)
1601 goto cmd_step_fail;
1602
1603 for (last = EOF, sent = len = 0; (c = fgetc(fp)) != EOF; last = c)
1604 {
1605 if ((c == '\n') && (last != '\r'))
1606 buf[len++] = '\r';
1607
1608 buf[len++] = c;
1609
1610 if (len > sizeof(buf) - 3)
1611 {
1612 sent += len;
1613 if (flush_buffer(buf, &len, adata->conn) < 0)
1614 goto fail;
1615 progress_update(progress, sent, -1);
1616 }
1617 }
1618
1619 if (len > 0)
1620 if (flush_buffer(buf, &len, adata->conn) < 0)
1621 goto fail;
1622
1623 if (mutt_socket_send(adata->conn, "\r\n") < 0)
1624 goto fail;
1625 mutt_file_fclose(&fp);
1626
1627 do
1628 {
1629 rc = imap_cmd_step(adata);
1630 } while (rc == IMAP_RES_CONTINUE);
1631
1632 if (rc != IMAP_RES_OK)
1633 goto cmd_step_fail;
1634
1635 progress_free(&progress);
1636 buf_pool_release(&imap_flags);
1637 return 0;
1638
1639cmd_step_fail:
1640 mutt_debug(LL_DEBUG1, "command failed: %s\n", adata->buf);
1641 if (rc != IMAP_RES_BAD)
1642 {
1643 char *pc = imap_next_word(adata->buf); /* skip sequence number or token */
1644 pc = imap_next_word(pc); /* skip response code */
1645 if (*pc != '\0')
1646 mutt_error("%s", pc);
1647 }
1648
1649fail:
1650 mutt_file_fclose(&fp);
1651 progress_free(&progress);
1652 buf_pool_release(&imap_flags);
1653 return -1;
1654}
mutt_file_fclose
#define mutt_file_fclose(FP)
Definition: file.h:139
mutt_file_fopen
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:138
mutt_perror
#define mutt_perror(...)
Definition: logging2.h:94
imap_cmd_start
int imap_cmd_start(struct ImapAccountData *adata, const char *cmdstr)
Given an IMAP command, send it to the server.
Definition: command.c:1114
flush_buffer
static int flush_buffer(char *buf, size_t *len, struct Connection *conn)
Write data to a connection.
Definition: message.c:487
mutt_date_make_imap
int mutt_date_make_imap(struct Buffer *buf, time_t timestamp)
Format date in IMAP style: DD-MMM-YYYY HH:MM:SS +ZZzz.
Definition: date.c:811
MUTT_PROGRESS_NET
@ MUTT_PROGRESS_NET
Progress tracks bytes, according to $net_inc
Definition: lib.h:82
progress_new
struct Progress * progress_new(enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:139
progress_free
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:110
progress_set_message
void progress_set_message(struct Progress *progress, const char *fmt,...) __attribute__((__format__(__printf__
mutt_socket_send
#define mutt_socket_send(conn, buf)
Definition: socket.h:57
Mailbox::verbose
bool verbose
Display status messages?
Definition: mailbox.h:117
Message::path
char * path
path to temp file
Definition: message.h:36
Message::draft
bool draft
Message has been read.
Definition: message.h:44
Message::replied
bool replied
Message has been replied to.
Definition: message.h:43
Message::received
time_t received
Time at which this message was received.
Definition: message.h:46
Message::flagged
bool flagged
Message is flagged.
Definition: message.h:42
Message::read
bool read
Message has been read.
Definition: message.h:41
Message::flags
struct Message::@0 flags
Flags for the Message.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_open()

void imap_hcache_open ( struct ImapAccountData *  adata,
struct ImapMboxData *  mdata,
bool  create 
)

Open a header cache.

Parameters
adataImap Account data
mdataImap Mailbox data
createCreate a new header cache if missing?

Definition at line 302 of file util.c.

303{
304 if (!adata || !mdata)
305 return;
306
307 if (mdata->hcache)
308 return;
309
310 struct HeaderCache *hc = NULL;
311 struct Buffer *mbox = buf_pool_get();
312 struct Buffer *cachepath = buf_pool_get();
313
314 imap_cachepath(adata->delim, mdata->name, mbox);
315
316 if (strstr(buf_string(mbox), "/../") || mutt_str_equal(buf_string(mbox), "..") ||
317 mutt_strn_equal(buf_string(mbox), "../", 3))
318 {
319 goto cleanup;
320 }
321 size_t len = buf_len(mbox);
322 if ((len > 3) && (mutt_str_equal(buf_string(mbox) + len - 3, "/..")))
323 goto cleanup;
324
325 struct Url url = { 0 };
326 account_to_url(&adata->conn->account, &url);
327 url.path = mbox->data;
328 url_tobuffer(&url, cachepath, U_PATH);
329
330 const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
331 hc = hcache_open(c_header_cache, buf_string(cachepath), imap_hcache_namer, create);
332
333cleanup:
334 buf_pool_release(&mbox);
335 buf_pool_release(&cachepath);
336 mdata->hcache = hc;
337}
buf_len
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition: buffer.c:491
cs_subset_path
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:168
imap_hcache_namer
static void imap_hcache_namer(const char *path, struct Buffer *dest)
Generate a filename for the header cache - Implements hcache_namer_t -.
Definition: util.c:291
hcache_open
struct HeaderCache * hcache_open(const char *path, const char *folder, hcache_namer_t namer, bool create)
Multiplexor for StoreOps::open.
Definition: hcache.c:471
mutt_strn_equal
bool mutt_strn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings (to a maximum), safely.
Definition: string.c:426
account_to_url
void account_to_url(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:80
HeaderCache
Header Cache.
Definition: lib.h:86
ImapMboxData::hcache
struct HeaderCache * hcache
Email header cache.
Definition: mdata.h:63
ImapMboxData::name
char * name
Mailbox name.
Definition: mdata.h:41
Url
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition: url.h:69
Url::path
char * path
Path.
Definition: url.h:75
url_tobuffer
int url_tobuffer(const struct Url *url, struct Buffer *buf, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:358
U_PATH
#define U_PATH
Definition: url.h:50
imap_cachepath
void imap_cachepath(char delim, const char *mailbox, struct Buffer *dest)
Generate a cache path for a mailbox.
Definition: util.c:749
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_close()

void imap_hcache_close ( struct ImapMboxData *  mdata)

Close the header cache.

Parameters
mdataImap Mailbox data

Definition at line 343 of file util.c.

344{
345 if (!mdata->hcache)
346 return;
347
348 hcache_close(&mdata->hcache);
349}
hcache_close
void hcache_close(struct HeaderCache **ptr)
Multiplexor for StoreOps::close.
Definition: hcache.c:542
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_get()

struct Email * imap_hcache_get ( struct ImapMboxData *  mdata,
unsigned int  uid 
)

Get a header cache entry by its UID.

Parameters
mdataImap Mailbox data
uidUID to find
Return values
ptrEmail
NULLFailure

Definition at line 358 of file util.c.

359{
360 if (!mdata->hcache)
361 return NULL;
362
363 char key[16] = { 0 };
364
365 snprintf(key, sizeof(key), "%u", uid);
366 struct HCacheEntry hce = hcache_fetch_email(mdata->hcache, key, mutt_str_len(key),
367 mdata->uidvalidity);
368 if (!hce.email && hce.uidvalidity)
369 {
370 mutt_debug(LL_DEBUG3, "hcache uidvalidity mismatch: %u\n", hce.uidvalidity);
371 }
372
373 return hce.email;
374}
hcache_fetch_email
struct HCacheEntry hcache_fetch_email(struct HeaderCache *hc, const char *key, size_t keylen, uint32_t uidvalidity)
Multiplexor for StoreOps::fetch.
Definition: hcache.c:562
HCacheEntry
Wrapper for Email retrieved from the header cache.
Definition: lib.h:99
HCacheEntry::uidvalidity
uint32_t uidvalidity
IMAP-specific UIDVALIDITY.
Definition: lib.h:100
HCacheEntry::email
struct Email * email
Retrieved email.
Definition: lib.h:102
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_put()

int imap_hcache_put ( struct ImapMboxData *  mdata,
struct Email *  e 
)

Add an entry to the header cache.

Parameters
mdataImap Mailbox data
eEmail
Return values
0Success
-1Failure

Definition at line 383 of file util.c.

384{
385 if (!mdata->hcache)
386 return -1;
387
388 char key[16] = { 0 };
389
390 snprintf(key, sizeof(key), "%u", imap_edata_get(e)->uid);
391 return hcache_store_email(mdata->hcache, key, mutt_str_len(key), e, mdata->uidvalidity);
392}
hcache_store_email
int hcache_store_email(struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
Multiplexor for StoreOps::store.
Definition: hcache.c:670
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_del()

int imap_hcache_del ( struct ImapMboxData *  mdata,
unsigned int  uid 
)

Delete an item from the header cache.

Parameters
mdataImap Mailbox data
uidUID of entry to delete
Return values
0Success
-1Failure

Definition at line 401 of file util.c.

402{
403 if (!mdata->hcache)
404 return -1;
405
406 char key[16] = { 0 };
407
408 snprintf(key, sizeof(key), "%u", uid);
409 return hcache_delete_email(mdata->hcache, key, mutt_str_len(key));
410}
hcache_delete_email
int hcache_delete_email(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:739
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_store_uid_seqset()

int imap_hcache_store_uid_seqset ( struct ImapMboxData *  mdata)

Store a UID Sequence Set in the header cache.

Parameters
mdataImap Mailbox data
Return values
0Success
-1Error

Definition at line 418 of file util.c.

419{
420 if (!mdata->hcache)
421 return -1;
422
423 struct Buffer *buf = buf_pool_get();
424 buf_alloc(buf, 8192); // The seqset is likely large. Preallocate to reduce reallocs
425 imap_msn_index_to_uid_seqset(buf, mdata);
426
427 int rc = hcache_store_raw(mdata->hcache, "UIDSEQSET", 9, buf->data, buf_len(buf) + 1);
428 mutt_debug(LL_DEBUG3, "Stored UIDSEQSET %s\n", buf_string(buf));
429 buf_pool_release(&buf);
430 return rc;
431}
imap_msn_index_to_uid_seqset
static void imap_msn_index_to_uid_seqset(struct Buffer *buf, struct ImapMboxData *mdata)
Convert MSN index of UIDs to Seqset.
Definition: util.c:234
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_clear_uid_seqset()

int imap_hcache_clear_uid_seqset ( struct ImapMboxData *  mdata)

Delete a UID Sequence Set from the header cache.

Parameters
mdataImap Mailbox data
Return values
0Success
-1Error

Definition at line 439 of file util.c.

440{
441 if (!mdata->hcache)
442 return -1;
443
444 return hcache_delete_raw(mdata->hcache, "UIDSEQSET", 9);
445}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_hcache_get_uid_seqset()

char * imap_hcache_get_uid_seqset ( struct ImapMboxData *  mdata)

Get a UID Sequence Set from the header cache.

Parameters
mdataImap Mailbox data
Return values
ptrUID Sequence Set
NULLError

Definition at line 453 of file util.c.

454{
455 if (!mdata->hcache)
456 return NULL;
457
458 char *seqset = hcache_fetch_raw_str(mdata->hcache, "UIDSEQSET", 9);
459 mutt_debug(LL_DEBUG3, "Retrieved UIDSEQSET %s\n", NONULL(seqset));
460
461 return seqset;
462}
hcache_fetch_raw_str
char * hcache_fetch_raw_str(struct HeaderCache *hc, const char *key, size_t keylen)
Fetch a string from the cache.
Definition: hcache.c:652
NONULL
#define NONULL(x)
Definition: string2.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_continue()

enum QuadOption imap_continue ( const char *  msg,
const char *  resp 
)

Display a message and ask the user if they want to go on.

Parameters
msgLocation of the error
respMessage for user
Return values
QuadOptionResult, e.g. MUTT_NO

Definition at line 649 of file util.c.

650{
651 imap_error(msg, resp);
652 return query_yesorno(_("Continue?"), MUTT_NO);
653}
MUTT_NO
@ MUTT_NO
User answered 'No', or assume 'No'.
Definition: quad.h:38
query_yesorno
enum QuadOption query_yesorno(const char *prompt, enum QuadOption def)
Ask the user a Yes/No question.
Definition: question.c:327
imap_error
void imap_error(const char *where, const char *msg)
Show an error and abort.
Definition: util.c:660
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_error()

void imap_error ( const char *  where,
const char *  msg 
)

Show an error and abort.

Parameters
whereLocation of the error
msgMessage for user

Definition at line 660 of file util.c.

661{
662 mutt_error("%s [%s]", where, msg);
663}
+ Here is the caller graph for this function:

◆ imap_mdata_cache_reset()

void imap_mdata_cache_reset ( struct ImapMboxData *  mdata)

Release and clear cache data of ImapMboxData structure.

Parameters
mdataImap Mailbox data

Definition at line 109 of file util.c.

110{
111 mutt_hash_free(&mdata->uid_hash);
112 imap_msn_free(&mdata->msn);
113 mutt_bcache_close(&mdata->bcache);
114}
mutt_bcache_close
void mutt_bcache_close(struct BodyCache **ptr)
Close an Email-Body Cache.
Definition: bcache.c:167
mutt_hash_free
void mutt_hash_free(struct HashTable **ptr)
Free a hash table.
Definition: hash.c:457
imap_msn_free
void imap_msn_free(struct MSNArray *msn)
Free the cache.
Definition: msn.c:62
ImapMboxData::bcache
struct BodyCache * bcache
Email body cache.
Definition: mdata.h:61
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_fix_path()

char * imap_fix_path ( const char *  mailbox,
char *  path,
size_t  plen 
)

Fix up the imap path.

Parameters
mailboxMailbox path
pathBuffer for the result
plenLength of buffer
Return values
ptrFixed-up path
Note
the first character in mailbox matching any of the characters in $imap_delim_chars is used as a delimiter.

This is necessary because the rest of neomutt assumes a hierarchy delimiter of '/', which is not necessarily true in IMAP. Additionally, the filesystem converts multiple hierarchy delimiters into a single one, ie "///" is equal to "/". IMAP servers are not required to do this. Moreover, IMAP servers may dislike the path ending with the delimiter.

Definition at line 681 of file util.c.

682{
683 const char *const c_imap_delim_chars = cs_subset_string(NeoMutt->sub, "imap_delim_chars");
684
685 char *out = path;
686 size_t space_left = plen - 1;
687
688 if (mailbox)
689 {
690 for (const char *c = mailbox; *c && space_left; c++, space_left--)
691 {
692 if (strchr(NONULL(c_imap_delim_chars), *c))
693 {
694 return imap_fix_path_with_delim(*c, mailbox, path, plen);
695 }
696 *out++ = *c;
697 }
698 }
699
700 *out = '\0';
701 return path;
702}
cs_subset_string
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:291
imap_fix_path_with_delim
char * imap_fix_path_with_delim(const char delim, const char *mailbox, char *path, size_t plen)
Fix up the imap path.
Definition: util.c:713
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_fix_path_with_delim()

char * imap_fix_path_with_delim ( const char  delim,
const char *  mailbox,
char *  path,
size_t  plen 
)

Fix up the imap path.

Parameters
delimDelimiter specified by the server
mailboxMailbox path
pathBuffer for the result
plenLength of buffer
Return values
ptrFixed-up path

Definition at line 713 of file util.c.

714{
715 char *out = path;
716 size_t space_left = plen - 1;
717
718 if (mailbox)
719 {
720 for (const char *c = mailbox; *c && space_left; c++, space_left--)
721 {
722 if (*c == delim || *c == '/')
723 {
724 while (*c && *(c + 1) == *c)
725 c++;
726 *out++ = delim;
727 }
728 else
729 {
730 *out++ = *c;
731 }
732 }
733 }
734
735 if (out != path && *(out - 1) == delim)
736 {
737 out--;
738 }
739 *out = '\0';
740 return path;
741}
+ Here is the caller graph for this function:

◆ imap_cachepath()

void imap_cachepath ( char  delim,
const char *  mailbox,
struct Buffer *  dest 
)

Generate a cache path for a mailbox.

Parameters
delimImap server delimiter
mailboxMailbox name
destBuffer to store cache path

Definition at line 749 of file util.c.

750{
751 const char *p = mailbox;
752 buf_reset(dest);
753 if (!p)
754 return;
755
756 while (*p)
757 {
758 if (p[0] == delim)
759 {
760 buf_addch(dest, '/');
761 /* simple way to avoid collisions with UIDs */
762 if ((p[1] >= '0') && (p[1] <= '9'))
763 buf_addch(dest, '_');
764 }
765 else
766 {
767 buf_addch(dest, *p);
768 }
769 p++;
770 }
771}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_get_literal_count()

int imap_get_literal_count ( const char *  buf,
unsigned int *  bytes 
)

Write number of bytes in an IMAP literal into bytes.

Parameters
[in]bufNumber as a string
[out]bytesResulting number
Return values
0Success
-1Failure

Definition at line 780 of file util.c.

781{
782 char *pc = NULL;
783 char *pn = NULL;
784
785 if (!buf || !(pc = strchr(buf, '{')))
786 return -1;
787
788 pc++;
789 pn = pc;
790 while (isdigit((unsigned char) *pc))
791 pc++;
792 *pc = '\0';
793 if (!mutt_str_atoui(pn, bytes))
794 return -1;
795
796 return 0;
797}
mutt_str_atoui
const char * mutt_str_atoui(const char *str, unsigned int *dst)
Convert ASCII string to an unsigned integer.
Definition: atoi.c:218
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_get_qualifier()

char * imap_get_qualifier ( char *  buf)

Get the qualifier from a tagged response.

Parameters
bufCommand string to process
Return values
ptrStart of the qualifier

In a tagged response, skip tag and status for the qualifier message. Used by imap_copy_message for TRYCREATE

Definition at line 807 of file util.c.

808{
809 char *s = buf;
810
811 /* skip tag */
812 s = imap_next_word(s);
813 /* skip OK/NO/BAD response */
814 s = imap_next_word(s);
815
816 return s;
817}
imap_next_word
char * imap_next_word(char *s)
Find where the next IMAP word begins.
Definition: util.c:824
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_next_word()

char * imap_next_word ( char *  s)

Find where the next IMAP word begins.

Parameters
sCommand string to process
Return values
ptrNext IMAP word

Definition at line 824 of file util.c.

825{
826 bool quoted = false;
827
828 while (*s)
829 {
830 if (*s == '\\')
831 {
832 s++;
833 if (*s)
834 s++;
835 continue;
836 }
837 if (*s == '\"')
838 quoted = !quoted;
839 if (!quoted && isspace(*s))
840 break;
841 s++;
842 }
843
844 SKIPWS(s);
845 return s;
846}
SKIPWS
#define SKIPWS(ch)
Definition: string2.h:45
+ Here is the caller graph for this function:

◆ imap_qualify_path()

void imap_qualify_path ( char *  buf,
size_t  buflen,
struct ConnAccount *  cac,
char *  path 
)

Make an absolute IMAP folder target.

Parameters
bufBuffer for the result
buflenLength of buffer
cacConnAccount of the account
pathPath relative to the mailbox

Definition at line 855 of file util.c.

856{
857 struct Url url = { 0 };
858 account_to_url(cac, &url);
859 url.path = path;
860 url_tostring(&url, buf, buflen, U_NO_FLAGS);
861}
url_tostring
int url_tostring(const struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:423
U_NO_FLAGS
#define U_NO_FLAGS
Definition: url.h:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_buf_qualify_path()

void imap_buf_qualify_path ( struct Buffer *  buf,
struct ConnAccount *  cac,
char *  path 
)

Make an absolute IMAP folder target to a buffer.

Parameters
bufBuffer for the result
cacConnAccount of the account
pathPath relative to the mailbox

Definition at line 869 of file util.c.

870{
871 struct Url url = { 0 };
872 account_to_url(cac, &url);
873 url.path = path;
874 url_tobuffer(&url, buf, U_NO_FLAGS);
875}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_quote_string()

void imap_quote_string ( char *  dest,
size_t  dlen,
const char *  src,
bool  quote_backtick 
)

Quote string according to IMAP rules.

Parameters
destBuffer for the result
dlenLength of the buffer
srcString to be quoted
quote_backtickIf true, quote backticks too

Surround string with quotes, escape " and \ with backslash

Definition at line 886 of file util.c.

887{
888 const char *quote = "`\"\\";
889 if (!quote_backtick)
890 quote++;
891
892 char *pt = dest;
893 const char *s = src;
894
895 *pt++ = '"';
896 /* save room for quote-chars */
897 dlen -= 3;
898
899 for (; *s && dlen; s++)
900 {
901 if (strchr(quote, *s))
902 {
903 if (dlen < 2)
904 break;
905 dlen -= 2;
906 *pt++ = '\\';
907 *pt++ = *s;
908 }
909 else
910 {
911 *pt++ = *s;
912 dlen--;
913 }
914 }
915 *pt++ = '"';
916 *pt = '\0';
917}
+ Here is the caller graph for this function:

◆ imap_unquote_string()

void imap_unquote_string ( char *  s)

Equally stupid unquoting routine.

Parameters
sString to be unquoted

Definition at line 923 of file util.c.

924{
925 char *d = s;
926
927 if (*s == '\"')
928 s++;
929 else
930 return;
931
932 while (*s)
933 {
934 if (*s == '\"')
935 {
936 *d = '\0';
937 return;
938 }
939 if (*s == '\\')
940 {
941 s++;
942 }
943 if (*s)
944 {
945 *d = *s;
946 d++;
947 s++;
948 }
949 }
950 *d = '\0';
951}
+ Here is the caller graph for this function:

◆ imap_munge_mbox_name()

void imap_munge_mbox_name ( bool  unicode,
char *  dest,
size_t  dlen,
const char *  src 
)

Quote awkward characters in a mailbox name.

Parameters
unicodetrue if Unicode is allowed
destBuffer to store safe mailbox name
dlenLength of buffer
srcMailbox name

Definition at line 960 of file util.c.

961{
962 char *buf = mutt_str_dup(src);
963 imap_utf_encode(unicode, &buf);
964
965 imap_quote_string(dest, dlen, buf, false);
966
967 FREE(&buf);
968}
imap_utf_encode
void imap_utf_encode(bool unicode, char **s)
Encode email from local charset to UTF-8.
Definition: utf7.c:397
imap_quote_string
void imap_quote_string(char *dest, size_t dlen, const char *src, bool quote_backtick)
Quote string according to IMAP rules.
Definition: util.c:886
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_unmunge_mbox_name()

void imap_unmunge_mbox_name ( bool  unicode,
char *  s 
)

Remove quoting from a mailbox name.

Parameters
unicodetrue if Unicode is allowed
sMailbox name

The string will be altered in-place.

Definition at line 977 of file util.c.

978{
979 imap_unquote_string(s);
980
981 char *buf = mutt_str_dup(s);
982 if (buf)
983 {
984 imap_utf_decode(unicode, &buf);
985 strncpy(s, buf, strlen(s));
986 }
987
988 FREE(&buf);
989}
imap_utf_decode
void imap_utf_decode(bool unicode, char **s)
Decode email from UTF-8 to local charset.
Definition: utf7.c:430
imap_unquote_string
void imap_unquote_string(char *s)
Equally stupid unquoting routine.
Definition: util.c:923
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_seqset_iterator_new()

struct SeqsetIterator * mutt_seqset_iterator_new ( const char *  seqset)

Create a new Sequence Set Iterator.

Parameters
seqsetSource Sequence Set
Return values
ptrNewly allocated Sequence Set Iterator

Definition at line 1125 of file util.c.

1126{
1127 if (!seqset || (*seqset == '\0'))
1128 return NULL;
1129
1130 struct SeqsetIterator *iter = MUTT_MEM_CALLOC(1, struct SeqsetIterator);
1131 iter->full_seqset = mutt_str_dup(seqset);
1132 iter->eostr = strchr(iter->full_seqset, '\0');
1133 iter->substr_cur = iter->substr_end = iter->full_seqset;
1134
1135 return iter;
1136}
MUTT_MEM_CALLOC
#define MUTT_MEM_CALLOC(n, type)
Definition: memory.h:40
SeqsetIterator
UID Sequence Set Iterator.
Definition: private.h:169
SeqsetIterator::eostr
char * eostr
Definition: private.h:171
SeqsetIterator::substr_end
char * substr_end
Definition: private.h:177
SeqsetIterator::substr_cur
char * substr_cur
Definition: private.h:176
SeqsetIterator::full_seqset
char * full_seqset
Definition: private.h:170
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_seqset_iterator_next()

int mutt_seqset_iterator_next ( struct SeqsetIterator *  iter,
unsigned int *  next 
)

Get the next UID from a Sequence Set.

Parameters
[in]iterSequence Set Iterator
[out]nextNext UID in set
Return values
0Next sequence is generated
1Iterator is finished
-1error

Definition at line 1146 of file util.c.

1147{
1148 if (!iter || !next)
1149 return -1;
1150
1151 if (iter->in_range)
1152 {
1153 if ((iter->down && (iter->range_cur == (iter->range_end - 1))) ||
1154 (!iter->down && (iter->range_cur == (iter->range_end + 1))))
1155 {
1156 iter->in_range = 0;
1157 }
1158 }
1159
1160 if (!iter->in_range)
1161 {
1162 iter->substr_cur = iter->substr_end;
1163 if (iter->substr_cur == iter->eostr)
1164 return 1;
1165
1166 iter->substr_end = strchr(iter->substr_cur, ',');
1167 if (!iter->substr_end)
1168 iter->substr_end = iter->eostr;
1169 else
1170 *(iter->substr_end++) = '\0';
1171
1172 char *range_sep = strchr(iter->substr_cur, ':');
1173 if (range_sep)
1174 *range_sep++ = '\0';
1175
1176 if (!mutt_str_atoui_full(iter->substr_cur, &iter->range_cur))
1177 return -1;
1178 if (range_sep)
1179 {
1180 if (!mutt_str_atoui_full(range_sep, &iter->range_end))
1181 return -1;
1182 }
1183 else
1184 {
1185 iter->range_end = iter->range_cur;
1186 }
1187
1188 iter->down = (iter->range_end < iter->range_cur);
1189 iter->in_range = 1;
1190 }
1191
1192 *next = iter->range_cur;
1193 if (iter->down)
1194 iter->range_cur--;
1195 else
1196 iter->range_cur++;
1197
1198 return 0;
1199}
SeqsetIterator::range_end
unsigned int range_end
Definition: private.h:175
SeqsetIterator::range_cur
unsigned int range_cur
Definition: private.h:174
+ Here is the caller graph for this function:

◆ mutt_seqset_iterator_free()

void mutt_seqset_iterator_free ( struct SeqsetIterator **  ptr)

Free a Sequence Set Iterator.

Parameters
[out]ptrIterator to free

Definition at line 1205 of file util.c.

1206{
1207 if (!ptr || !*ptr)
1208 return;
1209
1210 struct SeqsetIterator *iter = *ptr;
1211 FREE(&iter->full_seqset);
1212 FREE(ptr);
1213}
+ Here is the caller graph for this function:

◆ imap_account_match()

bool imap_account_match ( const struct ConnAccount *  a1,
const struct ConnAccount *  a2 
)

Compare two Accounts.

Parameters
a1First ConnAccount
a2Second ConnAccount
Return values
trueAccounts match

Definition at line 1093 of file util.c.

1094{
1095 if (!a1 || !a2)
1096 return false;
1097 if (a1->type != a2->type)
1098 return false;
1099 if (!mutt_istr_equal(a1->host, a2->host))
1100 return false;
1101 if ((a1->port != 0) && (a2->port != 0) && (a1->port != a2->port))
1102 return false;
1103 if (a1->flags & a2->flags & MUTT_ACCT_USER)
1104 return mutt_str_equal(a1->user, a2->user);
1105
1106 const char *user = NONULL(NeoMutt->username);
1107
1108 const char *const c_imap_user = cs_subset_string(NeoMutt->sub, "imap_user");
1109 if ((a1->type == MUTT_ACCT_TYPE_IMAP) && c_imap_user)
1110 user = c_imap_user;
1111
1112 if (a1->flags & MUTT_ACCT_USER)
1113 return mutt_str_equal(a1->user, user);
1114 if (a2->flags & MUTT_ACCT_USER)
1115 return mutt_str_equal(a2->user, user);
1116
1117 return true;
1118}
MUTT_ACCT_USER
#define MUTT_ACCT_USER
User field has been set.
Definition: connaccount.h:44
MUTT_ACCT_TYPE_IMAP
@ MUTT_ACCT_TYPE_IMAP
Imap Account.
Definition: mutt_account.h:36
ConnAccount::user
char user[128]
Username.
Definition: connaccount.h:56
ConnAccount::type
unsigned char type
Connection type, e.g. MUTT_ACCT_TYPE_IMAP.
Definition: connaccount.h:59
ConnAccount::flags
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:60
ConnAccount::port
unsigned short port
Port to connect to.
Definition: connaccount.h:58
NeoMutt::username
char * username
User's login name.
Definition: neomutt.h:54
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_get_parent()

void imap_get_parent ( const char *  mbox,
char  delim,
char *  buf,
size_t  buflen 
)

Get an IMAP folder's parent.

Parameters
mboxMailbox whose parent is to be determined
delimPath delimiter
bufBuffer for the result
buflenLength of the buffer

Definition at line 123 of file util.c.

124{
125 /* Make a copy of the mailbox name, but only if the pointers are different */
126 if (mbox != buf)
127 mutt_str_copy(buf, mbox, buflen);
128
129 int n = mutt_str_len(buf);
130
131 /* Let's go backwards until the next delimiter
132 *
133 * If buf[n] is a '/', the first n-- will allow us
134 * to ignore it. If it isn't, then buf looks like
135 * "/aaaaa/bbbb". There is at least one "b", so we can't skip
136 * the "/" after the 'a's.
137 *
138 * If buf == '/', then n-- => n == 0, so the loop ends
139 * immediately */
140 for (n--; (n >= 0) && (buf[n] != delim); n--)
141 ; // do nothing
142
143 /* We stopped before the beginning. There is a trailing slash. */
144 if (n > 0)
145 {
146 /* Strip the trailing delimiter. */
147 buf[n] = '\0';
148 }
149 else
150 {
151 buf[0] = (n == 0) ? delim : '\0';
152 }
153}
mutt_str_copy
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:582
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_account_match()

bool mutt_account_match ( const struct ConnAccount *  a1,
const struct ConnAccount *  a2 
)

◆ imap_utf_encode()

void imap_utf_encode ( bool  unicode,
char **  s 
)

Encode email from local charset to UTF-8.

Parameters
[in]unicodetrue if Unicode is allowed
[out]sEmail to convert

Definition at line 397 of file utf7.c.

398{
399 if (!s || !*s)
400 return;
401
402 const char *c_charset = cc_charset();
403 if (!c_charset)
404 return;
405
406 if (unicode && mutt_ch_is_utf8(c_charset))
407 {
408 return;
409 }
410
411 if (mutt_ch_convert_string(s, c_charset, "utf-8", MUTT_ICONV_NO_FLAGS) != 0)
412 {
413 FREE(s);
414 return;
415 }
416
417 if (!unicode)
418 {
419 char *utf7 = utf8_to_utf7(*s, strlen(*s), NULL, 0);
420 FREE(s);
421 *s = utf7;
422 }
423}
cc_charset
const char * cc_charset(void)
Get the cached value of $charset.
Definition: config_cache.c:116
mutt_ch_convert_string
int mutt_ch_convert_string(char **ps, const char *from, const char *to, uint8_t flags)
Convert a string between encodings.
Definition: charset.c:831
mutt_ch_is_utf8
#define mutt_ch_is_utf8(str)
Definition: charset.h:89
MUTT_ICONV_NO_FLAGS
#define MUTT_ICONV_NO_FLAGS
No flags are set.
Definition: charset.h:64
utf8_to_utf7
static char * utf8_to_utf7(const char *u8, size_t u8len, char **u7, size_t *u7len)
Convert data from UTF-8 to RFC2060's UTF-7.
Definition: utf7.c:252
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_utf_decode()

void imap_utf_decode ( bool  unicode,
char **  s 
)

Decode email from UTF-8 to local charset.

Parameters
[in]unicodetrue if Unicode is allowed
[out]sEmail to convert

Definition at line 430 of file utf7.c.

431{
432 if (!s || !*s)
433 return;
434
435 const char *c_charset = cc_charset();
436 if (!c_charset)
437 return;
438
439 if (unicode && mutt_ch_is_utf8(c_charset))
440 {
441 return;
442 }
443
444 if (!unicode)
445 {
446 char *utf8 = utf7_to_utf8(*s, strlen(*s), 0, 0);
447 FREE(s);
448 *s = utf8;
449 }
450
451 if (mutt_ch_convert_string(s, "utf-8", c_charset, MUTT_ICONV_NO_FLAGS) != 0)
452 {
453 FREE(s);
454 }
455}
utf7_to_utf8
static char * utf7_to_utf8(const char *u7, size_t u7len, char **u8, size_t *u8len)
Convert data from RFC2060's UTF-7 to UTF-8.
Definition: utf7.c:106
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_allow_reopen()

void imap_allow_reopen ( struct Mailbox *  m)

Allow re-opening a folder upon expunge.

Parameters
mMailbox

Definition at line 1065 of file util.c.

1066{
1067 struct ImapAccountData *adata = imap_adata_get(m);
1068 struct ImapMboxData *mdata = imap_mdata_get(m);
1069 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1070 return;
1071 mdata->reopen |= IMAP_REOPEN_ALLOW;
1072}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ imap_disallow_reopen()

void imap_disallow_reopen ( struct Mailbox *  m)

Disallow re-opening a folder upon expunge.

Parameters
mMailbox

Definition at line 1078 of file util.c.

1079{
1080 struct ImapAccountData *adata = imap_adata_get(m);
1081 struct ImapMboxData *mdata = imap_mdata_get(m);
1082 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1083 return;
1084 mdata->reopen &= ~IMAP_REOPEN_ALLOW;
1085}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cmd_parse_search()

void cmd_parse_search ( struct ImapAccountData *  adata,
const char *  s 
)

Store SEARCH response for later use.

Parameters
adataImap Account data
sCommand string with search results

Definition at line 256 of file search.c.

257{
258 unsigned int uid;
259 struct Email *e = NULL;
260 struct ImapMboxData *mdata = adata->mailbox->mdata;
261
262 mutt_debug(LL_DEBUG2, "Handling SEARCH\n");
263
264 while ((s = imap_next_word((char *) s)) && (*s != '\0'))
265 {
266 if (!mutt_str_atoui(s, &uid))
267 continue;
268 e = mutt_hash_int_find(mdata->uid_hash, uid);
269 if (e)
270 e->matched = true;
271 }
272}
mutt_hash_int_find
void * mutt_hash_int_find(const struct HashTable *table, unsigned int intkey)
Find the HashElem data in a Hash Table element using a key.
Definition: hash.c:392
Email::matched
bool matched
Search matches this Email.
Definition: email.h:102
+ Here is the call graph for this function:
+ Here is the caller graph for this function: