NeoMutt  2025-12-11-980-ge38c27
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
address.c File Reference

Representation of an email address. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "mutt/lib.h"
#include "address.h"
#include "idna2.h"
+ Include dependency graph for address.c:

Go to the source code of this file.

Macros

#define is_special(ch, mask)
 Is this character special to an email address?
 
#define ADDRESS_SPECIAL_MASK   0x380000015c005304ULL
 Mask for AddressSpecials, for is_special()
 
#define USER_SPECIAL_MASK   0x280000015c001200ULL
 Mask for AddressSpecials except " ( . \ characters.
 
#define DOMAIN_SPECIAL_MASK   0x000000015c001204ULL
 Mask for AddressSpecials except ( . [ \ ] characters.
 
#define ROUTE_SPECIAL_MASK   0x000000015c000204ULL
 Mask for AddressSpecials except ( , . [ \ ] characters.
 

Functions

static const char * parse_comment (const char *s, char *comment, size_t *commentlen, size_t commentmax)
 Extract a comment (parenthesised string)
 
static const char * parse_quote (const char *s, char *token, size_t *tokenlen, size_t tokenmax)
 Extract a quoted string.
 
static const char * next_token (const char *s, char *token, size_t *tokenlen, size_t tokenmax)
 Find the next word, skipping quoted and parenthesised text.
 
static const char * parse_mailboxdomain (const char *s, uint64_t special_mask, char *mailbox, size_t *mailboxlen, size_t mailboxmax, char *comment, size_t *commentlen, size_t commentmax)
 Extract part of an email address (and a comment)
 
static const char * parse_address (const char *s, char *token, size_t *tokenlen, size_t tokenmax, char *comment, size_t *commentlen, size_t commentmax, struct Address *addr)
 Extract an email address.
 
static const char * parse_route_addr (const char *s, char *comment, size_t *commentlen, size_t commentmax, struct Address *addr)
 Parse an email addresses.
 
static const char * parse_addr_spec (const char *s, char *comment, size_t *commentlen, size_t commentmax, struct Address *addr)
 Parse an email address.
 
static bool add_addrspec (struct AddressList *al, const char *phrase, char *comment, size_t *commentlen, size_t commentmax)
 Parse an email address and add an Address to a list.
 
struct Addressmutt_addr_new (void)
 Create a new Address.
 
struct Addressmutt_addr_create (const char *personal, const char *mailbox)
 Create and populate a new Address.
 
int mutt_addrlist_remove (struct AddressList *al, const char *mailbox)
 Remove an Address from a list.
 
void mutt_addr_free (struct Address **ptr)
 Free a single Address.
 
int mutt_addrlist_parse (struct AddressList *al, const char *s)
 Parse a list of email addresses.
 
int mutt_addrlist_parse2 (struct AddressList *al, const char *s)
 Parse a list of email addresses.
 
void mutt_addrlist_qualify (struct AddressList *al, const char *host)
 Expand local names in an Address list using a hostname.
 
void mutt_addr_cat (char *buf, size_t buflen, const char *value, const char *specials)
 Copy a string and wrap it in quotes if it contains special characters.
 
struct Addressmutt_addr_copy (const struct Address *addr)
 Copy the real address.
 
void mutt_addrlist_copy (struct AddressList *dst, const struct AddressList *src, bool prune)
 Copy a list of addresses into another list.
 
bool mutt_addr_valid_msgid (const char *msgid)
 Is this a valid Message ID?
 
bool mutt_addrlist_equal (const struct AddressList *ala, const struct AddressList *alb)
 Compare two Address lists for equality.
 
int mutt_addrlist_count_recips (const struct AddressList *al)
 Count the number of Addresses with valid recipients.
 
bool mutt_addr_cmp (const struct Address *a, const struct Address *b)
 Compare two e-mail addresses.
 
bool mutt_addrlist_search (const struct AddressList *haystack, const struct Address *needle)
 Search for an e-mail address in a list.
 
static bool addr_is_intl (const struct Address *a)
 Does the Address have IDN components.
 
static bool addr_is_local (const struct Address *a)
 Does the Address have NO IDN components.
 
static int addr_mbox_to_udomain (const char *mbox, char **user, char **domain)
 Split a mailbox name into user and domain.
 
static void addr_set_intl (struct Address *a, char *intl_mailbox)
 Mark an Address as having IDN components.
 
static void addr_set_local (struct Address *a, char *local_mailbox)
 Mark an Address as having NO IDN components.
 
const char * mutt_addr_for_display (const struct Address *a)
 Convert an Address for display purposes.
 
size_t mutt_addr_write (struct Buffer *buf, struct Address *addr, bool display)
 Write a single Address to a buffer.
 
static size_t addrlist_write (const struct AddressList *al, struct Buffer *buf, bool display, const char *header, int cols)
 Write an AddressList to a buffer, optionally perform line wrapping and display conversion.
 
size_t mutt_addrlist_write_wrap (const struct AddressList *al, struct Buffer *buf, const char *header)
 Write an AddressList to a buffer, perform line wrapping.
 
size_t mutt_addrlist_write (const struct AddressList *al, struct Buffer *buf, bool display)
 Write an Address to a buffer.
 
size_t mutt_addrlist_write_list (const struct AddressList *al, struct ListHead *list)
 Write Addresses to a List.
 
void mutt_addrlist_write_file (const struct AddressList *al, FILE *fp, const char *header)
 Wrapper for mutt_write_address()
 
bool mutt_addr_to_intl (struct Address *a)
 Convert an Address to Punycode.
 
int mutt_addrlist_to_intl (struct AddressList *al, char **err)
 Convert an Address list to Punycode.
 
bool mutt_addr_to_local (struct Address *a)
 Convert an Address from Punycode.
 
int mutt_addrlist_to_local (struct AddressList *al)
 Convert an Address list from Punycode.
 
void mutt_addrlist_dedupe (struct AddressList *al)
 Remove duplicate addresses.
 
void mutt_addrlist_remove_xrefs (const struct AddressList *a, struct AddressList *b)
 Remove cross-references.
 
void mutt_addrlist_clear (struct AddressList *al)
 Unlink and free all Address in an AddressList.
 
void mutt_addrlist_append (struct AddressList *al, struct Address *a)
 Append an Address to an AddressList.
 
void mutt_addrlist_prepend (struct AddressList *al, struct Address *a)
 Prepend an Address to an AddressList.
 
bool mutt_addr_uses_unicode (const char *str)
 Does this address use Unicode character.
 
bool mutt_addrlist_uses_unicode (const struct AddressList *al)
 Do any of a list of addresses use Unicode characters.
 

Variables

const char AddressSpecials [] = "\"(),.:;<>@[\\]"
 Characters with special meaning for email addresses.
 

Detailed Description

Representation of an email address.

Authors
  • Richard Russon
  • Pietro Cerutti
  • Simon Symeonidis
  • Anna Figueiredo Gomes
  • Steinar H Gunderson

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 address.c.

Macro Definition Documentation

◆ is_special

#define is_special ( ch,
mask )
Value:
((ch) >= 32 && (ch) < 96 && ((mask >> ((ch) - 32)) & 1))

Is this character special to an email address?

Parameters
chCharacter
maskBitmask of characters 32-95 that are special (others are always zero)

Character bitmasks

The four bitmasks below are used for matching characters at speed, instead of using strchr(3).

To generate them, consider the value of each character, e.g. , == 44. Now set the 44th bit of a unsigned long long (presumed to be 64 bits), i.e., 1ULL << 44. Repeat for each character.

To test a character, say ( (40), we check if the 40th bit is set in the mask.

The characters we want to test, AddressSpecials, range in value between 34 and 93 (inclusive). This is too large for an integer type, so we subtract 32 to bring the values down to 2 to 61.

Definition at line 67 of file address.c.

67#define is_special(ch, mask) \
68 ((ch) >= 32 && (ch) < 96 && ((mask >> ((ch) - 32)) & 1))

◆ ADDRESS_SPECIAL_MASK

#define ADDRESS_SPECIAL_MASK   0x380000015c005304ULL

Mask for AddressSpecials, for is_special()

Definition at line 71 of file address.c.

◆ USER_SPECIAL_MASK

#define USER_SPECIAL_MASK   0x280000015c001200ULL

Mask for AddressSpecials except " ( . \ characters.

Definition at line 74 of file address.c.

◆ DOMAIN_SPECIAL_MASK

#define DOMAIN_SPECIAL_MASK   0x000000015c001204ULL

Mask for AddressSpecials except ( . [ \ ] characters.

Definition at line 77 of file address.c.

◆ ROUTE_SPECIAL_MASK

#define ROUTE_SPECIAL_MASK   0x000000015c000204ULL

Mask for AddressSpecials except ( , . [ \ ] characters.

Definition at line 80 of file address.c.

Function Documentation

◆ parse_comment()

static const char * parse_comment ( const char * s,
char * comment,
size_t * commentlen,
size_t commentmax )
static

Extract a comment (parenthesised string)

Parameters
[in]sString, just after the opening parenthesis
[out]commentBuffer to store parenthesised string
[out]commentlenLength of parenthesised string
[in]commentmaxLength of buffer
Return values
ptrFirst character after parenthesised string
NULLError

Definition at line 91 of file address.c.

92{
93 int level = 1;
94
95 while (*s && level)
96 {
97 if (*s == '(')
98 {
99 level++;
100 }
101 else if (*s == ')')
102 {
103 if (--level == 0)
104 {
105 s++;
106 break;
107 }
108 }
109 else if (*s == '\\')
110 {
111 if (!*++s)
112 break;
113 }
114 if (*commentlen < commentmax)
115 comment[(*commentlen)++] = *s;
116 s++;
117 }
118 if (level != 0)
119 {
120 return NULL;
121 }
122 return s;
123}
+ Here is the caller graph for this function:

◆ parse_quote()

static const char * parse_quote ( const char * s,
char * token,
size_t * tokenlen,
size_t tokenmax )
static

Extract a quoted string.

Parameters
[in]sString, just after the opening quote mark
[out]tokenBuffer to store quoted string
[out]tokenlenLength of quoted string
[in]tokenmaxLength of buffer
Return values
ptrFirst character after quoted string
NULLError

Definition at line 134 of file address.c.

135{
136 while (*s)
137 {
138 if (*tokenlen < tokenmax)
139 token[*tokenlen] = *s;
140 if (*s == '\\')
141 {
142 if (!*++s)
143 break;
144
145 if (*tokenlen < tokenmax)
146 token[*tokenlen] = *s;
147 }
148 else if (*s == '"')
149 {
150 return s + 1;
151 }
152 (*tokenlen)++;
153 s++;
154 }
155 return NULL;
156}
+ Here is the caller graph for this function:

◆ next_token()

static const char * next_token ( const char * s,
char * token,
size_t * tokenlen,
size_t tokenmax )
static

Find the next word, skipping quoted and parenthesised text.

Parameters
[in]sString to search
[out]tokenBuffer for the token
[out]tokenlenLength of the next token
[in]tokenmaxLength of the buffer
Return values
ptrFirst character after the next token

Definition at line 166 of file address.c.

167{
168 if (*s == '(')
169 return parse_comment(s + 1, token, tokenlen, tokenmax);
170 if (*s == '"')
171 return parse_quote(s + 1, token, tokenlen, tokenmax);
172 if (*s && is_special(*s, ADDRESS_SPECIAL_MASK))
173 {
174 if (*tokenlen < tokenmax)
175 token[(*tokenlen)++] = *s;
176 return s + 1;
177 }
178 while (*s)
179 {
181 break;
182 if (*tokenlen < tokenmax)
183 token[(*tokenlen)++] = *s;
184 s++;
185 }
186 return s;
187}
#define ADDRESS_SPECIAL_MASK
Mask for AddressSpecials, for is_special()
Definition address.c:71
static const char * parse_comment(const char *s, char *comment, size_t *commentlen, size_t commentmax)
Extract a comment (parenthesised string)
Definition address.c:91
#define is_special(ch, mask)
Is this character special to an email address?
Definition address.c:67
static const char * parse_quote(const char *s, char *token, size_t *tokenlen, size_t tokenmax)
Extract a quoted string.
Definition address.c:134
static bool mutt_str_is_email_wsp(char c)
Is this a whitespace character (for an email header)
Definition string2.h:111
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_mailboxdomain()

static const char * parse_mailboxdomain ( const char * s,
uint64_t special_mask,
char * mailbox,
size_t * mailboxlen,
size_t mailboxmax,
char * comment,
size_t * commentlen,
size_t commentmax )
static

Extract part of an email address (and a comment)

Parameters
[in]sString to parse
[in]special_maskCharacters that are special (see is_special())
[out]mailboxBuffer for email address
[out]mailboxlenLength of saved email address
[in]mailboxmaxLength of mailbox buffer
[out]commentBuffer for comment
[out]commentlenLength of saved comment
[in]commentmaxLength of comment buffer
Return values
ptrFirst character after the email address part

This will be called twice to parse an email address, first for the mailbox name, then for the domain name. Each part can also have a comment in (). The comment can be at the start or end of the mailbox or domain.

Examples:

  • "john.doe@example.com"
  • "john.doe(comment)@example.com"
  • "john.doe@example.com(comment)"

The first call will return "john.doe" with optional comment, "comment". The second call will return "example.com" with optional comment, "comment".

Definition at line 213 of file address.c.

217{
218 const char *ps = NULL;
219
220 while (*s)
221 {
223 if ((*s == '\0'))
224 return s;
225
226 if (is_special(*s, special_mask))
227 return s;
228
229 if (*s == '(')
230 {
231 if (*commentlen && (*commentlen < commentmax))
232 comment[(*commentlen)++] = ' ';
233 ps = next_token(s, comment, commentlen, commentmax);
234 }
235 else
236 {
237 ps = next_token(s, mailbox, mailboxlen, mailboxmax);
238 }
239 if (!ps)
240 return NULL;
241 s = ps;
242 }
243
244 return s;
245}
static const char * next_token(const char *s, char *token, size_t *tokenlen, size_t tokenmax)
Find the next word, skipping quoted and parenthesised text.
Definition address.c:166
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition string.c:614
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_address()

static const char * parse_address ( const char * s,
char * token,
size_t * tokenlen,
size_t tokenmax,
char * comment,
size_t * commentlen,
size_t commentmax,
struct Address * addr )
static

Extract an email address.

Parameters
[in]sString, just after the opening <
[out]tokenBuffer for the email address
[out]tokenlenLength of the email address
[in]tokenmaxLength of the email address buffer
[out]commentBuffer for any comments
[out]commentlenLength of any comments
[in]commentmaxLength of the comment buffer
[in]addrAddress to store the results
Return values
ptrThe closing > of the email address
NULLError

Definition at line 260 of file address.c.

263{
264 s = parse_mailboxdomain(s, USER_SPECIAL_MASK, token, tokenlen, tokenmax,
265 comment, commentlen, commentmax);
266 if (!s)
267 return NULL;
268
269 if (*s == '@')
270 {
271 if (*tokenlen < tokenmax)
272 token[(*tokenlen)++] = '@';
273 s = parse_mailboxdomain(s + 1, DOMAIN_SPECIAL_MASK, token, tokenlen,
274 tokenmax, comment, commentlen, commentmax);
275 if (!s)
276 return NULL;
277 }
278
279 terminate_string(token, *tokenlen, tokenmax);
280 addr->mailbox = buf_new(token);
281
282 if (*commentlen && !addr->personal)
283 {
284 terminate_string(comment, *commentlen, commentmax);
285 addr->personal = buf_new(comment);
286 }
287
288 return s;
289}
static const char * parse_mailboxdomain(const char *s, uint64_t special_mask, char *mailbox, size_t *mailboxlen, size_t mailboxmax, char *comment, size_t *commentlen, size_t commentmax)
Extract part of an email address (and a comment)
Definition address.c:213
#define USER_SPECIAL_MASK
Mask for AddressSpecials except " ( . \ characters.
Definition address.c:74
#define DOMAIN_SPECIAL_MASK
Mask for AddressSpecials except ( . [ \ ] characters.
Definition address.c:77
struct Buffer * buf_new(const char *str)
Allocate a new Buffer.
Definition buffer.c:311
#define terminate_string(str, strlen, buflen)
Definition string2.h:56
struct Buffer * personal
Real name of address.
Definition address.h:36
struct Buffer * mailbox
Mailbox and host address.
Definition address.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_route_addr()

static const char * parse_route_addr ( const char * s,
char * comment,
size_t * commentlen,
size_t commentmax,
struct Address * addr )
static

Parse an email addresses.

Parameters
[in]sString, just after the opening <
[out]commentBuffer for any comments
[out]commentlenLength of any comments
[in]commentmaxLength of the comments buffer
[in]addrAddress to store the details
Return values
ptrFirst character after the email address

Definition at line 300 of file address.c.

302{
303 char token[1024] = { 0 };
304 size_t tokenlen = 0;
305
307
308 /* find the end of the route */
309 if (*s == '@')
310 {
311 while (s && (*s == '@'))
312 {
313 if (tokenlen < (sizeof(token) - 1))
314 token[tokenlen++] = '@';
315 s = parse_mailboxdomain(s + 1, ROUTE_SPECIAL_MASK, token, &tokenlen,
316 sizeof(token) - 1, comment, commentlen, commentmax);
317 }
318 if (!s || (*s != ':'))
319 {
320 return NULL; /* invalid route */
321 }
322
323 if (tokenlen < (sizeof(token) - 1))
324 token[tokenlen++] = ':';
325 s++;
326 }
327
328 s = parse_address(s, token, &tokenlen, sizeof(token) - 1, comment, commentlen,
329 commentmax, addr);
330 if (!s)
331 return NULL;
332
333 if (*s != '>')
334 {
335 return NULL;
336 }
337
338 if (!addr->mailbox)
339 {
340 addr->mailbox = buf_new("@");
341 }
342
343 s++;
344 return s;
345}
static const char * parse_address(const char *s, char *token, size_t *tokenlen, size_t tokenmax, char *comment, size_t *commentlen, size_t commentmax, struct Address *addr)
Extract an email address.
Definition address.c:260
#define ROUTE_SPECIAL_MASK
Mask for AddressSpecials except ( , . [ \ ] characters.
Definition address.c:80
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse_addr_spec()

static const char * parse_addr_spec ( const char * s,
char * comment,
size_t * commentlen,
size_t commentmax,
struct Address * addr )
static

Parse an email address.

Parameters
[in]sString to parse
[out]commentBuffer for any comments
[out]commentlenLength of any comments
[in]commentmaxLength of the comments buffer
[in]addrAddress to fill in
Return values
ptrFirst character after the email address

Definition at line 356 of file address.c.

358{
359 char token[1024] = { 0 };
360 size_t tokenlen = 0;
361
362 s = parse_address(s, token, &tokenlen, sizeof(token) - 1, comment, commentlen,
363 commentmax, addr);
364 if (s && *s && (*s != ',') && (*s != ';'))
365 {
366 return NULL;
367 }
368 return s;
369}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ add_addrspec()

static bool add_addrspec ( struct AddressList * al,
const char * phrase,
char * comment,
size_t * commentlen,
size_t commentmax )
static

Parse an email address and add an Address to a list.

Parameters
[out]alAddress list
[in]phraseString to parse
[out]commentBuffer for any comments
[out]commentlenLength of any comments
[in]commentmaxLength of the comments buffer
Return values
trueAn address was successfully parsed and added

Definition at line 380 of file address.c.

382{
383 struct Address *cur = mutt_addr_new();
384
385 if (!parse_addr_spec(phrase, comment, commentlen, commentmax, cur))
386 {
387 mutt_addr_free(&cur);
388 return false;
389 }
390
391 mutt_addrlist_append(al, cur);
392 return true;
393}
static const char * parse_addr_spec(const char *s, char *comment, size_t *commentlen, size_t commentmax, struct Address *addr)
Parse an email address.
Definition address.c:356
void mutt_addr_free(struct Address **ptr)
Free a single Address.
Definition address.c:463
void mutt_addrlist_append(struct AddressList *al, struct Address *a)
Append an Address to an AddressList.
Definition address.c:1496
struct Address * mutt_addr_new(void)
Create a new Address.
Definition address.c:401
An email address.
Definition address.h:35
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_new()

struct Address * mutt_addr_new ( void )

Create a new Address.

Return values
ptrNewly allocated Address

Free the result with mutt_addr_free()

Definition at line 401 of file address.c.

402{
403 return MUTT_MEM_CALLOC(1, struct Address);
404}
#define MUTT_MEM_CALLOC(n, type)
Definition memory.h:52
+ Here is the caller graph for this function:

◆ mutt_addr_create()

struct Address * mutt_addr_create ( const char * personal,
const char * mailbox )

Create and populate a new Address.

Parameters
[in]personalThe personal name for the Address (can be NULL)
[in]mailboxThe mailbox for the Address (can be NULL)
Return values
ptrNewly allocated Address
Note
The personal and mailbox values, if not NULL, are going to be copied into the newly allocated Address.

Definition at line 414 of file address.c.

415{
416 struct Address *a = mutt_addr_new();
417 if (personal)
418 {
420 }
421 if (mailbox)
422 {
423 a->mailbox = buf_new(mailbox);
424 }
425 return a;
426}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_remove()

int mutt_addrlist_remove ( struct AddressList * al,
const char * mailbox )

Remove an Address from a list.

Parameters
[in,out]alAddressList
[in]mailboxEmail address to match
Return values
0Success
-1Error, or email not found

Definition at line 435 of file address.c.

436{
437 if (!al)
438 return -1;
439
440 if (!mailbox)
441 return 0;
442
443 int rc = -1;
444 struct Address *a = NULL;
445 struct Address *tmp = NULL;
446 TAILQ_FOREACH_SAFE(a, al, entries, tmp)
447 {
449 {
450 TAILQ_REMOVE(al, a, entries);
451 mutt_addr_free(&a);
452 rc = 0;
453 }
454 }
455
456 return rc;
457}
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition string.c:678
#define TAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition queue.h:792
#define TAILQ_REMOVE(head, elm, field)
Definition queue.h:901
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_free()

void mutt_addr_free ( struct Address ** ptr)

Free a single Address.

Parameters
[out]ptrAddress to free

Definition at line 463 of file address.c.

464{
465 if (!ptr || !*ptr)
466 return;
467
468 struct Address *a = *ptr;
469
470 buf_free(&a->personal);
471 buf_free(&a->mailbox);
472 FREE(ptr);
473}
void buf_free(struct Buffer **ptr)
Deallocates a buffer.
Definition buffer.c:326
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_parse()

int mutt_addrlist_parse ( struct AddressList * al,
const char * s )

Parse a list of email addresses.

Parameters
alAddressList to append addresses
sString to parse
Return values
numNumber of parsed addresses

Definition at line 481 of file address.c.

482{
483 if (!s)
484 return 0;
485
486 int parsed = 0;
487 char comment[1024] = { 0 };
488 char phrase[1024] = { 0 };
489 size_t phraselen = 0;
490 size_t commentlen = 0;
491
492 bool ws_pending = mutt_str_is_email_wsp(*s);
493
494 /* Parse the address string character by character, handling RFC 2822
495 * constructs: quoted strings, comments, route-addr, group syntax */
497 while (*s)
498 {
499 switch (*s)
500 {
501 case ';':
502 case ',':
503 /* Address separator: convert accumulated phrase into an address */
504 if (phraselen != 0)
505 {
506 terminate_buffer(phrase, phraselen);
507 if (add_addrspec(al, phrase, comment, &commentlen, sizeof(comment) - 1))
508 {
509 parsed++;
510 }
511 }
512 else if (commentlen != 0)
513 {
514 struct Address *last = TAILQ_LAST(al, AddressList);
515 if (last && !last->personal && !buf_is_empty(last->mailbox))
516 {
517 terminate_buffer(comment, commentlen);
518 last->personal = buf_new(comment);
519 }
520 }
521
522 if (*s == ';')
523 {
524 /* add group terminator */
526 }
527
528 phraselen = 0;
529 commentlen = 0;
530 s++;
531 break;
532
533 case '(':
534 /* RFC 822 comment in parentheses */
535 if ((commentlen != 0) && (commentlen < (sizeof(comment) - 1)))
536 comment[commentlen++] = ' ';
537 s = next_token(s, comment, &commentlen, sizeof(comment) - 1);
538 if (!s)
539 {
541 return 0;
542 }
543 break;
544
545 case '"':
546 if ((phraselen != 0) && (phraselen < (sizeof(phrase) - 1)))
547 phrase[phraselen++] = ' ';
548 s = parse_quote(s + 1, phrase, &phraselen, sizeof(phrase) - 1);
549 if (!s)
550 {
552 return 0;
553 }
554 break;
555
556 case ':':
557 {
558 struct Address *a = mutt_addr_new();
559 terminate_buffer(phrase, phraselen);
560 if (phraselen != 0)
561 {
562 a->mailbox = buf_new(phrase);
563 }
564 a->group = true;
566 phraselen = 0;
567 commentlen = 0;
568 s++;
569 break;
570 }
571
572 case '<':
573 {
574 /* Route-addr: phrase before '<' becomes personal name */
575 struct Address *a = mutt_addr_new();
576 terminate_buffer(phrase, phraselen);
577 if (phraselen != 0)
578 {
579 a->personal = buf_new(phrase);
580 }
581 s = parse_route_addr(s + 1, comment, &commentlen, sizeof(comment) - 1, a);
582 if (!s)
583 {
585 mutt_addr_free(&a);
586 return 0;
587 }
589 phraselen = 0;
590 commentlen = 0;
591 parsed++;
592 break;
593 }
594
595 default:
596 if ((phraselen != 0) && (phraselen < (sizeof(phrase) - 1)) && ws_pending)
597 phrase[phraselen++] = ' ';
598 if (*s == '\\')
599 {
600 s++;
601 if (*s && (phraselen < (sizeof(phrase) - 1)))
602 {
603 phrase[phraselen++] = *s;
604 s++;
605 }
606 }
607 s = next_token(s, phrase, &phraselen, sizeof(phrase) - 1);
608 if (!s)
609 {
611 return 0;
612 }
613 break;
614 } // switch (*s)
615
616 ws_pending = mutt_str_is_email_wsp(*s);
618 } // while (*s)
619
620 if (phraselen != 0)
621 {
622 terminate_buffer(phrase, phraselen);
623 terminate_buffer(comment, commentlen);
624 if (add_addrspec(al, phrase, comment, &commentlen, sizeof(comment) - 1))
625 {
626 parsed++;
627 }
628 }
629 else if (commentlen != 0)
630 {
631 struct Address *last = TAILQ_LAST(al, AddressList);
632 if (last && !last->personal && !buf_is_empty(last->mailbox))
633 {
634 terminate_buffer(comment, commentlen);
635 last->personal = buf_new(comment);
636 }
637 }
638
639 return parsed;
640}
static bool add_addrspec(struct AddressList *al, const char *phrase, char *comment, size_t *commentlen, size_t commentmax)
Parse an email address and add an Address to a list.
Definition address.c:380
static const char * parse_route_addr(const char *s, char *comment, size_t *commentlen, size_t commentmax, struct Address *addr)
Parse an email addresses.
Definition address.c:300
void mutt_addrlist_clear(struct AddressList *al)
Unlink and free all Address in an AddressList.
Definition address.c:1475
bool buf_is_empty(const struct Buffer *buf)
Is the Buffer empty?
Definition buffer.c:298
#define TAILQ_LAST(head, headname)
Definition queue.h:876
#define terminate_buffer(str, strlen)
Definition string2.h:59
bool group
Group mailbox?
Definition address.h:38
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_parse2()

int mutt_addrlist_parse2 ( struct AddressList * al,
const char * s )

Parse a list of email addresses.

Parameters
alAdd to this List of Addresses
sString to parse
Return values
numNumber of parsed addresses

Simple email addresses (without any personal name or grouping) can be separated by whitespace or commas.

Definition at line 651 of file address.c.

652{
653 if (!s || (*s == '\0'))
654 return 0;
655
656 int parsed = 0;
657
658 /* check for a simple whitespace separated list of addresses */
659 if (!strpbrk(s, "\"<>():;,\\"))
660 {
661 char *copy = mutt_str_dup(s);
662 char *r = copy;
663 while ((r = strtok(r, " \t")))
664 {
665 parsed += mutt_addrlist_parse(al, r);
666 r = NULL;
667 }
668 FREE(&copy);
669 }
670 else
671 {
672 parsed = mutt_addrlist_parse(al, s);
673 }
674
675 return parsed;
676}
int mutt_addrlist_parse(struct AddressList *al, const char *s)
Parse a list of email addresses.
Definition address.c:481
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition string.c:257
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_qualify()

void mutt_addrlist_qualify ( struct AddressList * al,
const char * host )

Expand local names in an Address list using a hostname.

Parameters
alAddress list
hostHostname

Any addresses containing a bare name will be expanded using the hostname. e.g. "john", "example.com" -> 'john@.nosp@m.exam.nosp@m.ple.c.nosp@m.om'. This function has no effect if host is NULL or the empty string.

Definition at line 687 of file address.c.

688{
689 if (!al || !host || (*host == '\0'))
690 return;
691
692 struct Address *a = NULL;
693 TAILQ_FOREACH(a, al, entries)
694 {
695 if (!a->group && a->mailbox && !buf_find_char(a->mailbox, '@'))
696 {
697 buf_add_printf(a->mailbox, "@%s", host);
698 }
699 }
700}
int buf_add_printf(struct Buffer *buf, const char *fmt,...)
Format a string appending a Buffer.
Definition buffer.c:211
const char * buf_find_char(const struct Buffer *buf, const char c)
Return a pointer to a char found in the buffer.
Definition buffer.c:659
#define TAILQ_FOREACH(var, head, field)
Definition queue.h:782
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_cat()

void mutt_addr_cat ( char * buf,
size_t buflen,
const char * value,
const char * specials )

Copy a string and wrap it in quotes if it contains special characters.

Parameters
bufBuffer for the result
buflenLength of the result buffer
valueString to copy
specialsCharacters to lookup

This function copies the string in the "value" parameter in the buffer pointed to by "buf" parameter. If the input string contains any of the characters specified in the "specials" parameters, the output string is wrapped in double quoted. Additionally, any backslashes or quotes inside the input string are backslash-escaped.

Definition at line 715 of file address.c.

716{
717 if (!buf || !value || !specials)
718 return;
719
720 if (strpbrk(value, specials))
721 {
722 if (buflen < 4)
723 {
724 mutt_str_copy(buf, value, buflen);
725 return;
726 }
727
728 char *pc = buf;
729 size_t remaining = buflen - 3; // Reserve for opening quote, closing quote, NUL
730
731 *pc++ = '"';
732 for (; *value && (remaining > 1); value++)
733 {
734 if ((*value == '\\') || (*value == '"'))
735 {
736 *pc++ = '\\';
737 remaining--;
738 }
739 *pc++ = *value;
740 remaining--;
741 }
742 *pc++ = '"';
743 *pc = '\0';
744 }
745 else
746 {
747 mutt_str_copy(buf, value, buflen);
748 }
749}
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:587
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_copy()

struct Address * mutt_addr_copy ( const struct Address * addr)

Copy the real address.

Parameters
addrAddress to copy
Return values
ptrNew Address

Definition at line 756 of file address.c.

757{
758 if (!addr)
759 return NULL;
760
761 struct Address *p = mutt_addr_new();
762 p->personal = buf_dup(addr->personal);
763 p->mailbox = buf_dup(addr->mailbox);
764 p->group = addr->group;
765 p->is_intl = addr->is_intl;
766 p->intl_checked = addr->intl_checked;
767 return p;
768}
struct Buffer * buf_dup(const struct Buffer *buf)
Copy a Buffer into a new allocated buffer.
Definition buffer.c:592
bool intl_checked
Checked for IDN?
Definition address.h:40
bool is_intl
International Domain Name.
Definition address.h:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_copy()

void mutt_addrlist_copy ( struct AddressList * dst,
const struct AddressList * src,
bool prune )

Copy a list of addresses into another list.

Parameters
dstDestination Address list
srcSource Address list
pruneSkip groups if there are more addresses

Definition at line 776 of file address.c.

777{
778 if (!dst || !src)
779 return;
780
781 struct Address *a = NULL;
782 TAILQ_FOREACH(a, src, entries)
783 {
784 struct Address *next = TAILQ_NEXT(a, entries);
785 if (prune && a->group && (!next || !next->mailbox))
786 {
787 /* ignore this element of the list */
788 }
789 else
790 {
792 }
793 }
794}
struct Address * mutt_addr_copy(const struct Address *addr)
Copy the real address.
Definition address.c:756
#define TAILQ_NEXT(elm, field)
Definition queue.h:889
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_valid_msgid()

bool mutt_addr_valid_msgid ( const char * msgid)

Is this a valid Message ID?

Parameters
msgidMessage ID
Return values
trueIt is a valid message ID

Incomplete. Only used to thwart the APOP MD5 attack

Definition at line 803 of file address.c.

804{
805 /* msg-id = "<" addr-spec ">"
806 * addr-spec = local-part "@" domain
807 * local-part = word *("." word)
808 * word = atom / quoted-string
809 * atom = 1*<any CHAR except specials, SPACE and CTLs>
810 * CHAR = ( 0.-127. )
811 * specials = "(" / ")" / "<" / ">" / "@"
812 * / "," / ";" / ":" / "\" / <">
813 * / "." / "[" / "]"
814 * SPACE = ( 32. )
815 * CTLS = ( 0.-31., 127.)
816 * quoted-string = <"> *(qtext/quoted-pair) <">
817 * qtext = <any CHAR except <">, "\" and CR>
818 * CR = ( 13. )
819 * quoted-pair = "\" CHAR
820 * domain = sub-domain *("." sub-domain)
821 * sub-domain = domain-ref / domain-literal
822 * domain-ref = atom
823 * domain-literal = "[" *(dtext / quoted-pair) "]"
824 */
825
826 if (!msgid || (*msgid == '\0'))
827 return false;
828
829 size_t l = mutt_str_len(msgid);
830 if (l < 5) /* <atom@atom> */
831 return false;
832 if ((msgid[0] != '<') || (msgid[l - 1] != '>'))
833 return false;
834 if (!(strrchr(msgid, '@')))
835 return false;
836
837 /* TODO: complete parser */
838 for (size_t i = 0; i < l; i++)
839 if ((unsigned char) msgid[i] > 127)
840 return false;
841
842 return true;
843}
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition string.c:503
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_equal()

bool mutt_addrlist_equal ( const struct AddressList * ala,
const struct AddressList * alb )

Compare two Address lists for equality.

Parameters
alaFirst Address
albSecond Address
Return values
trueAddress lists are strictly identical

Definition at line 851 of file address.c.

852{
853 if (!ala || !alb)
854 {
855 return !(ala || alb);
856 }
857
858 struct Address *ana = TAILQ_FIRST(ala);
859 struct Address *anb = TAILQ_FIRST(alb);
860
861 while (ana && anb)
862 {
863 if (!buf_str_equal(ana->mailbox, anb->mailbox) ||
864 !buf_str_equal(ana->personal, anb->personal))
865 {
866 break;
867 }
868
869 ana = TAILQ_NEXT(ana, entries);
870 anb = TAILQ_NEXT(anb, entries);
871 }
872
873 return !(ana || anb);
874}
bool buf_str_equal(const struct Buffer *a, const struct Buffer *b)
Return if two buffers are equal.
Definition buffer.c:689
#define TAILQ_FIRST(head)
Definition queue.h:780
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_count_recips()

int mutt_addrlist_count_recips ( const struct AddressList * al)

Count the number of Addresses with valid recipients.

Parameters
alAddress list
Return values
numNumber of valid Addresses

An Address has a recipient if the mailbox is set and is not a group

Definition at line 883 of file address.c.

884{
885 if (!al)
886 return 0;
887
888 int c = 0;
889 struct Address *a = NULL;
890 TAILQ_FOREACH(a, al, entries)
891 {
892 c += (a->mailbox && !a->group);
893 }
894 return c;
895}
+ Here is the caller graph for this function:

◆ mutt_addr_cmp()

bool mutt_addr_cmp ( const struct Address * a,
const struct Address * b )

Compare two e-mail addresses.

Parameters
aAddress 1
bAddress 2
Return values
trueThey are equivalent

Definition at line 903 of file address.c.

904{
905 if (!a || !b)
906 return false;
907 if (!a->mailbox || !b->mailbox)
908 return false;
909 if (!buf_istr_equal(a->mailbox, b->mailbox))
910 return false;
911 return true;
912}
bool buf_istr_equal(const struct Buffer *a, const struct Buffer *b)
Return if two buffers are equal, case insensitive.
Definition buffer.c:701
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_search()

bool mutt_addrlist_search ( const struct AddressList * haystack,
const struct Address * needle )

Search for an e-mail address in a list.

Parameters
haystackAddress List
needleAddress containing the search email
Return values
trueThe Address is in the list

Definition at line 920 of file address.c.

921{
922 if (!needle || !haystack)
923 return false;
924
925 struct Address *a = NULL;
926 TAILQ_FOREACH(a, haystack, entries)
927 {
928 if (mutt_addr_cmp(needle, a))
929 return true;
930 }
931 return false;
932}
bool mutt_addr_cmp(const struct Address *a, const struct Address *b)
Compare two e-mail addresses.
Definition address.c:903
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addr_is_intl()

static bool addr_is_intl ( const struct Address * a)
static

Does the Address have IDN components.

Parameters
aAddress to check
Return values
trueAddress contains IDN components

Definition at line 939 of file address.c.

940{
941 if (!a)
942 return false;
943 return a->intl_checked && a->is_intl;
944}
+ Here is the caller graph for this function:

◆ addr_is_local()

static bool addr_is_local ( const struct Address * a)
static

Does the Address have NO IDN components.

Parameters
aAddress to check
Return values
trueAddress contains NO IDN components

Definition at line 951 of file address.c.

952{
953 if (!a)
954 return false;
955 return a->intl_checked && !a->is_intl;
956}
+ Here is the caller graph for this function:

◆ addr_mbox_to_udomain()

static int addr_mbox_to_udomain ( const char * mbox,
char ** user,
char ** domain )
static

Split a mailbox name into user and domain.

Parameters
[in]mboxMailbox name to split
[out]userUser
[out]domainDomain
Return values
0Success
-1Error
Warning
The caller must free user and domain

Definition at line 968 of file address.c.

969{
970 if (!mbox || !user || !domain)
971 return -1;
972
973 const char *ptr = strchr(mbox, '@');
974
975 /* Fail if '@' is missing, at the start, or at the end */
976 if (!ptr || (ptr == mbox) || (ptr[1] == '\0'))
977 return -1;
978
979 *user = mutt_strn_dup(mbox, ptr - mbox);
980 *domain = mutt_str_dup(ptr + 1);
981
982 return 0;
983}
char * mutt_strn_dup(const char *begin, size_t len)
Duplicate a sub-string.
Definition string.c:384
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addr_set_intl()

static void addr_set_intl ( struct Address * a,
char * intl_mailbox )
static

Mark an Address as having IDN components.

Parameters
aAddress to modify
intl_mailboxEmail address with IDN components

Definition at line 990 of file address.c.

991{
992 if (!a)
993 return;
994
995 buf_strcpy(a->mailbox, intl_mailbox);
996 a->intl_checked = true;
997 a->is_intl = true;
998}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition buffer.c:401
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addr_set_local()

static void addr_set_local ( struct Address * a,
char * local_mailbox )
static

Mark an Address as having NO IDN components.

Parameters
aAddress
local_mailboxEmail address with NO IDN components

Definition at line 1005 of file address.c.

1006{
1007 if (!a)
1008 return;
1009
1010 buf_strcpy(a->mailbox, local_mailbox);
1011 a->intl_checked = true;
1012 a->is_intl = false;
1013}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_for_display()

const char * mutt_addr_for_display ( const struct Address * a)

Convert an Address for display purposes.

Parameters
aAddress to convert
Return values
ptrAddress to display
Warning
This function may return a static pointer. It must not be freed by the caller. Later calls may overwrite the returned pointer.

Definition at line 1023 of file address.c.

1024{
1025 if (!a)
1026 return NULL;
1027
1028 char *user = NULL;
1029 char *domain = NULL;
1030 static char *buf = NULL;
1031
1032 if (!a->mailbox || addr_is_local(a))
1033 return buf_string(a->mailbox);
1034
1035 if (addr_mbox_to_udomain(buf_string(a->mailbox), &user, &domain) == -1)
1036 return buf_string(a->mailbox);
1037
1038 char *local_mailbox = mutt_idna_intl_to_local(user, domain, MI_MAY_BE_IRREVERSIBLE);
1039
1040 FREE(&user);
1041 FREE(&domain);
1042
1043 if (!local_mailbox)
1044 return buf_string(a->mailbox);
1045
1046 mutt_str_replace(&buf, local_mailbox);
1047 FREE(&local_mailbox);
1048
1049 return buf;
1050}
static int addr_mbox_to_udomain(const char *mbox, char **user, char **domain)
Split a mailbox name into user and domain.
Definition address.c:968
static bool addr_is_local(const struct Address *a)
Does the Address have NO IDN components.
Definition address.c:951
#define MI_MAY_BE_IRREVERSIBLE
Definition idna2.h:30
char * mutt_idna_intl_to_local(const char *user, const char *domain, uint8_t flags)
Convert an email's domain from Punycode.
Definition idna.c:117
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition string.c:284
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_write()

size_t mutt_addr_write ( struct Buffer * buf,
struct Address * addr,
bool display )

Write a single Address to a buffer.

Parameters
bufBuffer for the Address
addrAddress to display
displayThis address will be displayed to the user
Return values
numLength of the string written to buf

If 'display' is set, then it doesn't matter if the transformation isn't reversible.

Definition at line 1062 of file address.c.

1063{
1064 if (!buf || !addr || (!addr->personal && !addr->mailbox))
1065 {
1066 return 0;
1067 }
1068
1069 const size_t initial_len = buf_len(buf);
1070
1071 if (addr->personal)
1072 {
1073 if (strpbrk(buf_string(addr->personal), AddressSpecials) ||
1075 {
1076 buf_addch(buf, '"');
1077 for (const char *pc = buf_string(addr->personal); *pc; pc++)
1078 {
1079 if ((*pc == '"') || (*pc == '\\'))
1080 {
1081 buf_addch(buf, '\\');
1082 }
1083 buf_addch(buf, *pc);
1084 }
1085 buf_addch(buf, '"');
1086 }
1087 else
1088 {
1089 buf_addstr(buf, buf_string(addr->personal));
1090 }
1091
1092 buf_addch(buf, ' ');
1093 }
1094
1095 if (addr->personal || (addr->mailbox && (buf_at(addr->mailbox, 0) == '@')))
1096 {
1097 buf_addch(buf, '<');
1098 }
1099
1100 if (addr->mailbox)
1101 {
1102 if (!mutt_str_equal(buf_string(addr->mailbox), "@"))
1103 {
1104 const char *a = display ? mutt_addr_for_display(addr) : buf_string(addr->mailbox);
1105 buf_addstr(buf, a);
1106 }
1107
1108 if (addr->personal || (addr->mailbox && (buf_at(addr->mailbox, 0) == '@')))
1109 {
1110 buf_addch(buf, '>');
1111 }
1112
1113 if (addr->group)
1114 {
1115 buf_addstr(buf, ": ");
1116 }
1117 }
1118 else
1119 {
1120 buf_addch(buf, ';');
1121 }
1122
1123 return buf_len(buf) - initial_len;
1124}
bool mutt_addr_uses_unicode(const char *str)
Does this address use Unicode character.
Definition address.c:1518
const char AddressSpecials[]
Characters with special meaning for email addresses.
Definition address.c:45
const char * mutt_addr_for_display(const struct Address *a)
Convert an Address for display purposes.
Definition address.c:1023
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition buffer.c:497
char buf_at(const struct Buffer *buf, size_t offset)
Return the character at the given offset.
Definition buffer.c:674
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition buffer.c:248
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition buffer.c:233
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition string.c:666
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addrlist_write()

static size_t addrlist_write ( const struct AddressList * al,
struct Buffer * buf,
bool display,
const char * header,
int cols )
static

Write an AddressList to a buffer, optionally perform line wrapping and display conversion.

Parameters
alAddressList to display
bufBuffer for the Address
displayTrue if these addresses will be displayed to the user
headerHeader name; if present, addresses we be written after ": "
colsMax columns at which to wrap, disabled if -1
Return values
numLength of the string written to buf

If 'display' is set, then it doesn't matter if the transformation isn't reversible.

Definition at line 1139 of file address.c.

1141{
1142 if (!buf || !al || TAILQ_EMPTY(al))
1143 return 0;
1144
1145 if (header)
1146 {
1147 buf_printf(buf, "%s: ", header);
1148 }
1149
1150 size_t cur_col = buf_len(buf);
1151 bool in_group = false;
1152 struct Address *a = NULL;
1153 TAILQ_FOREACH(a, al, entries)
1154 {
1155 struct Address *next = TAILQ_NEXT(a, entries);
1156
1157 if (a->group)
1158 {
1159 in_group = true;
1160 }
1161
1162 // wrap if needed
1163 const size_t cur_len = buf_len(buf);
1164 cur_col += mutt_addr_write(buf, a, display);
1165 if ((cols > 0) && (cur_col > cols) && (a != TAILQ_FIRST(al)))
1166 {
1167 buf_insert(buf, cur_len, "\n\t");
1168 cur_col = 8;
1169 }
1170
1171 if (!a->group)
1172 {
1173 // group terminator
1174 if (in_group && !a->mailbox && !a->personal)
1175 {
1176 buf_addch(buf, ';');
1177 cur_col++;
1178 in_group = false;
1179 }
1180 if (next && (next->mailbox || next->personal))
1181 {
1182 buf_addstr(buf, ", ");
1183 cur_col += 2;
1184 }
1185 if (!next)
1186 {
1187 break;
1188 }
1189 }
1190 }
1191
1192 return buf_len(buf);
1193}
size_t mutt_addr_write(struct Buffer *buf, struct Address *addr, bool display)
Write a single Address to a buffer.
Definition address.c:1062
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition buffer.c:168
size_t buf_insert(struct Buffer *buf, size_t offset, const char *s)
Add a string in the middle of a buffer.
Definition buffer.c:263
#define TAILQ_EMPTY(head)
Definition queue.h:778
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_write_wrap()

size_t mutt_addrlist_write_wrap ( const struct AddressList * al,
struct Buffer * buf,
const char * header )

Write an AddressList to a buffer, perform line wrapping.

Parameters
alAddressList to display
bufBuffer for the Address
headerHeader name; if present, addresses we be written after ": "
Return values
numLength of the string written to buf

Definition at line 1202 of file address.c.

1204{
1205 return addrlist_write(al, buf, false, header, 74);
1206}
static size_t addrlist_write(const struct AddressList *al, struct Buffer *buf, bool display, const char *header, int cols)
Write an AddressList to a buffer, optionally perform line wrapping and display conversion.
Definition address.c:1139
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_write()

size_t mutt_addrlist_write ( const struct AddressList * al,
struct Buffer * buf,
bool display )

Write an Address to a buffer.

Parameters
alAddressList to display
bufBuffer for the Address
displayThis address will be displayed to the user
Return values
numLength of the string written to buf

If 'display' is set, then it doesn't matter if the transformation isn't reversible.

Definition at line 1219 of file address.c.

1220{
1221 return addrlist_write(al, buf, display, NULL, -1);
1222}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_write_list()

size_t mutt_addrlist_write_list ( const struct AddressList * al,
struct ListHead * list )

Write Addresses to a List.

Parameters
alAddressList to write
listList for the Addresses
Return values
numNumber of addresses written

Definition at line 1230 of file address.c.

1231{
1232 if (!al || !list)
1233 return 0;
1234
1235 size_t count = 0;
1236 struct Address *a = NULL;
1237 TAILQ_FOREACH(a, al, entries)
1238 {
1239 struct Buffer buf = { 0 };
1240 mutt_addr_write(&buf, a, true);
1241 if (!buf_is_empty(&buf))
1242 {
1243 /* We're taking the ownership of the buffer string here */
1244 mutt_list_insert_tail(list, (char *) buf_string(&buf));
1245 count++;
1246 }
1247 }
1248
1249 return count;
1250}
struct ListNode * mutt_list_insert_tail(struct ListHead *h, char *s)
Append a string to the end of a List.
Definition list.c:65
String manipulation buffer.
Definition buffer.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_write_file()

void mutt_addrlist_write_file ( const struct AddressList * al,
FILE * fp,
const char * header )

Wrapper for mutt_write_address()

Parameters
alAddress list
fpFile to write to
headerHeader name; if present, addresses we be written after ": "

So we can handle very large recipient lists without needing a huge temporary buffer in memory

Definition at line 1261 of file address.c.

1262{
1263 struct Buffer *buf = buf_pool_get();
1264 mutt_addrlist_write_wrap(al, buf, header);
1265 fputs(buf_string(buf), fp);
1266 buf_pool_release(&buf);
1267 fputc('\n', fp);
1268}
size_t mutt_addrlist_write_wrap(const struct AddressList *al, struct Buffer *buf, const char *header)
Write an AddressList to a buffer, perform line wrapping.
Definition address.c:1202
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_to_intl()

bool mutt_addr_to_intl ( struct Address * a)

Convert an Address to Punycode.

Parameters
aAddress to convert
Return values
trueSuccess
falseOtherwise

Definition at line 1276 of file address.c.

1277{
1278 if (!a || !a->mailbox || addr_is_intl(a))
1279 return true;
1280
1281 char *user = NULL;
1282 char *domain = NULL;
1283 if (addr_mbox_to_udomain(buf_string(a->mailbox), &user, &domain) == -1)
1284 return true;
1285
1286 char *intl_mailbox = mutt_idna_local_to_intl(user, domain);
1287
1288 FREE(&user);
1289 FREE(&domain);
1290
1291 if (!intl_mailbox)
1292 return false;
1293
1294 addr_set_intl(a, intl_mailbox);
1295 FREE(&intl_mailbox);
1296 return true;
1297}
static bool addr_is_intl(const struct Address *a)
Does the Address have IDN components.
Definition address.c:939
static void addr_set_intl(struct Address *a, char *intl_mailbox)
Mark an Address as having IDN components.
Definition address.c:990
char * mutt_idna_local_to_intl(const char *user, const char *domain)
Convert an email's domain to Punycode.
Definition idna.c:228
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_to_intl()

int mutt_addrlist_to_intl ( struct AddressList * al,
char ** err )

Convert an Address list to Punycode.

Parameters
[in]alAddress list to modify
[out]errPointer for failed addresses
Return values
0Success, all addresses converted
-1Error, err will be set to the failed address

Definition at line 1306 of file address.c.

1307{
1308 if (!al)
1309 return 0;
1310
1311 int rc = 0;
1312
1313 if (err)
1314 *err = NULL;
1315
1316 struct Address *a = NULL;
1317 TAILQ_FOREACH(a, al, entries)
1318 {
1319 if (!a->mailbox || addr_is_intl(a))
1320 continue;
1321
1322 char *user = NULL;
1323 char *domain = NULL;
1324 if (addr_mbox_to_udomain(buf_string(a->mailbox), &user, &domain) == -1)
1325 continue;
1326
1327 char *intl_mailbox = mutt_idna_local_to_intl(user, domain);
1328
1329 FREE(&user);
1330 FREE(&domain);
1331
1332 if (!intl_mailbox)
1333 {
1334 rc = -1;
1335 if (err && !*err)
1336 *err = buf_strdup(a->mailbox);
1337 continue;
1338 }
1339
1340 addr_set_intl(a, intl_mailbox);
1341 FREE(&intl_mailbox);
1342 }
1343
1344 return rc;
1345}
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:577
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addr_to_local()

bool mutt_addr_to_local ( struct Address * a)

Convert an Address from Punycode.

Parameters
aAddress to convert
Return values
trueSuccess
falseOtherwise

Definition at line 1353 of file address.c.

1354{
1355 if (!a || !a->mailbox)
1356 {
1357 return false;
1358 }
1359
1360 if (addr_is_local(a))
1361 {
1362 return true;
1363 }
1364
1365 char *user = NULL;
1366 char *domain = NULL;
1367 if (addr_mbox_to_udomain(buf_string(a->mailbox), &user, &domain) == -1)
1368 {
1369 return false;
1370 }
1371
1372 char *local_mailbox = mutt_idna_intl_to_local(user, domain, MI_NONE);
1373 FREE(&user);
1374 FREE(&domain);
1375
1376 if (!local_mailbox)
1377 {
1378 return false;
1379 }
1380
1381 addr_set_local(a, local_mailbox);
1382 FREE(&local_mailbox);
1383 return true;
1384}
static void addr_set_local(struct Address *a, char *local_mailbox)
Mark an Address as having NO IDN components.
Definition address.c:1005
#define MI_NONE
Definition idna2.h:29
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_to_local()

int mutt_addrlist_to_local ( struct AddressList * al)

Convert an Address list from Punycode.

Parameters
alAddress list to modify
Return values
0Always

Definition at line 1391 of file address.c.

1392{
1393 if (!al)
1394 return 0;
1395
1396 struct Address *a = NULL;
1397 TAILQ_FOREACH(a, al, entries)
1398 {
1400 }
1401 return 0;
1402}
bool mutt_addr_to_local(struct Address *a)
Convert an Address from Punycode.
Definition address.c:1353
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_dedupe()

void mutt_addrlist_dedupe ( struct AddressList * al)

Remove duplicate addresses.

Parameters
alAddress list to de-dupe

Given a list of addresses, return a list of unique addresses

Definition at line 1410 of file address.c.

1411{
1412 if (!al)
1413 return;
1414
1415 struct Address *a = NULL;
1416 TAILQ_FOREACH(a, al, entries)
1417 {
1418 if (a->mailbox)
1419 {
1420 struct Address *a2 = TAILQ_NEXT(a, entries);
1421 struct Address *tmp = NULL;
1422
1423 if (a2)
1424 {
1425 TAILQ_FOREACH_FROM_SAFE(a2, al, entries, tmp)
1426 {
1427 if (a2->mailbox && buf_istr_equal(a->mailbox, a2->mailbox))
1428 {
1429 mutt_debug(LL_DEBUG2, "Removing %s\n", buf_string(a2->mailbox));
1430 TAILQ_REMOVE(al, a2, entries);
1431 mutt_addr_free(&a2);
1432 }
1433 }
1434 }
1435 }
1436 }
1437}
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
@ LL_DEBUG2
Log at debug level 2.
Definition logging2.h:46
#define TAILQ_FOREACH_FROM_SAFE(var, head, field, tvar)
Definition queue.h:797
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_remove_xrefs()

void mutt_addrlist_remove_xrefs ( const struct AddressList * a,
struct AddressList * b )

Remove cross-references.

Parameters
aReference AddressList
bAddressLis to trim

Remove addresses from "b" which are contained in "a"

Definition at line 1446 of file address.c.

1447{
1448 if (!a || !b)
1449 return;
1450
1451 struct Address *aa = NULL;
1452 struct Address *ab = NULL;
1453 struct Address *tmp = NULL;
1454
1455 TAILQ_FOREACH_SAFE(ab, b, entries, tmp)
1456 {
1457 TAILQ_FOREACH(aa, a, entries)
1458 {
1459 if (mutt_addr_cmp(aa, ab))
1460 {
1461 TAILQ_REMOVE(b, ab, entries);
1462 mutt_addr_free(&ab);
1463 break;
1464 }
1465 }
1466 }
1467}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_clear()

void mutt_addrlist_clear ( struct AddressList * al)

Unlink and free all Address in an AddressList.

Parameters
alAddressList
Note
After this call, the AddressList is reinitialized and ready for reuse.

Definition at line 1475 of file address.c.

1476{
1477 if (!al)
1478 return;
1479
1480 struct Address *a = TAILQ_FIRST(al);
1481 struct Address *next = NULL;
1482 while (a)
1483 {
1484 next = TAILQ_NEXT(a, entries);
1485 mutt_addr_free(&a);
1486 a = next;
1487 }
1488 TAILQ_INIT(al);
1489}
#define TAILQ_INIT(head)
Definition queue.h:822
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_addrlist_append()

void mutt_addrlist_append ( struct AddressList * al,
struct Address * a )

Append an Address to an AddressList.

Parameters
alAddressList
aAddress

Definition at line 1496 of file address.c.

1497{
1498 if (al && a)
1499 TAILQ_INSERT_TAIL(al, a, entries);
1500}
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition queue.h:866
+ Here is the caller graph for this function:

◆ mutt_addrlist_prepend()

void mutt_addrlist_prepend ( struct AddressList * al,
struct Address * a )

Prepend an Address to an AddressList.

Parameters
alAddressList
aAddress

Definition at line 1507 of file address.c.

1508{
1509 if (al && a)
1510 TAILQ_INSERT_HEAD(al, a, entries);
1511}
#define TAILQ_INSERT_HEAD(head, elm, field)
Definition queue.h:853
+ Here is the caller graph for this function:

◆ mutt_addr_uses_unicode()

bool mutt_addr_uses_unicode ( const char * str)

Does this address use Unicode character.

Parameters
strAddress string to check
Return values
trueThe string uses 8-bit characters

Definition at line 1518 of file address.c.

1519{
1520 if (!str)
1521 return false;
1522
1523 while (*str)
1524 {
1525 if ((unsigned char) *str & (1 << 7))
1526 return true;
1527 str++;
1528 }
1529
1530 return false;
1531}
+ Here is the caller graph for this function:

◆ mutt_addrlist_uses_unicode()

bool mutt_addrlist_uses_unicode ( const struct AddressList * al)

Do any of a list of addresses use Unicode characters.

Parameters
alAddress list to check
Return values
trueAny use 8-bit characters

Definition at line 1538 of file address.c.

1539{
1540 if (!al)
1541 {
1542 return false;
1543 }
1544
1545 struct Address *a = NULL;
1546 TAILQ_FOREACH(a, al, entries)
1547 {
1549 return true;
1550 }
1551 return false;
1552}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ AddressSpecials

const char AddressSpecials[] = "\"(),.:;<>@[\\]"

Characters with special meaning for email addresses.

Definition at line 45 of file address.c.