email.h

Go to the documentation of this file.

 
#ifndef MUTT_EMAIL_EMAIL_H
#define MUTT_EMAIL_EMAIL_H
 
#include "config.h"
#include <stdbool.h>
#include <time.h>
#include "mutt/lib.h"
#include "ncrypt/lib.h"
#include "tags.h"
 
struct Email
{
  // ---------------------------------------------------------------------------
  // Data that gets stored in the Header Cache
 
  SecurityFlags security;      
 
  bool expired    : 1;         
  bool flagged    : 1;         
  bool mime       : 1;         
  bool old        : 1;         
  bool read       : 1;         
  bool replied    : 1;         
  bool superseded : 1;         
  bool trash      : 1;         
 
  // Timezone of the sender of this message
  unsigned int zhours   : 5;   
  unsigned int zminutes : 6;   
  bool zoccident        : 1;   
 
  time_t date_sent;            
  time_t received;             
  int lines;                   
 
  // ---------------------------------------------------------------------------
  // Management data - Runtime info and glue to hold the objects together
 
  size_t sequence;             
  struct Envelope *env;        
  struct Body *body;           
  char *path;                  
  LOFF_T offset;               
  struct TagList tags;         
  struct Notify *notify;       
  void *edata;                 
 
  bool active          : 1;    
  bool changed         : 1;    
  bool deleted         : 1;    
  bool purge           : 1;    
 
  void (*edata_free)(void **ptr);
 
#ifdef USE_NOTMUCH
  void *nm_edata;              
#endif
 
  // ---------------------------------------------------------------------------
  // View data - Used by the GUI
 
  bool attach_del      : 1;    
  bool attach_valid    : 1;    
  bool display_subject : 1;    
  bool matched         : 1;    
  bool quasi_deleted   : 1;    
  bool recip_valid     : 1;    
  bool searched        : 1;    
  bool subject_changed : 1;    
  bool tagged          : 1;    
  bool threaded        : 1;    
 
  int index;                   
  int msgno;                   
  const struct AttrColor *attr_color; 
  int score;                   
  int vnum;                    
  short attach_total;          
  short recipient;             
 
  // The following are used to support collapsing threads
  struct MuttThread *thread;   
  bool collapsed     : 1;      
  bool visible       : 1;      
  bool limit_visited : 1;      
  size_t num_hidden;           
  char *tree;                  
};
ARRAY_HEAD(EmailArray, struct Email *);
 
enum ExpandoDataEmail
{
  ED_EMA_ATTACHMENT_COUNT = 1, 
  ED_EMA_BODY_CHARACTERS,      
  ED_EMA_COMBINED_FLAGS,       
  ED_EMA_CRYPTO_FLAGS,         
  ED_EMA_DATE_FORMAT,          
  ED_EMA_DATE_FORMAT_LOCAL,    
  ED_EMA_FLAG_CHARS,           
  ED_EMA_FROM_LIST,            
  ED_EMA_INDEX_HOOK,           
  ED_EMA_LINES,                
  ED_EMA_LIST_OR_SAVE_FOLDER,  
  ED_EMA_MESSAGE_FLAGS,        
  ED_EMA_NUMBER,               
  ED_EMA_SCORE,                
  ED_EMA_SIZE,                 
  ED_EMA_STATUS_FLAGS,         
  ED_EMA_STRF,                 
  ED_EMA_STRF_LOCAL,           
  ED_EMA_STRF_RECV_LOCAL,      
  ED_EMA_TAGS,                 
  ED_EMA_TAGS_TRANSFORMED,     
  ED_EMA_THREAD_COUNT,         
  ED_EMA_THREAD_HIDDEN_COUNT,  
  ED_EMA_THREAD_NUMBER,        
  ED_EMA_THREAD_TAGS,          
  ED_EMA_TO_CHARS,             
};
 
struct EmailNode
{
  struct Email *email;             
  STAILQ_ENTRY(EmailNode) entries; 
};
 
enum NotifyEmail
{
  NT_EMAIL_ADD = 1,         
  NT_EMAIL_DELETE,          
  NT_EMAIL_DELETE_ALL,      
  NT_EMAIL_CHANGE,          
  NT_EMAIL_CHANGE_ENVELOPE, 
  NT_EMAIL_CHANGE_ATTACH,   
  NT_EMAIL_CHANGE_SECURITY, 
};
 
struct EventEmail
{
  int num_emails;        
  struct Email **emails; 
};
 
enum NotifyHeader
{
  NT_HEADER_ADD = 1, 
  NT_HEADER_DELETE,  
  NT_HEADER_CHANGE,  
};
 
struct EventHeader
{
  char *header; 
};
 
bool          email_cmp_strict(const struct Email *e1, const struct Email *e2);
void          email_free      (struct Email **ptr);
struct Email *email_new       (void);
size_t        email_size      (const struct Email *e);
 
struct ListNode *header_add   (struct ListHead *hdrlist, const char *header);
struct ListNode *header_find  (const struct ListHead *hdrlist, const char *header);
void             header_free  (struct ListHead *hdrlist, struct ListNode *target);
struct ListNode *header_set   (struct ListHead *hdrlist, const char *header);
struct ListNode *header_update(struct ListNode *hdrnode, const char *header);
 
#endif /* MUTT_EMAIL_EMAIL_H */