NeoMutt  2024-12-12-29-gecf7a5
Teaching an old dog new tricks
DOXYGEN
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
POP Response Parser API

Prototype for a function to handle POP server responses. More...

Functions

static int fetch_capa (const char *line, void *data)
 Parse CAPA response - Implements pop_fetch_t -.
 
static int fetch_auth (const char *line, void *data)
 Parse AUTH response - Implements pop_fetch_t -.
 
static int check_uidl (const char *line, void *data)
 Parse UIDL response - Implements pop_fetch_t -.
 
static int fetch_message (const char *line, void *data)
 Parse a Message response - Implements pop_fetch_t -.
 
static int fetch_uidl (const char *line, void *data)
 Parse UIDL response - Implements pop_fetch_t -.
 

Detailed Description

Prototype for a function to handle POP server responses.

Parameters
strString to parse
dataPrivate data passed to pop_fetch_data()
Return values
0Success
-1Failure

Function Documentation

◆ fetch_capa()

static int fetch_capa ( const char *  line,
void *  data 
)
static

Parse CAPA response - Implements pop_fetch_t -.

Parameters
lineList of capabilities
dataPOP data
Return values
0(always)

Definition at line 146 of file lib.c.

147{
148 struct PopAccountData *adata = data;
149
150 if (mutt_istr_startswith(line, "SASL"))
151 {
152 const char *c = mutt_str_skip_email_wsp(line + 4);
153 buf_strcpy(&adata->auth_list, c);
154 }
155 else if (mutt_istr_startswith(line, "STLS"))
156 {
157 adata->cmd_stls = true;
158 }
159 else if (mutt_istr_startswith(line, "USER"))
160 {
161 adata->cmd_user = 1;
162 }
163 else if (mutt_istr_startswith(line, "UIDL"))
164 {
165 adata->cmd_uidl = 1;
166 }
167 else if (mutt_istr_startswith(line, "TOP"))
168 {
169 adata->cmd_top = 1;
170 }
171
172 return 0;
173}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition: string.c:608
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:242
void * adata
Private data (for Mailbox backends)
Definition: account.h:42
POP-specific Account data -.
Definition: adata.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fetch_auth()

static int fetch_auth ( const char *  line,
void *  data 
)
static

Parse AUTH response - Implements pop_fetch_t -.

Parameters
lineList of authentication methods
dataPOP data
Return values
0(always)

Definition at line 181 of file lib.c.

182{
183 struct PopAccountData *adata = data;
184
185 if (!buf_is_empty(&adata->auth_list))
186 {
187 buf_addstr(&adata->auth_list, " ");
188 }
189 buf_addstr(&adata->auth_list, line);
190
191 return 0;
192}
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition: buffer.c:291
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:226
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ check_uidl()

static int check_uidl ( const char *  line,
void *  data 
)
static

Parse UIDL response - Implements pop_fetch_t -.

Parameters
lineString containing UIDL
dataPOP data
Return values
0Success
-1Error

Find message with this UIDL and set refno.

Definition at line 574 of file lib.c.

575{
576 if (!line || !data)
577 return -1;
578
579 char *endp = NULL;
580
581 errno = 0;
582 unsigned int index = strtoul(line, &endp, 10);
583 if (errno != 0)
584 return -1;
585 while (*endp == ' ')
586 endp++;
587
588 struct Mailbox *m = data;
589 for (int i = 0; i < m->msg_count; i++)
590 {
591 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
592 if (mutt_str_equal(edata->uid, endp))
593 {
594 edata->refno = index;
595 break;
596 }
597 }
598
599 return 0;
600}
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
struct PopEmailData * pop_edata_get(struct Email *e)
Get the private data for this Email.
Definition: edata.c:68
void * edata
Driver-specific data.
Definition: email.h:74
int index
The absolute (unsorted) message number.
Definition: email.h:110
A mailbox.
Definition: mailbox.h:79
int msg_count
Total number of messages.
Definition: mailbox.h:88
struct Email ** emails
Array of Emails.
Definition: mailbox.h:96
POP-specific Email data -.
Definition: edata.h:32
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fetch_message()

static int fetch_message ( const char *  line,
void *  data 
)
static

Parse a Message response - Implements pop_fetch_t -.

Parameters
lineString to write
dataFILE pointer to write to
Return values
0Success
-1Failure

Save a Message to a file.

Definition at line 98 of file pop.c.

99{
100 FILE *fp = data;
101
102 fputs(line, fp);
103 if (fputc('\n', fp) == EOF)
104 return -1;
105
106 return 0;
107}
+ Here is the caller graph for this function:

◆ fetch_uidl()

static int fetch_uidl ( const char *  line,
void *  data 
)
static

Parse UIDL response - Implements pop_fetch_t -.

Parameters
lineString to parse
dataMailbox
Return values
0Success
-1Failure

Definition at line 201 of file pop.c.

202{
203 struct Mailbox *m = data;
205 char *endp = NULL;
206
207 errno = 0;
208 int index = strtol(line, &endp, 10);
209 if (errno)
210 return -1;
211 while (*endp == ' ')
212 endp++;
213 line = endp;
214
215 /* uid must be at least be 1 byte */
216 if (strlen(line) == 0)
217 return -1;
218
219 int i;
220 for (i = 0; i < m->msg_count; i++)
221 {
222 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
223 if (mutt_str_equal(line, edata->uid))
224 break;
225 }
226
227 if (i == m->msg_count)
228 {
229 mutt_debug(LL_DEBUG1, "new header %d %s\n", index, line);
230
231 mx_alloc_memory(m, i);
232
233 m->msg_count++;
234 m->emails[i] = email_new();
235
236 m->emails[i]->edata = pop_edata_new(line);
238 }
239 else if (m->emails[i]->index != index - 1)
240 {
241 adata->clear_cache = true;
242 }
243
244 m->emails[i]->index = index - 1;
245
246 struct PopEmailData *edata = pop_edata_get(m->emails[i]);
247 edata->refno = index;
248
249 return 0;
250}
struct Email * email_new(void)
Create a new Email.
Definition: email.c:77
void pop_edata_free(void **ptr)
Free the private Email data - Implements Email::edata_free() -.
Definition: edata.c:41
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
void mx_alloc_memory(struct Mailbox *m, int req_size)
Create storage for the emails.
Definition: mx.c:1206
struct PopAccountData * pop_adata_get(struct Mailbox *m)
Get the Account data for this mailbox.
Definition: adata.c:73
struct PopEmailData * pop_edata_new(const char *uid)
Create a new PopEmailData for an email.
Definition: edata.c:56
void(* edata_free)(void **ptr)
Definition: email.h:90
bool clear_cache
Definition: adata.h:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function: