address.h

Go to the documentation of this file.

 
#ifndef MUTT_ADDRESS_ADDRESS_H
#define MUTT_ADDRESS_ADDRESS_H
 
#include <stddef.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
 
struct Address
{
  char *personal;               
  char *mailbox;                
  bool group : 1;               
  bool is_intl : 1;             
  bool intl_checked : 1;        
  TAILQ_ENTRY(Address) entries; 
};
TAILQ_HEAD(AddressList, Address);
 
enum AddressError
{
  ADDR_ERR_MEMORY = 1,     
  ADDR_ERR_MISMATCH_PAREN, 
  ADDR_ERR_MISMATCH_QUOTE, 
  ADDR_ERR_BAD_ROUTE,      
  ADDR_ERR_BAD_ROUTE_ADDR, 
  ADDR_ERR_BAD_ADDR_SPEC,  
};
 
extern int AddressError;
extern const char *const AddressErrors[];
extern const char AddressSpecials[];
 
#define address_error(num) AddressErrors[num]
 
typedef bool (*addr_predicate_t)(const struct Address *a);
 
/* Utility functions that don't use struct Address or struct AddressList */
void mutt_addr_cat        (char *buf, size_t buflen, const char *value, const char *specials);
bool mutt_addr_valid_msgid(const char *msgid);
 
/* Functions that work on a single struct Address */
bool            mutt_addr_cmp        (const struct Address *a, const struct Address *b);
struct Address *mutt_addr_copy       (const struct Address *addr);
struct Address *mutt_addr_create     (const char *personal, const char *mailbox);
const char *    mutt_addr_for_display(const struct Address *a);
void            mutt_addr_free       (struct Address **ptr);
struct Address *mutt_addr_new        (void);
bool            mutt_addr_to_intl    (struct Address *a);
bool            mutt_addr_to_local   (struct Address *a);
bool            mutt_addr_uses_unicode(const char *str);
size_t          mutt_addr_write      (struct Buffer *buf, struct Address *addr, bool display);
 
/* Functions that work on struct AddressList */
void   mutt_addrlist_append      (struct AddressList *al, struct Address *a);
void   mutt_addrlist_clear       (struct AddressList *al);
void   mutt_addrlist_copy        (struct AddressList *dst, const struct AddressList *src, bool prune);
int    mutt_addrlist_count_recips(const struct AddressList *al);
void   mutt_addrlist_dedupe      (struct AddressList *al);
bool   mutt_addrlist_equal       (const struct AddressList *ala, const struct AddressList *alb);
int    mutt_addrlist_parse       (struct AddressList *al, const char *s);
int    mutt_addrlist_parse2      (struct AddressList *al, const char *s);
void   mutt_addrlist_prepend     (struct AddressList *al, struct Address *a);
void   mutt_addrlist_qualify     (struct AddressList *al, const char *host);
int    mutt_addrlist_remove      (struct AddressList *al, const char *mailbox);
void   mutt_addrlist_remove_xrefs(const struct AddressList *a, struct AddressList *b);
bool   mutt_addrlist_search      (const struct AddressList *haystack, const struct Address *needle);
int    mutt_addrlist_to_intl     (struct AddressList *al, char **err);
int    mutt_addrlist_to_local    (struct AddressList *al);
bool   mutt_addrlist_uses_unicode(const struct AddressList *al);
size_t mutt_addrlist_write       (const struct AddressList *al, struct Buffer *buf, bool display);
size_t mutt_addrlist_write_wrap  (const struct AddressList *al, struct Buffer *buf, const char *header);
void   mutt_addrlist_write_file  (const struct AddressList *al, FILE *fp,           const char *header);
size_t mutt_addrlist_write_list  (const struct AddressList *al, struct ListHead *list);
 
#endif /* MUTT_ADDRESS_ADDRESS_H */