NeoMutt  2020-11-20
Teaching an old dog new tricks
DOXYGEN
address.h
Go to the documentation of this file.
1 
24 #ifndef MUTT_EMAIL_ADDRESS_H
25 #define MUTT_EMAIL_ADDRESS_H
26 
27 #include <stddef.h>
28 #include <stdbool.h>
29 #include "mutt/lib.h"
30 
34 struct Address
35 {
36  char *personal;
37  char *mailbox;
38  bool group : 1;
39  bool is_intl : 1;
40  bool intl_checked : 1;
41  TAILQ_ENTRY(Address) entries;
42 };
43 TAILQ_HEAD(AddressList, Address);
44 
49 {
56 };
57 
58 extern int AddressError;
59 extern const char *const AddressErrors[];
60 extern const char AddressSpecials[];
61 
62 #define address_error(num) AddressErrors[num]
63 
69 typedef bool (*addr_predicate_t)(const struct Address *a);
70 
71 /* Utility functions that don't use struct Address or struct AddressList */
72 void mutt_addr_cat (char *buf, size_t buflen, const char *value, const char *specials);
73 bool mutt_addr_valid_msgid(const char *msgid);
74 
75 /* Functions that work on a single struct Address */
76 bool mutt_addr_cmp (const struct Address *a, const struct Address *b);
77 struct Address *mutt_addr_copy (const struct Address *addr);
78 struct Address *mutt_addr_create (const char *personal, const char *mailbox);
79 const char * mutt_addr_for_display(const struct Address *a);
80 void mutt_addr_free (struct Address **ptr);
81 struct Address *mutt_addr_new (void);
82 bool mutt_addr_to_intl (struct Address *a);
83 bool mutt_addr_to_local (struct Address *a);
84 bool mutt_addr_uses_unicode(const char *str);
85 size_t mutt_addr_write (char *buf, size_t buflen, struct Address *addr, bool display);
86 
87 /* Functions that work on struct AddressList */
88 void mutt_addrlist_append (struct AddressList *al, struct Address *a);
89 void mutt_addrlist_clear (struct AddressList *al);
90 void mutt_addrlist_copy (struct AddressList *dst, const struct AddressList *src, bool prune);
91 int mutt_addrlist_count_recips(const struct AddressList *al);
92 void mutt_addrlist_dedupe (struct AddressList *al);
93 bool mutt_addrlist_equal (const struct AddressList *ala, const struct AddressList *alb);
94 int mutt_addrlist_parse (struct AddressList *al, const char *s);
95 int mutt_addrlist_parse2 (struct AddressList *al, const char *s);
96 void mutt_addrlist_prepend (struct AddressList *al, struct Address *a);
97 void mutt_addrlist_qualify (struct AddressList *al, const char *host);
98 int mutt_addrlist_remove (struct AddressList *al, const char *mailbox);
99 void mutt_addrlist_remove_xrefs(const struct AddressList *a, struct AddressList *b);
100 bool mutt_addrlist_search (const struct AddressList *haystack, const struct Address *needle);
101 int mutt_addrlist_to_intl (struct AddressList *al, char **err);
102 int mutt_addrlist_to_local (struct AddressList *al);
103 bool mutt_addrlist_uses_unicode(const struct AddressList *al);
104 size_t mutt_addrlist_write (const struct AddressList *al, char *buf, size_t buflen, bool display);
105 void mutt_addrlist_write_file (const struct AddressList *addr, FILE *fp, int start_col, bool display);
106 size_t mutt_addrlist_write_list (const struct AddressList *al, struct ListHead *list);
107 
108 #endif /* MUTT_EMAIL_ADDRESS_H */
void mutt_addrlist_prepend(struct AddressList *al, struct Address *a)
Prepend an Address to an AddressList.
Definition: address.c:1499
void mutt_addrlist_copy(struct AddressList *dst, const struct AddressList *src, bool prune)
Copy a list of addresses into another list.
Definition: address.c:737
TAILQ_HEAD(AddressList, Address)
TAILQ_ENTRY(Address) entries
Linked list.
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.
Definition: address.c:681
const char AddressSpecials[]
Characters with special meaning for email addresses.
Definition: address.c:42
bool mutt_addr_valid_msgid(const char *msgid)
Is this a valid Message ID?
Definition: address.c:764
struct Address * mutt_addr_copy(const struct Address *addr)
Copy the real address.
Definition: address.c:716
void mutt_addrlist_dedupe(struct AddressList *al)
Remove duplicate addresses.
Definition: address.c:1405
An email address.
Definition: address.h:34
char * mailbox
Mailbox and host address.
Definition: address.h:37
bool mutt_addr_to_local(struct Address *a)
Convert an Address from Punycode.
Definition: address.c:1349
const char *const AddressErrors[]
Messages for the error codes in AddressError.
Definition: address.c:64
Bad route address.
Definition: address.h:54
size_t mutt_addr_write(char *buf, size_t buflen, struct Address *addr, bool display)
Write a single Address to a buffer.
Definition: address.c:1025
bool is_intl
International Domain Name.
Definition: address.h:39
void mutt_addr_free(struct Address **ptr)
Free a single Address.
Definition: address.c:440
struct Address * mutt_addr_create(const char *personal, const char *mailbox)
Create and populate a new Address.
Definition: address.c:398
int mutt_addrlist_to_local(struct AddressList *al)
Convert an Address list from Punycode.
Definition: address.c:1386
void mutt_addrlist_clear(struct AddressList *al)
Unlink and free all Address in an AddressList.
Definition: address.c:1468
bool mutt_addr_cmp(const struct Address *a, const struct Address *b)
Compare two e-mail addresses.
Definition: address.c:864
bool mutt_addrlist_equal(const struct AddressList *ala, const struct AddressList *alb)
Compare two Address lists for equality.
Definition: address.c:812
bool(* addr_predicate_t)(const struct Address *a)
Test an Address for some condition.
Definition: address.h:69
void mutt_addrlist_append(struct AddressList *al, struct Address *a)
Append an Address to an AddressList.
Definition: address.c:1488
void mutt_addrlist_write_file(const struct AddressList *addr, FILE *fp, int start_col, bool display)
Wrapper for mutt_write_address()
Definition: address.c:1231
bool intl_checked
Checked for IDN?
Definition: address.h:40
void mutt_addrlist_qualify(struct AddressList *al, const char *host)
Expand local names in an Address list using a hostname.
Definition: address.c:650
Mismatches quotes.
Definition: address.h:52
bool mutt_addr_to_intl(struct Address *a)
Convert an Address to Punycode.
Definition: address.c:1275
AddressError
possible values for AddressError
Definition: address.h:48
int mutt_addrlist_parse(struct AddressList *al, const char *s)
Parse a list of email addresses.
Definition: address.c:458
Bad address specifier.
Definition: address.h:55
Out of memory.
Definition: address.h:50
bool mutt_addrlist_search(const struct AddressList *haystack, const struct Address *needle)
Search for an e-mail address in a list.
Definition: address.c:881
int mutt_addrlist_parse2(struct AddressList *al, const char *s)
Parse a list of email addresses.
Definition: address.c:616
int mutt_addrlist_to_intl(struct AddressList *al, char **err)
Convert an Address list to Punycode.
Definition: address.c:1304
bool mutt_addrlist_uses_unicode(const struct AddressList *al)
Do any of a list of addresses use Unicode characters.
Definition: address.c:1530
char * personal
Real name of address.
Definition: address.h:36
bool group
Group mailbox?
Definition: address.h:38
void mutt_addrlist_remove_xrefs(const struct AddressList *a, struct AddressList *b)
Remove cross-references.
Definition: address.c:1441
const char * mutt_addr_for_display(const struct Address *a)
Convert an Address for display purposes.
Definition: address.c:986
struct Address * mutt_addr_new(void)
Create a new Address.
Definition: address.c:385
int mutt_addrlist_count_recips(const struct AddressList *al)
Count the number of Addresses with valid recipients.
Definition: address.c:844
Mismatched parentheses.
Definition: address.h:51
Bad route.
Definition: address.h:53
size_t mutt_addrlist_write(const struct AddressList *al, char *buf, size_t buflen, bool display)
Write an Address to a buffer.
Definition: address.c:1150
int mutt_addrlist_remove(struct AddressList *al, const char *mailbox)
Remove an Address from a list.
Definition: address.c:413
Convenience wrapper for the library headers.
size_t mutt_addrlist_write_list(const struct AddressList *al, struct ListHead *list)
Write Addresses to a List.
Definition: address.c:1201
bool mutt_addr_uses_unicode(const char *str)
Does this address use Unicode character.
Definition: address.c:1510