NeoMutt  2023-11-03-85-g512e01
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)
 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 (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
  • Brandon Long
  • Brendan Cully
  • Richard Russon
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 429 of file imap.c.

430{
431 char buf[2048], mbox[1024];
432
433 imap_munge_mbox_name(adata->unicode, mbox, sizeof(mbox), mailbox);
434 snprintf(buf, sizeof(buf), "CREATE %s", mbox);
435
436 if (imap_exec(adata, buf, IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS)
437 {
438 mutt_error(_("CREATE failed: %s"), imap_cmd_trailer(adata));
439 return -1;
440 }
441
442 return 0;
443}
mutt_error
#define mutt_error(...)
Definition: logging2.h:92
imap_cmd_trailer
const char * imap_cmd_trailer(struct ImapAccountData *adata)
Extra information after tagged command response if any.
Definition: command.c:1265
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:1302
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:919
_
#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 470 of file imap.c.

471{
472 char oldmbox[1024] = { 0 };
473 char newmbox[1024] = { 0 };
474 int rc = 0;
475
476 imap_munge_mbox_name(adata->unicode, oldmbox, sizeof(oldmbox), oldname);
477 imap_munge_mbox_name(adata->unicode, newmbox, sizeof(newmbox), newname);
478
479 struct Buffer *buf = buf_pool_get();
480 buf_printf(buf, "RENAME %s %s", oldmbox, newmbox);
481
482 if (imap_exec(adata, buf_string(buf), IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS)
483 rc = -1;
484
485 buf_pool_release(&buf);
486
487 return rc;
488}
buf_printf
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:173
buf_string
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:93
buf_pool_get
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
buf_pool_release
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
Buffer
String manipulation buffer.
Definition: buffer.h:34
+ 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 733 of file imap.c.

734{
735 if (mutt_socket_open(adata->conn) < 0)
736 return -1;
737
738 adata->state = IMAP_CONNECTED;
739
740 if (imap_cmd_step(adata) != IMAP_RES_OK)
741 {
742 imap_close_connection(adata);
743 return -1;
744 }
745
746 if (mutt_istr_startswith(adata->buf, "* OK"))
747 {
748 if (!mutt_istr_startswith(adata->buf, "* OK [CAPABILITY") && check_capabilities(adata))
749 {
750 goto bail;
751 }
752#ifdef USE_SSL
753 /* Attempt STARTTLS if available and desired. */
754 const bool c_ssl_force_tls = cs_subset_bool(NeoMutt->sub, "ssl_force_tls");
755 if ((adata->conn->ssf == 0) &&
756 (c_ssl_force_tls || (adata->capabilities & IMAP_CAP_STARTTLS)))
757 {
758 enum QuadOption ans;
759
760 if (c_ssl_force_tls)
761 {
762 ans = MUTT_YES;
763 }
764 else if ((ans = query_quadoption(_("Secure connection with TLS?"),
765 NeoMutt->sub, "ssl_starttls")) == MUTT_ABORT)
766 {
767 goto bail;
768 }
769 if (ans == MUTT_YES)
770 {
771 enum ImapExecResult rc = imap_exec(adata, "STARTTLS", IMAP_CMD_SINGLE);
772 // Clear any data after the STARTTLS acknowledgement
773 mutt_socket_empty(adata->conn);
774
775 if (rc == IMAP_EXEC_FATAL)
776 goto bail;
777 if (rc != IMAP_EXEC_ERROR)
778 {
779 if (mutt_ssl_starttls(adata->conn))
780 {
781 mutt_error(_("Could not negotiate TLS connection"));
782 goto bail;
783 }
784 else
785 {
786 /* RFC2595 demands we recheck CAPABILITY after TLS completes. */
787 if (imap_exec(adata, "CAPABILITY", IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS)
788 goto bail;
789 }
790 }
791 }
792 }
793
794 if (c_ssl_force_tls && (adata->conn->ssf == 0))
795 {
796 mutt_error(_("Encrypted connection unavailable"));
797 goto bail;
798 }
799#endif
800 }
801 else if (mutt_istr_startswith(adata->buf, "* PREAUTH"))
802 {
803#ifdef USE_SSL
804 /* Unless using a secure $tunnel, an unencrypted PREAUTH response may be a
805 * MITM attack. The only way to stop "STARTTLS" MITM attacks is via
806 * $ssl_force_tls: an attacker can easily spoof "* OK" and strip the
807 * STARTTLS capability. So consult $ssl_force_tls, not $ssl_starttls, to
808 * decide whether to abort. Note that if using $tunnel and
809 * $tunnel_is_secure, adata->conn->ssf will be set to 1. */
810 const bool c_ssl_force_tls = cs_subset_bool(NeoMutt->sub, "ssl_force_tls");
811 if ((adata->conn->ssf == 0) && c_ssl_force_tls)
812 {
813 mutt_error(_("Encrypted connection unavailable"));
814 goto bail;
815 }
816#endif
817
818 adata->state = IMAP_AUTHENTICATED;
819 if (check_capabilities(adata) != 0)
820 goto bail;
821 FREE(&adata->capstr);
822 }
823 else
824 {
825 imap_error("imap_open_connection()", adata->buf);
826 goto bail;
827 }
828
829 return 0;
830
831bail:
832 imap_close_connection(adata);
833 FREE(&adata->capstr);
834 return -1;
835}
cs_subset_bool
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
mutt_ssl_starttls
int mutt_ssl_starttls(struct Connection *conn)
Negotiate TLS over an already opened connection.
Definition: gnutls.c:1144
imap_cmd_step
int imap_cmd_step(struct ImapAccountData *adata)
Reads server responses from an IMAP command.
Definition: command.c:1127
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:655
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:841
check_capabilities
static int check_capabilities(struct ImapAccountData *adata)
Make sure we can log in to this server.
Definition: imap.c:99
FREE
#define FREE(x)
Definition: memory.h:45
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:240
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:369
mutt_socket_empty
void mutt_socket_empty(struct Connection *conn)
Clear out any queued data.
Definition: socket.c:320
mutt_socket_open
int mutt_socket_open(struct Connection *conn)
Simple wrapper.
Definition: socket.c:77
Connection::ssf
unsigned int ssf
Security strength factor, in bits (see notes)
Definition: connection.h:51
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:41
NeoMutt::sub
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
+ 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 841 of file imap.c.

842{
843 if (adata->state != IMAP_DISCONNECTED)
844 {
845 mutt_socket_close(adata->conn);
846 adata->state = IMAP_DISCONNECTED;
847 }
848 adata->seqno = 0;
849 adata->nextcmd = 0;
850 adata->lastcmd = 0;
851 adata->status = 0;
852 memset(adata->cmds, 0, sizeof(struct ImapCommand) * adata->cmdslots);
853}
mutt_socket_close
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:101
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 582 of file imap.c.

584{
585 char c;
586 bool r = false;
587 struct Buffer buf = { 0 }; // Do not allocate, maybe it won't be used
588
589 const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
590 if (c_debug_level >= IMAP_LOG_LTRL)
591 buf_alloc(&buf, bytes + 1);
592
593 mutt_debug(LL_DEBUG2, "reading %lu bytes\n", bytes);
594
595 for (unsigned long pos = 0; pos < bytes; pos++)
596 {
597 if (mutt_socket_readchar(adata->conn, &c) != 1)
598 {
599 mutt_debug(LL_DEBUG1, "error during read, %lu bytes read\n", pos);
600 adata->status = IMAP_FATAL;
601
602 buf_dealloc(&buf);
603 return -1;
604 }
605
606 if (r && (c != '\n'))
607 fputc('\r', fp);
608
609 if (c == '\r')
610 {
611 r = true;
612 continue;
613 }
614 else
615 {
616 r = false;
617 }
618
619 fputc(c, fp);
620
621 if ((pos % 1024) == 0)
622 progress_update(progress, pos, -1);
623 if (c_debug_level >= IMAP_LOG_LTRL)
624 buf_addch(&buf, c);
625 }
626
627 if (c_debug_level >= IMAP_LOG_LTRL)
628 {
629 mutt_debug(IMAP_LOG_LTRL, "\n%s", buf.data);
630 buf_dealloc(&buf);
631 }
632 return 0;
633}
buf_dealloc
void buf_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:389
buf_addch
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:253
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:349
cs_subset_number
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:144
mutt_debug
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
IMAP_LOG_LTRL
#define IMAP_LOG_LTRL
Definition: private.h:49
LL_DEBUG2
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.h:44
LL_DEBUG1
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
progress_update
bool progress_update(struct Progress *progress, size_t pos, int percent)
Update the state of the progress bar.
Definition: progress.c:81
mutt_socket_readchar
int mutt_socket_readchar(struct Connection *conn, char *c)
Simple read buffering to speed things up.
Definition: socket.c:214
Buffer::data
char * data
Pointer to data.
Definition: buffer.h:35
+ 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 661 of file imap.c.

662{
663 struct ImapAccountData *adata = imap_adata_get(m);
664 struct ImapMboxData *mdata = imap_mdata_get(m);
665 if (!adata || !mdata)
666 return;
667
668 struct Email *e = NULL;
669
670#ifdef USE_HCACHE
671 imap_hcache_open(adata, mdata);
672#endif
673
674 for (int i = 0; i < m->msg_count; i++)
675 {
676 e = m->emails[i];
677 if (!e)
678 break;
679
680 if (e->index == INT_MAX)
681 {
682 mutt_debug(LL_DEBUG2, "Expunging message UID %u\n", imap_edata_get(e)->uid);
683
684 e->deleted = true;
685
686 imap_cache_del(m, e);
687#ifdef USE_HCACHE
688 imap_hcache_del(mdata, imap_edata_get(e)->uid);
689#endif
690
691 mutt_hash_int_delete(mdata->uid_hash, imap_edata_get(e)->uid, e);
692
693 imap_edata_free((void **) &e->edata);
694 }
695 else
696 {
697 /* NeoMutt has several places where it turns off e->active as a
698 * hack. For example to avoid FLAG updates, or to exclude from
699 * imap_exec_msg_set.
700 *
701 * Unfortunately, when a reopen is allowed and the IMAP_EXPUNGE_PENDING
702 * flag becomes set (e.g. a flag update to a modified header),
703 * this function will be called by imap_cmd_finish().
704 *
705 * The ctx_update_tables() will free and remove these "inactive" headers,
706 * despite that an EXPUNGE was not received for them.
707 * This would result in memory leaks and segfaults due to dangling
708 * pointers in the msn_index and uid_hash.
709 *
710 * So this is another hack to work around the hacks. We don't want to
711 * remove the messages, so make sure active is on. */
712 e->active = true;
713 }
714 }
715
716#ifdef USE_HCACHE
717 imap_hcache_close(mdata);
718#endif
719
720 mailbox_changed(m, NT_MAILBOX_UPDATE);
721 if (resort)
722 {
723 mailbox_changed(m, NT_MAILBOX_RESORT);
724 }
725}
imap_edata_free
void imap_edata_free(void **ptr)
Free the private Email data - Implements Email::edata_free() -.
Definition: edata.c:39
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:66
imap_mdata_get
struct ImapMboxData * imap_mdata_get(struct Mailbox *m)
Get the Mailbox data for this mailbox.
Definition: mdata.c:60
imap_cache_del
int imap_cache_del(struct Mailbox *m, struct Email *e)
Delete an email from the body cache.
Definition: message.c:1858
imap_hcache_close
void imap_hcache_close(struct ImapMboxData *mdata)
Close the header cache.
Definition: util.c:338
imap_hcache_del
int imap_hcache_del(struct ImapMboxData *mdata, unsigned int uid)
Delete an item from the header cache.
Definition: util.c:396
imap_hcache_open
void imap_hcache_open(struct ImapAccountData *adata, struct ImapMboxData *mdata)
Open a header cache.
Definition: util.c:297
mailbox_changed
void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
Notify observers of a change to a Mailbox.
Definition: mailbox.c:226
NT_MAILBOX_RESORT
@ NT_MAILBOX_RESORT
Email list needs resorting.
Definition: mailbox.h:177
NT_MAILBOX_UPDATE
@ NT_MAILBOX_UPDATE
Update internal tables.
Definition: mailbox.h:178
Account::adata
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
Email
The envelope/body of an email.
Definition: email.h:37
Email::edata
void * edata
Driver-specific data.
Definition: email.h:72
Email::active
bool active
Message is not to be removed.
Definition: email.h:74
Email::deleted
bool deleted
Email is deleted.
Definition: email.h:76
Email::index
int index
The absolute (unsorted) message number.
Definition: email.h:111
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:131
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 1764 of file imap.c.

1765{
1766 if (!adata)
1767 return -1;
1768
1769 if (adata->state == IMAP_DISCONNECTED)
1770 {
1771 buf_reset(&adata->cmdbuf); // purge outstanding queued commands
1772 imap_open_connection(adata);
1773 }
1774 if (adata->state == IMAP_CONNECTED)
1775 {
1776 if (imap_authenticate(adata) == IMAP_AUTH_SUCCESS)
1777 {
1778 adata->state = IMAP_AUTHENTICATED;
1779 FREE(&adata->capstr);
1780 if (adata->conn->ssf != 0)
1781 {
1782 mutt_debug(LL_DEBUG2, "Communication encrypted at %d bits\n",
1783 adata->conn->ssf);
1784 }
1785 }
1786 else
1787 {
1788 mutt_account_unsetpass(&adata->conn->account);
1789 }
1790 }
1791 if (adata->state == IMAP_AUTHENTICATED)
1792 {
1793 /* capabilities may have changed */
1794 imap_exec(adata, "CAPABILITY", IMAP_CMD_PASS);
1795
1796#ifdef USE_ZLIB
1797 /* RFC4978 */
1798 const bool c_imap_deflate = cs_subset_bool(NeoMutt->sub, "imap_deflate");
1799 if ((adata->capabilities & IMAP_CAP_COMPRESS) && c_imap_deflate &&
1800 (imap_exec(adata, "COMPRESS DEFLATE", IMAP_CMD_PASS) == IMAP_EXEC_SUCCESS))
1801 {
1802 mutt_debug(LL_DEBUG2, "IMAP compression is enabled on connection to %s\n",
1803 adata->conn->account.host);
1804 mutt_zstrm_wrap_conn(adata->conn);
1805 }
1806#endif
1807
1808 /* enable RFC2971, if the server supports that */
1809 const bool c_imap_send_id = cs_subset_bool(NeoMutt->sub, "imap_send_id");
1810 if (c_imap_send_id && (adata->capabilities & IMAP_CAP_ID))
1811 {
1812 imap_exec(adata, "ID (\"name\" \"NeoMutt\" \"version\" \"" PACKAGE_VERSION "\")",
1813 IMAP_CMD_QUEUE);
1814 }
1815
1816 /* enable RFC6855, if the server supports that */
1817 const bool c_imap_rfc5161 = cs_subset_bool(NeoMutt->sub, "imap_rfc5161");
1818 if (c_imap_rfc5161 && (adata->capabilities & IMAP_CAP_ENABLE))
1819 imap_exec(adata, "ENABLE UTF8=ACCEPT", IMAP_CMD_QUEUE);
1820
1821 /* enable QRESYNC. Advertising QRESYNC also means CONDSTORE
1822 * is supported (even if not advertised), so flip that bit. */
1823 if (adata->capabilities & IMAP_CAP_QRESYNC)
1824 {
1825 adata->capabilities |= IMAP_CAP_CONDSTORE;
1826 const bool c_imap_qresync = cs_subset_bool(NeoMutt->sub, "imap_qresync");
1827 if (c_imap_rfc5161 && c_imap_qresync)
1828 imap_exec(adata, "ENABLE QRESYNC", IMAP_CMD_QUEUE);
1829 }
1830
1831 /* get root delimiter, '/' as default */
1832 adata->delim = '/';
1833 imap_exec(adata, "LIST \"\" \"\"", IMAP_CMD_QUEUE);
1834
1835 /* we may need the root delimiter before we open a mailbox */
1836 imap_exec(adata, NULL, IMAP_CMD_NO_FLAGS);
1837
1838 /* select the mailbox that used to be open before disconnect */
1839 if (adata->mailbox)
1840 {
1841 imap_mbox_select(adata->mailbox);
1842 }
1843 }
1844
1845 if (adata->state < IMAP_AUTHENTICATED)
1846 return -1;
1847
1848 return 0;
1849}
IMAP_AUTH_SUCCESS
@ IMAP_AUTH_SUCCESS
Authentication successful.
Definition: auth.h:39
buf_reset
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:88
mutt_account_unsetpass
void mutt_account_unsetpass(struct ConnAccount *cac)
Unset ConnAccount's password.
Definition: connaccount.c:176
imap_authenticate
int imap_authenticate(struct ImapAccountData *adata)
Authenticate to an IMAP server.
Definition: auth.c:112
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:733
imap_mbox_select
static void imap_mbox_select(struct Mailbox *m)
Select a Mailbox.
Definition: imap.c:1731
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:50
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:288
+ 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 918 of file imap.c.

920{
921 struct ImapAccountData *adata = imap_adata_get(m);
922 if (!adata || (adata->mailbox != m))
923 return -1;
924
925 char flags[1024] = { 0 };
926 char *tags = NULL;
927 char uid[11] = { 0 };
928
929 if (!compare_flags_for_copy(e))
930 {
931 if (e->deleted == imap_edata_get(e)->deleted)
932 e->changed = false;
933 return 0;
934 }
935
936 snprintf(uid, sizeof(uid), "%u", imap_edata_get(e)->uid);
937 buf_reset(cmd);
938 buf_addstr(cmd, "UID STORE ");
939 buf_addstr(cmd, uid);
940
941 flags[0] = '\0';
942
943 set_flag(m, MUTT_ACL_SEEN, e->read, "\\Seen ", flags, sizeof(flags));
944 set_flag(m, MUTT_ACL_WRITE, e->old, "Old ", flags, sizeof(flags));
945 set_flag(m, MUTT_ACL_WRITE, e->flagged, "\\Flagged ", flags, sizeof(flags));
946 set_flag(m, MUTT_ACL_WRITE, e->replied, "\\Answered ", flags, sizeof(flags));
947 set_flag(m, MUTT_ACL_DELETE, imap_edata_get(e)->deleted, "\\Deleted ", flags,
948 sizeof(flags));
949
950 if (m->rights & MUTT_ACL_WRITE)
951 {
952 /* restore system flags */
953 if (imap_edata_get(e)->flags_system)
954 mutt_str_cat(flags, sizeof(flags), imap_edata_get(e)->flags_system);
955 /* set custom flags */
956 tags = driver_tags_get_with_hidden(&e->tags);
957 if (tags)
958 {
959 mutt_str_cat(flags, sizeof(flags), tags);
960 FREE(&tags);
961 }
962 }
963
964 mutt_str_remove_trailing_ws(flags);
965
966 /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
967 * explicitly revoke all system flags (if we have permission) */
968 if (*flags == '\0')
969 {
970 set_flag(m, MUTT_ACL_SEEN, true, "\\Seen ", flags, sizeof(flags));
971 set_flag(m, MUTT_ACL_WRITE, true, "Old ", flags, sizeof(flags));
972 set_flag(m, MUTT_ACL_WRITE, true, "\\Flagged ", flags, sizeof(flags));
973 set_flag(m, MUTT_ACL_WRITE, true, "\\Answered ", flags, sizeof(flags));
974 set_flag(m, MUTT_ACL_DELETE, !imap_edata_get(e)->deleted, "\\Deleted ",
975 flags, sizeof(flags));
976
977 /* erase custom flags */
978 if ((m->rights & MUTT_ACL_WRITE) && imap_edata_get(e)->flags_remote)
979 mutt_str_cat(flags, sizeof(flags), imap_edata_get(e)->flags_remote);
980
981 mutt_str_remove_trailing_ws(flags);
982
983 buf_addstr(cmd, " -FLAGS.SILENT (");
984 }
985 else
986 {
987 buf_addstr(cmd, " FLAGS.SILENT (");
988 }
989
990 buf_addstr(cmd, flags);
991 buf_addstr(cmd, ")");
992
993 /* after all this it's still possible to have no flags, if you
994 * have no ACL rights */
995 if (*flags && (imap_exec(adata, cmd->data, IMAP_CMD_NO_FLAGS) != IMAP_EXEC_SUCCESS) &&
996 err_continue && (*err_continue != MUTT_YES))
997 {
998 *err_continue = imap_continue("imap_sync_message: STORE failed", adata->buf);
999 if (*err_continue != MUTT_YES)
1000 return -1;
1001 }
1002
1003 /* server have now the updated flags */
1004 FREE(&imap_edata_get(e)->flags_remote);
1005 imap_edata_get(e)->flags_remote = driver_tags_get_with_hidden(&e->tags);
1006
1007 if (e->deleted == imap_edata_get(e)->deleted)
1008 e->changed = false;
1009
1010 return 0;
1011}
buf_addstr
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:238
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:644
set_flag
static void set_flag(struct Mailbox *m, AclFlags aclflag, bool flag, const char *str, char *flags, size_t flsize)
Append str to flags if we currently have permission according to aclflag.
Definition: imap.c:180
compare_flags_for_copy
static bool compare_flags_for_copy(struct Email *e)
Compare local flags against the server.
Definition: imap.c:196
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
mutt_str_remove_trailing_ws
void mutt_str_remove_trailing_ws(char *s)
Trim trailing whitespace from a string.
Definition: string.c:637
mutt_str_cat
char * mutt_str_cat(char *buf, size_t buflen, const char *s)
Concatenate two strings.
Definition: string.c:266
Email::read
bool read
Email is read.
Definition: email.h:48
Email::old
bool old
Email is seen, but unread.
Definition: email.h:47
Email::changed
bool changed
Email has been edited.
Definition: email.h:75
Email::flagged
bool flagged
Marked important?
Definition: email.h:45
Email::replied
bool replied
Email has been replied to.
Definition: email.h:49
Email::tags
struct TagList tags
For drivers that support server tagging.
Definition: email.h:70
ImapEmailData::flags_remote
char * flags_remote
Definition: edata.h:48
Mailbox::rights
AclFlags rights
ACL bits, see AclFlags.
Definition: mailbox.h:118
driver_tags_get_with_hidden
char * driver_tags_get_with_hidden(struct TagList *list)
Get tags with hiddens.
Definition: tags.c:158
+ Here is the call graph for this function:
+ 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 866 of file imap.c.

867{
868 if (STAILQ_EMPTY(flag_list))
869 return false;
870
871 const size_t flaglen = mutt_str_len(flag);
872 struct ListNode *np = NULL;
873 STAILQ_FOREACH(np, flag_list, entries)
874 {
875 const size_t nplen = strlen(np->data);
876 if ((flaglen >= nplen) && ((flag[nplen] == '\0') || (flag[nplen] == ' ')) &&
877 mutt_istrn_equal(np->data, flag, nplen))
878 {
879 return true;
880 }
881
882 if (mutt_str_equal(np->data, "\\*"))
883 return true;
884 }
885
886 return false;
887}
mutt_str_equal
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:798
mutt_str_len
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:568
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:525
STAILQ_FOREACH
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
STAILQ_EMPTY
#define STAILQ_EMPTY(head)
Definition: queue.h:348
ListNode
A List node for strings.
Definition: list.h:35
ListNode::data
char * data
String.
Definition: list.h:36
+ 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 71 of file util.c.

73{
74 struct ConnAccount cac = { { 0 } };
75 struct ImapAccountData *tmp_adata = NULL;
76 char tmp[1024] = { 0 };
77
78 if (imap_parse_path(path, &cac, tmp, sizeof(tmp)) < 0)
79 return -1;
80
81 struct Account *np = NULL;
82 TAILQ_FOREACH(np, &NeoMutt->accounts, entries)
83 {
84 if (np->type != MUTT_IMAP)
85 continue;
86
87 tmp_adata = np->adata;
88 if (!tmp_adata)
89 continue;
90 if (imap_account_match(&tmp_adata->conn->account, &cac))
91 {
92 *mdata = imap_mdata_new(tmp_adata, tmp);
93 *adata = tmp_adata;
94 return 0;
95 }
96 }
97 mutt_debug(LL_DEBUG3, "no ImapAccountData found\n");
98 return -1;
99}
imap_mdata_new
struct ImapMboxData * imap_mdata_new(struct ImapAccountData *adata, const char *name)
Allocate and initialise a new ImapMboxData structure.
Definition: mdata.c:73
LL_DEBUG3
@ LL_DEBUG3
Log at debug level 3.
Definition: logging2.h:45
MUTT_IMAP
@ MUTT_IMAP
'IMAP' Mailbox type
Definition: mailbox.h:50
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:725
Account
A group of associated Mailboxes.
Definition: account.h:37
Account::type
enum MailboxType type
Type of Mailboxes this Account contains.
Definition: account.h:38
ConnAccount
Login details for a remote server.
Definition: connaccount.h:53
NeoMutt::accounts
struct AccountList accounts
List of all Accounts.
Definition: neomutt.h:46
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:472
imap_account_match
bool imap_account_match(const struct ConnAccount *a1, const struct ConnAccount *a2)
Compare two Accounts.
Definition: util.c:1052
+ 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 112 of file auth.c.

113{
114 int rc = IMAP_AUTH_FAILURE;
115
116 const struct Slist *c_imap_authenticators = cs_subset_slist(NeoMutt->sub, "imap_authenticators");
117 if (c_imap_authenticators && (c_imap_authenticators->count > 0))
118 {
119 mutt_debug(LL_DEBUG2, "Trying user-defined imap_authenticators\n");
120
121 /* Try user-specified list of authentication methods */
122 struct ListNode *np = NULL;
123 STAILQ_FOREACH(np, &c_imap_authenticators->head, entries)
124 {
125 mutt_debug(LL_DEBUG2, "Trying method %s\n", np->data);
126
127 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
128 {
129 const struct ImapAuth *auth = &ImapAuthenticators[i];
130 if (!auth->method || mutt_istr_equal(auth->method, np->data))
131 {
132 rc = auth->authenticate(adata, np->data);
133 if (rc == IMAP_AUTH_SUCCESS)
134 {
135 return rc;
136 }
137 }
138 }
139 }
140 }
141 else
142 {
143 /* Fall back to default: any authenticator */
144 mutt_debug(LL_DEBUG2, "Trying pre-defined imap_authenticators\n");
145
146 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
147 {
148 rc = ImapAuthenticators[i].authenticate(adata, NULL);
149 if (rc == IMAP_AUTH_SUCCESS)
150 return rc;
151 }
152 }
153
154 mutt_error(_("No authenticators available or wrong credentials"));
155 return rc;
156}
IMAP_AUTH_FAILURE
@ IMAP_AUTH_FAILURE
Authentication failed.
Definition: auth.h:40
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:243
ImapAuthenticators
static const struct ImapAuth ImapAuthenticators[]
Accepted authentication methods.
Definition: auth.c:61
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:810
ImapAuth
IMAP authentication multiplexor.
Definition: auth.c:43
ImapAuth::authenticate
enum ImapAuthRes(* authenticate)(struct ImapAccountData *adata, const char *method)
Definition: auth.c:52
ImapAuth::method
const char * method
Name of authentication method supported, NULL means variable.
Definition: auth.c:54
Slist
String list.
Definition: slist.h:47
Slist::head
struct ListHead head
List containing values.
Definition: slist.h:48
Slist::count
size_t count
Number of values in list.
Definition: slist.h:49
+ 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 1113 of file command.c.

1114{
1115 return cmd_start(adata, cmdstr, IMAP_CMD_NO_FLAGS);
1116}
cmd_start
static int cmd_start(struct ImapAccountData *adata, const char *cmdstr, ImapCmdFlags flags)
Start a new IMAP command.
Definition: command.c:199
+ 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 1127 of file command.c.

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

1368{
1369 if (!adata)
1370 return;
1371
1372 if (adata->status == IMAP_FATAL)
1373 {
1374 adata->closing = false;
1375 cmd_handle_fatal(adata);
1376 return;
1377 }
1378
1379 if (!(adata->state >= IMAP_SELECTED) || (adata->mailbox && adata->closing))
1380 {
1381 adata->closing = false;
1382 return;
1383 }
1384
1385 adata->closing = false;
1386
1387 struct ImapMboxData *mdata = imap_mdata_get(adata->mailbox);
1388
1389 if (mdata && mdata->reopen & IMAP_REOPEN_ALLOW)
1390 {
1391 // First remove expunged emails from the msn_index
1392 if (mdata->reopen & IMAP_EXPUNGE_PENDING)
1393 {
1394 mutt_debug(LL_DEBUG2, "Expunging mailbox\n");
1395 imap_expunge_mailbox(adata->mailbox, true);
1396 /* Detect whether we've gotten unexpected EXPUNGE messages */
1397 if (!(mdata->reopen & IMAP_EXPUNGE_EXPECTED))
1398 mdata->check_status |= IMAP_EXPUNGE_PENDING;
1399 mdata->reopen &= ~(IMAP_EXPUNGE_PENDING | IMAP_EXPUNGE_EXPECTED);
1400 }
1401
1402 // Then add new emails to it
1403 if (mdata->reopen & IMAP_NEWMAIL_PENDING)
1404 {
1405 const size_t max_msn = imap_msn_highest(&mdata->msn);
1406 if (mdata->new_mail_count > max_msn)
1407 {
1408 if (!(mdata->reopen & IMAP_EXPUNGE_PENDING))
1409 mdata->check_status |= IMAP_NEWMAIL_PENDING;
1410
1411 mutt_debug(LL_DEBUG2, "Fetching new mails from %zd to %u\n",
1412 max_msn + 1, mdata->new_mail_count);
1413 imap_read_headers(adata->mailbox, max_msn + 1, mdata->new_mail_count, false);
1414 }
1415 }
1416
1417 // And to finish inform about MUTT_REOPEN if needed
1418 if (mdata->reopen & IMAP_EXPUNGE_PENDING && !(mdata->reopen & IMAP_EXPUNGE_EXPECTED))
1419 mdata->check_status |= IMAP_EXPUNGE_PENDING;
1420
1421 if (mdata->reopen & IMAP_EXPUNGE_PENDING)
1422 mdata->reopen &= ~(IMAP_EXPUNGE_PENDING | IMAP_EXPUNGE_EXPECTED);
1423 }
1424
1425 adata->status = 0;
1426}
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:1331
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:661
imap_msn_highest
size_t imap_msn_highest(const struct MSNArray *msn)
Return the highest MSN in use.
Definition: msn.c:69
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 1254 of file command.c.

1255{
1256 return cmd_status(s) == IMAP_RES_OK;
1257}
+ 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 1265 of file command.c.

1266{
1267 static const char *notrailer = "";
1268 const char *s = adata->buf;
1269
1270 if (!s)
1271 {
1272 mutt_debug(LL_DEBUG2, "not a tagged response\n");
1273 return notrailer;
1274 }
1275
1276 s = imap_next_word((char *) s);
1277 if (!s || (!mutt_istr_startswith(s, "OK") && !mutt_istr_startswith(s, "NO") &&
1278 !mutt_istr_startswith(s, "BAD")))
1279 {
1280 mutt_debug(LL_DEBUG2, "not a command completion: %s\n", adata->buf);
1281 return notrailer;
1282 }
1283
1284 s = imap_next_word((char *) s);
1285 if (!s)
1286 return notrailer;
1287
1288 return s;
1289}
+ 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 1302 of file command.c.

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

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

1333{
1334 unsigned int maxuid = 0;
1335 int rc = -1;
1336 bool evalhc = false;
1337
1338#ifdef USE_HCACHE
1339 uint32_t uidvalidity = 0;
1340 unsigned int uid_next = 0;
1341 unsigned long long modseq = 0;
1342 bool has_condstore = false;
1343 bool has_qresync = false;
1344 bool eval_condstore = false;
1345 bool eval_qresync = false;
1346 char *uid_seqset = NULL;
1347 const unsigned int msn_begin_save = msn_begin;
1348#endif /* USE_HCACHE */
1349
1350 struct ImapAccountData *adata = imap_adata_get(m);
1351 struct ImapMboxData *mdata = imap_mdata_get(m);
1352 if (!adata || (adata->mailbox != m))
1353 return -1;
1354
1355#ifdef USE_HCACHE
1356retry:
1357#endif /* USE_HCACHE */
1358
1359 /* make sure context has room to hold the mailbox */
1360 mx_alloc_memory(m, msn_end);
1361 imap_msn_reserve(&mdata->msn, msn_end);
1362 imap_alloc_uid_hash(adata, msn_end);
1363
1364 mdata->reopen &= ~(IMAP_REOPEN_ALLOW | IMAP_NEWMAIL_PENDING);
1365 mdata->new_mail_count = 0;
1366
1367#ifdef USE_HCACHE
1368 imap_hcache_open(adata, mdata);
1369
1370 if (mdata->hcache && initial_download)
1371 {
1372 hcache_fetch_obj(mdata->hcache, "/UIDVALIDITY", 12, &uidvalidity);
1373 hcache_fetch_obj(mdata->hcache, "/UIDNEXT", 8, &uid_next);
1374 if (mdata->modseq)
1375 {
1376 const bool c_imap_condstore = cs_subset_bool(NeoMutt->sub, "imap_condstore");
1377 if ((adata->capabilities & IMAP_CAP_CONDSTORE) && c_imap_condstore)
1378 has_condstore = true;
1379
1380 /* If IMAP_CAP_QRESYNC and ImapQResync then NeoMutt sends ENABLE QRESYNC.
1381 * If we receive an ENABLED response back, then adata->qresync is set. */
1382 if (adata->qresync)
1383 has_qresync = true;
1384 }
1385
1386 if (uidvalidity && uid_next && uidvalidity == mdata->uidvalidity)
1387 {
1388 evalhc = true;
1389 if (hcache_fetch_obj(mdata->hcache, "/MODSEQ", 7, &modseq))
1390 {
1391 if (has_qresync)
1392 {
1393 uid_seqset = imap_hcache_get_uid_seqset(mdata);
1394 if (uid_seqset)
1395 eval_qresync = true;
1396 }
1397
1398 if (!eval_qresync && has_condstore)
1399 eval_condstore = true;
1400 }
1401 }
1402 }
1403 if (evalhc)
1404 {
1405 if (eval_qresync)
1406 {
1407 if (read_headers_qresync_eval_cache(adata, uid_seqset) < 0)
1408 goto bail;
1409 }
1410 else
1411 {
1412 if (read_headers_normal_eval_cache(adata, msn_end, uid_next, has_condstore || has_qresync,
1413 eval_condstore) < 0)
1414 goto bail;
1415 }
1416
1417 if ((eval_condstore || eval_qresync) && (modseq != mdata->modseq))
1418 {
1419 if (read_headers_condstore_qresync_updates(adata, msn_end, uid_next,
1420 modseq, eval_qresync) < 0)
1421 {
1422 goto bail;
1423 }
1424 }
1425
1426 /* Look for the first empty MSN and start there */
1427 while (msn_begin <= msn_end)
1428 {
1429 if (!imap_msn_get(&mdata->msn, msn_begin - 1))
1430 break;
1431 msn_begin++;
1432 }
1433 }
1434#endif /* USE_HCACHE */
1435
1436 if (read_headers_fetch_new(m, msn_begin, msn_end, evalhc, &maxuid, initial_download) < 0)
1437 goto bail;
1438
1439#ifdef USE_HCACHE
1440 if (eval_qresync && initial_download)
1441 {
1442 if (imap_verify_qresync(m) != 0)
1443 {
1444 eval_qresync = false;
1445 eval_condstore = false;
1446 evalhc = false;
1447 modseq = 0;
1448 maxuid = 0;
1449 FREE(&uid_seqset);
1450 uidvalidity = 0;
1451 uid_next = 0;
1452 msn_begin = msn_begin_save;
1453
1454 goto retry;
1455 }
1456 }
1457#endif /* USE_HCACHE */
1458
1459 if (maxuid && (mdata->uid_next < maxuid + 1))
1460 mdata->uid_next = maxuid + 1;
1461
1462#ifdef USE_HCACHE
1463 hcache_store_raw(mdata->hcache, "/UIDVALIDITY", 12, &mdata->uidvalidity,
1464 sizeof(mdata->uidvalidity));
1465 if (maxuid && (mdata->uid_next < maxuid + 1))
1466 {
1467 mutt_debug(LL_DEBUG2, "Overriding UIDNEXT: %u -> %u\n", mdata->uid_next, maxuid + 1);
1468 mdata->uid_next = maxuid + 1;
1469 }
1470 if (mdata->uid_next > 1)
1471 {
1472 hcache_store_raw(mdata->hcache, "/UIDNEXT", 8, &mdata->uid_next,
1473 sizeof(mdata->uid_next));
1474 }
1475
1476 /* We currently only sync CONDSTORE and QRESYNC on the initial download.
1477 * To do it more often, we'll need to deal with flag updates combined with
1478 * unsync'ed local flag changes. We'll also need to properly sync flags to
1479 * the header cache on close. I'm not sure it's worth the added complexity. */
1480 if (initial_download)
1481 {
1482 if (has_condstore || has_qresync)
1483 {
1484 hcache_store_raw(mdata->hcache, "/MODSEQ", 7, &mdata->modseq, sizeof(mdata->modseq));
1485 }
1486 else
1487 {
1488 hcache_delete_record(mdata->hcache, "/MODSEQ", 7);
1489 }
1490
1491 if (has_qresync)
1492 imap_hcache_store_uid_seqset(mdata);
1493 else
1494 imap_hcache_clear_uid_seqset(mdata);
1495 }
1496#endif /* USE_HCACHE */
1497
1498 /* TODO: it's not clear to me why we are calling mx_alloc_memory yet again. */
1499 mx_alloc_memory(m, m->msg_count);
1500
1501 mdata->reopen |= IMAP_REOPEN_ALLOW;
1502
1503 rc = msn_end;
1504
1505bail:
1506#ifdef USE_HCACHE
1507 imap_hcache_close(mdata);
1508 FREE(&uid_seqset);
1509#endif /* USE_HCACHE */
1510
1511 return rc;
1512}
hcache_fetch_obj
#define hcache_fetch_obj(hc, key, keylen, dst)
Definition: lib.h:164
hcache_delete_record
int hcache_delete_record(struct HeaderCache *hc, const char *key, size_t keylen)
Multiplexor for StoreOps::delete_record.
Definition: hcache.c:760
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:742
imap_verify_qresync
static int imap_verify_qresync(struct Mailbox *m)
Check to see if QRESYNC got jumbled.
Definition: message.c:1004
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:905
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:1081
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:674
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:819
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:518
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:413
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:448
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:434
imap_msn_get
struct Email * imap_msn_get(const struct MSNArray *msn, size_t idx)
Return the Email associated with an msn.
Definition: msn.c:80
imap_msn_reserve
void imap_msn_reserve(struct MSNArray *msn, size_t num)
Create / reallocate the cache.
Definition: msn.c:41
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 1909 of file message.c.

1910{
1911 struct ImapAccountData *adata = imap_adata_get(m);
1912 if (!adata || (adata->mailbox != m))
1913 return NULL;
1914
1915 struct ImapHeader newh = { 0 };
1916 struct ImapEmailData old_edata = { 0 };
1917 int local_changes = e->changed;
1918
1919 struct ImapEmailData *edata = e->edata;
1920 newh.edata = edata;
1921
1922 mutt_debug(LL_DEBUG2, "parsing FLAGS\n");
1923 s = msg_parse_flags(&newh, s);
1924 if (!s)
1925 return NULL;
1926
1927 /* Update tags system */
1928 /* We take a copy of the tags so we can split the string */
1929 char *tags_copy = mutt_str_dup(edata->flags_remote);
1930 driver_tags_replace(&e->tags, tags_copy);
1931 FREE(&tags_copy);
1932
1933 /* YAUH (yet another ugly hack): temporarily set context to
1934 * read-write even if it's read-only, so *server* updates of
1935 * flags can be processed by mutt_set_flag. mailbox->changed must
1936 * be restored afterwards */
1937 bool readonly = m->readonly;
1938 m->readonly = false;
1939
1940 /* This is redundant with the following two checks. Removing:
1941 * mutt_set_flag (m, e, MUTT_NEW, !(edata->read || edata->old), true); */
1942 set_changed_flag(m, e, local_changes, server_changes, MUTT_OLD, old_edata.old,
1943 edata->old, e->old);
1944 set_changed_flag(m, e, local_changes, server_changes, MUTT_READ,
1945 old_edata.read, edata->read, e->read);
1946 set_changed_flag(m, e, local_changes, server_changes, MUTT_DELETE,
1947 old_edata.deleted, edata->deleted, e->deleted);
1948 set_changed_flag(m, e, local_changes, server_changes, MUTT_FLAG,
1949 old_edata.flagged, edata->flagged, e->flagged);
1950 set_changed_flag(m, e, local_changes, server_changes, MUTT_REPLIED,
1951 old_edata.replied, edata->replied, e->replied);
1952
1953 /* this message is now definitively *not* changed (mutt_set_flag
1954 * marks things changed as a side-effect) */
1955 if (local_changes == 0)
1956 e->changed = false;
1957 m->changed &= !readonly;
1958 m->readonly = readonly;
1959
1960 return s;
1961}
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:634
msg_parse_flags
static char * msg_parse_flags(struct ImapHeader *h, char *s)
Read a FLAGS token into an ImapHeader.
Definition: message.c:189
mutt_str_dup
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:251
MUTT_READ
@ MUTT_READ
Messages that have been read.
Definition: mutt.h:72
MUTT_OLD
@ MUTT_OLD
Old messages.
Definition: mutt.h:70
MUTT_FLAG
@ MUTT_FLAG
Flagged messages.
Definition: mutt.h:78
MUTT_DELETE
@ MUTT_DELETE
Messages to be deleted.
Definition: mutt.h:74
MUTT_REPLIED
@ MUTT_REPLIED
Messages that have been replied to.
Definition: mutt.h:71
ImapEmailData
IMAP-specific Email data -.
Definition: edata.h:34
ImapEmailData::deleted
bool deleted
Email has been deleted.
Definition: edata.h:38
ImapEmailData::old
bool old
Email has been seen.
Definition: edata.h:37
ImapEmailData::read
bool read
Email has been read.
Definition: edata.h:36
ImapEmailData::flagged
bool flagged
Email has been flagged.
Definition: edata.h:39
ImapEmailData::replied
bool replied
Email has been replied to.
Definition: edata.h:40
ImapHeader
IMAP-specific header.
Definition: message.h:33
ImapHeader::edata
struct ImapEmailData * edata
Definition: message.h:34
Mailbox::changed
bool changed
Mailbox has been modified.
Definition: mailbox.h:109
Mailbox::readonly
bool readonly
Don't allow changes to the mailbox.
Definition: mailbox.h:115
driver_tags_replace
bool driver_tags_replace(struct TagList *head, const char *tags)
Replace all tags.
Definition: tags.c:186
+ 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 1858 of file message.c.

1859{
1860 struct ImapAccountData *adata = imap_adata_get(m);
1861 struct ImapMboxData *mdata = imap_mdata_get(m);
1862
1863 if (!e || !adata || (adata->mailbox != m))
1864 return -1;
1865
1866 mdata->bcache = imap_bcache_open(m);
1867 char id[64] = { 0 };
1868 snprintf(id, sizeof(id), "%u-%u", mdata->uidvalidity, imap_edata_get(e)->uid);
1869 return mutt_bcache_del(mdata->bcache, id);
1870}
mutt_bcache_del
int mutt_bcache_del(struct BodyCache *bcache, const char *id)
Delete a file from the Body Cache.
Definition: bcache.c:266
imap_bcache_open
static struct BodyCache * imap_bcache_open(struct Mailbox *m)
Open a message cache.
Definition: message.c:78
+ 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 1877 of file message.c.

1878{
1879 struct ImapAccountData *adata = imap_adata_get(m);
1880 struct ImapMboxData *mdata = imap_mdata_get(m);
1881
1882 if (!adata || (adata->mailbox != m))
1883 return -1;
1884
1885 mdata->bcache = imap_bcache_open(m);
1886 mutt_bcache_list(mdata->bcache, imap_bcache_delete, mdata);
1887
1888 return 0;
1889}
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:331
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:166
+ 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 1521 of file message.c.

1522{
1523 if (!m || !msg)
1524 return -1;
1525
1526 FILE *fp = NULL;
1527 char buf[2048];
1528 char internaldate[IMAP_DATELEN] = { 0 };
1529 char imap_flags[128] = { 0 };
1530 size_t len;
1531 struct Progress *progress = NULL;
1532 size_t sent;
1533 int c, last;
1534 int rc;
1535
1536 struct ImapAccountData *adata = imap_adata_get(m);
1537 struct ImapMboxData *mdata = imap_mdata_get(m);
1538
1539 fp = fopen(msg->path, "r");
1540 if (!fp)
1541 {
1542 mutt_perror("%s", msg->path);
1543 goto fail;
1544 }
1545
1546 /* currently we set the \Seen flag on all messages, but probably we
1547 * should scan the message Status header for flag info. Since we're
1548 * already rereading the whole file for length it isn't any more
1549 * expensive (it'd be nice if we had the file size passed in already
1550 * by the code that writes the file, but that's a lot of changes.
1551 * Ideally we'd have an Email structure with flag info here... */
1552 for (last = EOF, len = 0; (c = fgetc(fp)) != EOF; last = c)
1553 {
1554 if ((c == '\n') && (last != '\r'))
1555 len++;
1556
1557 len++;
1558 }
1559 rewind(fp);
1560
1561 if (m->verbose)
1562 {
1563 progress = progress_new(MUTT_PROGRESS_NET, len);
1564 progress_set_message(progress, _("Uploading message..."));
1565 }
1566
1567 mutt_date_make_imap(internaldate, sizeof(internaldate), msg->received);
1568
1569 imap_flags[0] = '\0';
1570 imap_flags[1] = '\0';
1571
1572 if (msg->flags.read)
1573 mutt_str_cat(imap_flags, sizeof(imap_flags), " \\Seen");
1574 if (msg->flags.replied)
1575 mutt_str_cat(imap_flags, sizeof(imap_flags), " \\Answered");
1576 if (msg->flags.flagged)
1577 mutt_str_cat(imap_flags, sizeof(imap_flags), " \\Flagged");
1578 if (msg->flags.draft)
1579 mutt_str_cat(imap_flags, sizeof(imap_flags), " \\Draft");
1580
1581 snprintf(buf, sizeof(buf), "APPEND %s (%s) \"%s\" {%lu}", mdata->munge_name,
1582 imap_flags + 1, internaldate, (unsigned long) len);
1583
1584 imap_cmd_start(adata, buf);
1585
1586 do
1587 {
1588 rc = imap_cmd_step(adata);
1589 } while (rc == IMAP_RES_CONTINUE);
1590
1591 if (rc != IMAP_RES_RESPOND)
1592 goto cmd_step_fail;
1593
1594 for (last = EOF, sent = len = 0; (c = fgetc(fp)) != EOF; last = c)
1595 {
1596 if ((c == '\n') && (last != '\r'))
1597 buf[len++] = '\r';
1598
1599 buf[len++] = c;
1600
1601 if (len > sizeof(buf) - 3)
1602 {
1603 sent += len;
1604 if (flush_buffer(buf, &len, adata->conn) < 0)
1605 goto fail;
1606 progress_update(progress, sent, -1);
1607 }
1608 }
1609
1610 if (len)
1611 if (flush_buffer(buf, &len, adata->conn) < 0)
1612 goto fail;
1613
1614 if (mutt_socket_send(adata->conn, "\r\n") < 0)
1615 goto fail;
1616 mutt_file_fclose(&fp);
1617
1618 do
1619 {
1620 rc = imap_cmd_step(adata);
1621 } while (rc == IMAP_RES_CONTINUE);
1622
1623 if (rc != IMAP_RES_OK)
1624 goto cmd_step_fail;
1625
1626 progress_free(&progress);
1627 return 0;
1628
1629cmd_step_fail:
1630 mutt_debug(LL_DEBUG1, "command failed: %s\n", adata->buf);
1631 if (rc != IMAP_RES_BAD)
1632 {
1633 char *pc = imap_next_word(adata->buf); /* skip sequence number or token */
1634 pc = imap_next_word(pc); /* skip response code */
1635 if (*pc != '\0')
1636 mutt_error("%s", pc);
1637 }
1638
1639fail:
1640 mutt_file_fclose(&fp);
1641 progress_free(&progress);
1642 return -1;
1643}
mutt_file_fclose
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
mutt_perror
#define mutt_perror(...)
Definition: logging2.h:93
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:1113
flush_buffer
static int flush_buffer(char *buf, size_t *len, struct Connection *conn)
Write data to a connection.
Definition: message.c:478
IMAP_DATELEN
#define IMAP_DATELEN
Definition: private.h:88
mutt_date_make_imap
int mutt_date_make_imap(char *buf, size_t buflen, time_t timestamp)
Format date in IMAP style: DD-MMM-YYYY HH:MM:SS +ZZzz.
Definition: date.c:784
MUTT_PROGRESS_NET
@ MUTT_PROGRESS_NET
Progress tracks bytes, according to $net_inc
Definition: lib.h:81
progress_new
struct Progress * progress_new(enum ProgressType type, size_t size)
Create a new Progress Bar.
Definition: progress.c:140
progress_free
void progress_free(struct Progress **ptr)
Free a Progress Bar.
Definition: progress.c:111
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:59
Mailbox::verbose
bool verbose
Display status messages?
Definition: mailbox.h:116
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 
)

Open a header cache.

Parameters
adataImap Account data
mdataImap Mailbox data

Definition at line 297 of file util.c.

298{
299 if (!adata || !mdata)
300 return;
301
302 if (mdata->hcache)
303 return;
304
305 struct HeaderCache *hc = NULL;
306 struct Buffer *mbox = buf_pool_get();
307 struct Buffer *cachepath = buf_pool_get();
308
309 imap_cachepath(adata->delim, mdata->name, mbox);
310
311 if (strstr(buf_string(mbox), "/../") || mutt_str_equal(buf_string(mbox), "..") ||
312 mutt_strn_equal(buf_string(mbox), "../", 3))
313 {
314 goto cleanup;
315 }
316 size_t len = buf_len(mbox);
317 if ((len > 3) && (mutt_str_equal(buf_string(mbox) + len - 3, "/..")))
318 goto cleanup;
319
320 struct Url url = { 0 };
321 mutt_account_tourl(&adata->conn->account, &url);
322 url.path = mbox->data;
323 url_tobuffer(&url, cachepath, U_PATH);
324
325 const char *const c_header_cache = cs_subset_path(NeoMutt->sub, "header_cache");
326 hc = hcache_open(c_header_cache, buf_string(cachepath), imap_hcache_namer);
327
328cleanup:
329 buf_pool_release(&mbox);
330 buf_pool_release(&cachepath);
331 mdata->hcache = hc;
332}
buf_len
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition: buffer.c:466
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:169
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:287
hcache_open
struct HeaderCache * hcache_open(const char *path, const char *folder, hcache_namer_t namer)
Multiplexor for StoreOps::open.
Definition: hcache.c:495
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:497
mutt_account_tourl
void mutt_account_tourl(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:79
HeaderCache
Header Cache.
Definition: lib.h:88
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(struct Url *url, struct Buffer *buf, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:357
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:708
+ 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 338 of file util.c.

339{
340 if (!mdata->hcache)
341 return;
342
343 hcache_close(&mdata->hcache);
344}
hcache_close
void hcache_close(struct HeaderCache **ptr)
Multiplexor for StoreOps::close.
Definition: hcache.c:564
+ 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 353 of file util.c.

354{
355 if (!mdata->hcache)
356 return NULL;
357
358 char key[16] = { 0 };
359
360 snprintf(key, sizeof(key), "/%u", uid);
361 struct HCacheEntry hce = hcache_fetch(mdata->hcache, key, mutt_str_len(key),
362 mdata->uidvalidity);
363 if (!hce.email && hce.uidvalidity)
364 {
365 mutt_debug(LL_DEBUG3, "hcache uidvalidity mismatch: %u\n", hce.uidvalidity);
366 }
367
368 return hce.email;
369}
hcache_fetch
struct HCacheEntry hcache_fetch(struct HeaderCache *hc, const char *key, size_t keylen, uint32_t uidvalidity)
Multiplexor for StoreOps::fetch.
Definition: hcache.c:584
HCacheEntry
Wrapper for Email retrieved from the header cache.
Definition: lib.h:101
HCacheEntry::uidvalidity
uint32_t uidvalidity
IMAP-specific UIDVALIDITY.
Definition: lib.h:102
HCacheEntry::email
struct Email * email
Retrieved email.
Definition: lib.h:104
+ 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 378 of file util.c.

379{
380 if (!mdata->hcache)
381 return -1;
382
383 char key[16] = { 0 };
384
385 snprintf(key, sizeof(key), "/%u", imap_edata_get(e)->uid);
386 return hcache_store(mdata->hcache, key, mutt_str_len(key), e, mdata->uidvalidity);
387}
hcache_store
int hcache_store(struct HeaderCache *hc, const char *key, size_t keylen, struct Email *e, uint32_t uidvalidity)
Multiplexor for StoreOps::store.
Definition: hcache.c:687
+ 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 396 of file util.c.

397{
398 if (!mdata->hcache)
399 return -1;
400
401 char key[16] = { 0 };
402
403 snprintf(key, sizeof(key), "/%u", uid);
404 return hcache_delete_record(mdata->hcache, key, mutt_str_len(key));
405}
+ 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 413 of file util.c.

414{
415 if (!mdata->hcache)
416 return -1;
417
418 /* The seqset is likely large. Preallocate to reduce reallocs */
419 struct Buffer buf = buf_make(8192);
420 imap_msn_index_to_uid_seqset(&buf, mdata);
421
422 int rc = hcache_store_raw(mdata->hcache, "/UIDSEQSET", 10, buf.data, buf_len(&buf) + 1);
423 mutt_debug(LL_DEBUG3, "Stored /UIDSEQSET %s\n", buf.data);
424 buf_dealloc(&buf);
425 return rc;
426}
buf_make
struct Buffer buf_make(size_t size)
Make a new buffer on the stack.
Definition: buffer.c:70
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:230
+ 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 434 of file util.c.

435{
436 if (!mdata->hcache)
437 return -1;
438
439 return hcache_delete_record(mdata->hcache, "/UIDSEQSET", 10);
440}
+ 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 448 of file util.c.

449{
450 if (!mdata->hcache)
451 return NULL;
452
453 char *seqset = hcache_fetch_str(mdata->hcache, "/UIDSEQSET", 10);
454 mutt_debug(LL_DEBUG3, "Retrieved /UIDSEQSET %s\n", NONULL(seqset));
455
456 return seqset;
457}
hcache_fetch_str
char * hcache_fetch_str(struct HeaderCache *hc, const char *key, size_t keylen)
Fetch a string from the cache.
Definition: hcache.c:671
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 644 of file util.c.

645{
646 imap_error(msg, resp);
647 return query_yesorno(_("Continue?"), MUTT_NO);
648}
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:330
imap_error
void imap_error(const char *where, const char *msg)
Show an error and abort.
Definition: util.c:655
+ 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 655 of file util.c.

656{
657 mutt_error("%s [%s]", where, msg);
658}
+ 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 105 of file util.c.

106{
107 mutt_hash_free(&mdata->uid_hash);
108 imap_msn_free(&mdata->msn);
109 mutt_bcache_close(&mdata->bcache);
110}
mutt_bcache_close
void mutt_bcache_close(struct BodyCache **ptr)
Close an Email-Body Cache.
Definition: bcache.c:164
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:59
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 ( char  delim,
const char *  mailbox,
char *  path,
size_t  plen 
)

Fix up the imap path.

Parameters
delimDelimiter specified by the server, '\0' for $imap_delim_chars
mailboxMailbox path
pathBuffer for the result
plenLength of buffer
Return values
ptrFixed-up path
Note
if delim is '\0', 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 677 of file util.c.

678{
679 int i = 0;
680 const char *const c_imap_delim_chars = cs_subset_string(NeoMutt->sub, "imap_delim_chars");
681 for (; mailbox && *mailbox && (i < (plen - 1)); i++)
682 {
683 if ((*mailbox == delim) || (!delim && strchr(NONULL(c_imap_delim_chars), *mailbox)))
684 {
685 delim = *mailbox;
686 /* Skip multiple occurrences of delim */
687 while (*mailbox && *(mailbox + 1) == delim)
688 mailbox++;
689 }
690 path[i] = *mailbox++;
691 }
692
693 /* Do not terminate with a delimiter */
694 if ((i != 0) && (path[i - 1] == delim))
695 i--;
696
697 /* Ensure null termination */
698 path[i] = '\0';
699 return path;
700}
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:292
+ Here is the call graph for this function:
+ 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 708 of file util.c.

709{
710 const char *p = mailbox;
711 buf_reset(dest);
712 if (!p)
713 return;
714
715 while (*p)
716 {
717 if (p[0] == delim)
718 {
719 buf_addch(dest, '/');
720 /* simple way to avoid collisions with UIDs */
721 if ((p[1] >= '0') && (p[1] <= '9'))
722 buf_addch(dest, '_');
723 }
724 else
725 {
726 buf_addch(dest, *p);
727 }
728 p++;
729 }
730}
+ 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 739 of file util.c.

740{
741 char *pc = NULL;
742 char *pn = NULL;
743
744 if (!buf || !(pc = strchr(buf, '{')))
745 return -1;
746
747 pc++;
748 pn = pc;
749 while (isdigit((unsigned char) *pc))
750 pc++;
751 *pc = '\0';
752 if (!mutt_str_atoui(pn, bytes))
753 return -1;
754
755 return 0;
756}
mutt_str_atoui
const char * mutt_str_atoui(const char *str, unsigned int *dst)
Convert ASCII string to an unsigned integer.
Definition: atoi.c:213
+ 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 766 of file util.c.

767{
768 char *s = buf;
769
770 /* skip tag */
771 s = imap_next_word(s);
772 /* skip OK/NO/BAD response */
773 s = imap_next_word(s);
774
775 return s;
776}
imap_next_word
char * imap_next_word(char *s)
Find where the next IMAP word begins.
Definition: util.c:783
+ 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 783 of file util.c.

784{
785 bool quoted = false;
786
787 while (*s)
788 {
789 if (*s == '\\')
790 {
791 s++;
792 if (*s)
793 s++;
794 continue;
795 }
796 if (*s == '\"')
797 quoted = !quoted;
798 if (!quoted && isspace(*s))
799 break;
800 s++;
801 }
802
803 SKIPWS(s);
804 return s;
805}
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 814 of file util.c.

815{
816 struct Url url = { 0 };
817 mutt_account_tourl(cac, &url);
818 url.path = path;
819 url_tostring(&url, buf, buflen, U_NO_FLAGS);
820}
url_tostring
int url_tostring(struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:422
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 828 of file util.c.

829{
830 struct Url url = { 0 };
831 mutt_account_tourl(cac, &url);
832 url.path = path;
833 url_tobuffer(&url, buf, U_NO_FLAGS);
834}
+ 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 845 of file util.c.

846{
847 const char *quote = "`\"\\";
848 if (!quote_backtick)
849 quote++;
850
851 char *pt = dest;
852 const char *s = src;
853
854 *pt++ = '"';
855 /* save room for quote-chars */
856 dlen -= 3;
857
858 for (; *s && dlen; s++)
859 {
860 if (strchr(quote, *s))
861 {
862 if (dlen < 2)
863 break;
864 dlen -= 2;
865 *pt++ = '\\';
866 *pt++ = *s;
867 }
868 else
869 {
870 *pt++ = *s;
871 dlen--;
872 }
873 }
874 *pt++ = '"';
875 *pt = '\0';
876}
+ 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 882 of file util.c.

883{
884 char *d = s;
885
886 if (*s == '\"')
887 s++;
888 else
889 return;
890
891 while (*s)
892 {
893 if (*s == '\"')
894 {
895 *d = '\0';
896 return;
897 }
898 if (*s == '\\')
899 {
900 s++;
901 }
902 if (*s)
903 {
904 *d = *s;
905 d++;
906 s++;
907 }
908 }
909 *d = '\0';
910}
+ 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 919 of file util.c.

920{
921 char *buf = mutt_str_dup(src);
922 imap_utf_encode(unicode, &buf);
923
924 imap_quote_string(dest, dlen, buf, false);
925
926 FREE(&buf);
927}
imap_utf_encode
void imap_utf_encode(bool unicode, char **s)
Encode email from local charset to UTF-8.
Definition: utf7.c:395
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:845
+ 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 936 of file util.c.

937{
938 imap_unquote_string(s);
939
940 char *buf = mutt_str_dup(s);
941 if (buf)
942 {
943 imap_utf_decode(unicode, &buf);
944 strncpy(s, buf, strlen(s));
945 }
946
947 FREE(&buf);
948}
imap_utf_decode
void imap_utf_decode(bool unicode, char **s)
Decode email from UTF-8 to local charset.
Definition: utf7.c:428
imap_unquote_string
void imap_unquote_string(char *s)
Equally stupid unquoting routine.
Definition: util.c:882
+ 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 1084 of file util.c.

1085{
1086 if (!seqset || (*seqset == '\0'))
1087 return NULL;
1088
1089 struct SeqsetIterator *iter = mutt_mem_calloc(1, sizeof(struct SeqsetIterator));
1090 iter->full_seqset = mutt_str_dup(seqset);
1091 iter->eostr = strchr(iter->full_seqset, '\0');
1092 iter->substr_cur = iter->substr_end = iter->full_seqset;
1093
1094 return iter;
1095}
mutt_mem_calloc
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
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 1105 of file util.c.

1106{
1107 if (!iter || !next)
1108 return -1;
1109
1110 if (iter->in_range)
1111 {
1112 if ((iter->down && (iter->range_cur == (iter->range_end - 1))) ||
1113 (!iter->down && (iter->range_cur == (iter->range_end + 1))))
1114 {
1115 iter->in_range = 0;
1116 }
1117 }
1118
1119 if (!iter->in_range)
1120 {
1121 iter->substr_cur = iter->substr_end;
1122 if (iter->substr_cur == iter->eostr)
1123 return 1;
1124
1125 iter->substr_end = strchr(iter->substr_cur, ',');
1126 if (!iter->substr_end)
1127 iter->substr_end = iter->eostr;
1128 else
1129 *(iter->substr_end++) = '\0';
1130
1131 char *range_sep = strchr(iter->substr_cur, ':');
1132 if (range_sep)
1133 *range_sep++ = '\0';
1134
1135 if (!mutt_str_atoui_full(iter->substr_cur, &iter->range_cur))
1136 return -1;
1137 if (range_sep)
1138 {
1139 if (!mutt_str_atoui_full(range_sep, &iter->range_end))
1140 return -1;
1141 }
1142 else
1143 {
1144 iter->range_end = iter->range_cur;
1145 }
1146
1147 iter->down = (iter->range_end < iter->range_cur);
1148 iter->in_range = 1;
1149 }
1150
1151 *next = iter->range_cur;
1152 if (iter->down)
1153 iter->range_cur--;
1154 else
1155 iter->range_cur++;
1156
1157 return 0;
1158}
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 1164 of file util.c.

1165{
1166 if (!ptr || !*ptr)
1167 return;
1168
1169 struct SeqsetIterator *iter = *ptr;
1170 FREE(&iter->full_seqset);
1171 FREE(ptr);
1172}
+ 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 1052 of file util.c.

1053{
1054 if (!a1 || !a2)
1055 return false;
1056 if (a1->type != a2->type)
1057 return false;
1058 if (!mutt_istr_equal(a1->host, a2->host))
1059 return false;
1060 if ((a1->port != 0) && (a2->port != 0) && (a1->port != a2->port))
1061 return false;
1062 if (a1->flags & a2->flags & MUTT_ACCT_USER)
1063 return mutt_str_equal(a1->user, a2->user);
1064
1065 const char *user = NONULL(Username);
1066
1067 const char *const c_imap_user = cs_subset_string(NeoMutt->sub, "imap_user");
1068 if ((a1->type == MUTT_ACCT_TYPE_IMAP) && c_imap_user)
1069 user = c_imap_user;
1070
1071 if (a1->flags & MUTT_ACCT_USER)
1072 return mutt_str_equal(a1->user, user);
1073 if (a2->flags & MUTT_ACCT_USER)
1074 return mutt_str_equal(a2->user, user);
1075
1076 return true;
1077}
MUTT_ACCT_USER
#define MUTT_ACCT_USER
User field has been set.
Definition: connaccount.h:44
Username
char * Username
User's login name.
Definition: globals.c:42
MUTT_ACCT_TYPE_IMAP
@ MUTT_ACCT_TYPE_IMAP
Imap Account.
Definition: mutt_account.h:37
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
+ 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 119 of file util.c.

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

396{
397 if (!s || !*s)
398 return;
399
400 const char *c_charset = cc_charset();
401 if (!c_charset)
402 return;
403
404 if (unicode && mutt_ch_is_utf8(c_charset))
405 {
406 return;
407 }
408
409 if (mutt_ch_convert_string(s, c_charset, "utf-8", MUTT_ICONV_NO_FLAGS) != 0)
410 {
411 FREE(s);
412 return;
413 }
414
415 if (!unicode)
416 {
417 char *utf7 = utf8_to_utf7(*s, strlen(*s), NULL, 0);
418 FREE(s);
419 *s = utf7;
420 }
421}
cc_charset
const char * cc_charset(void)
Get the cached value of $charset.
Definition: config_cache.c:115
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:826
mutt_ch_is_utf8
#define mutt_ch_is_utf8(str)
Definition: charset.h:96
MUTT_ICONV_NO_FLAGS
#define MUTT_ICONV_NO_FLAGS
No flags are set.
Definition: charset.h:71
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:250
+ 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 428 of file utf7.c.

429{
430 if (!s || !*s)
431 return;
432
433 const char *c_charset = cc_charset();
434 if (!c_charset)
435 return;
436
437 if (unicode && mutt_ch_is_utf8(c_charset))
438 {
439 return;
440 }
441
442 if (!unicode)
443 {
444 char *utf8 = utf7_to_utf8(*s, strlen(*s), 0, 0);
445 FREE(s);
446 *s = utf8;
447 }
448
449 if (mutt_ch_convert_string(s, "utf-8", c_charset, MUTT_ICONV_NO_FLAGS) != 0)
450 {
451 FREE(s);
452 }
453}
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:104
+ 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 1024 of file util.c.

1025{
1026 struct ImapAccountData *adata = imap_adata_get(m);
1027 struct ImapMboxData *mdata = imap_mdata_get(m);
1028 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1029 return;
1030 mdata->reopen |= IMAP_REOPEN_ALLOW;
1031}
+ 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 1037 of file util.c.

1038{
1039 struct ImapAccountData *adata = imap_adata_get(m);
1040 struct ImapMboxData *mdata = imap_mdata_get(m);
1041 if (!adata || !adata->mailbox || (adata->mailbox != m) || !mdata)
1042 return;
1043 mdata->reopen &= ~IMAP_REOPEN_ALLOW;
1044}
+ 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 258 of file search.c.

259{
260 unsigned int uid;
261 struct Email *e = NULL;
262 struct ImapMboxData *mdata = adata->mailbox->mdata;
263
264 mutt_debug(LL_DEBUG2, "Handling SEARCH\n");
265
266 while ((s = imap_next_word((char *) s)) && (*s != '\0'))
267 {
268 if (!mutt_str_atoui(s, &uid))
269 continue;
270 e = mutt_hash_int_find(mdata->uid_hash, uid);
271 if (e)
272 e->matched = true;
273 }
274}
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:103
+ Here is the call graph for this function:
+ Here is the caller graph for this function: