NeoMutt  2021-10-29-220-g2b1eec
Teaching an old dog new tricks
DOXYGEN
Email Struct Reference

The envelope/body of an email. More...

#include "email.h"

+ Inheritance diagram for Email:
+ Collaboration diagram for Email:

Data Fields

SecurityFlags security
 bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib.h, smime.h More...
 
bool expired: 1
 Already expired? More...
 
bool flagged: 1
 Marked important? More...
 
bool mime: 1
 Has a MIME-Version header? More...
 
bool old: 1
 Email is seen, but unread. More...
 
bool read: 1
 Email is read. More...
 
bool replied: 1
 Email has been replied to. More...
 
bool superseded: 1
 Got superseded? More...
 
bool trash: 1
 Message is marked as trashed on disk (used by the maildir_trash option) More...
 
unsigned int zhours: 5
 Hours away from UTC. More...
 
unsigned int zminutes: 6
 Minutes away from UTC. More...
 
bool zoccident: 1
 True, if west of UTC, False if east. More...
 
time_t date_sent
 Time when the message was sent (UTC) More...
 
time_t received
 Time when the message was placed in the mailbox. More...
 
int lines
 How many lines in the body of this message? More...
 
size_t sequence
 Sequence number assigned on creation. More...
 
struct Envelopeenv
 Envelope information. More...
 
struct Bodybody
 List of MIME parts. More...
 
char * path
 Path of Email (for local Mailboxes) More...
 
LOFF_T offset
 Where in the stream does this message begin? More...
 
struct TagList tags
 For drivers that support server tagging. More...
 
struct Notifynotify
 Notifications: NotifyEmail, EventEmail. More...
 
void * edata
 Driver-specific data. More...
 
bool active: 1
 Message is not to be removed. More...
 
bool changed: 1
 Email has been edited. More...
 
bool deleted: 1
 Email is deleted. More...
 
bool purge: 1
 Skip trash folder when deleting. More...
 
void(* edata_free )(void **ptr)
 Free the private data attached to the Email. More...
 
struct ListHead chain
 Mixmaster chain. More...
 
void * nm_edata
 Notmuch private data. More...
 
bool attach_del: 1
 Has an attachment marked for deletion. More...
 
bool attach_valid: 1
 true when the attachment count is valid More...
 
bool display_subject: 1
 Used for threading. More...
 
bool matched: 1
 Search matches this Email. More...
 
bool quasi_deleted: 1
 Deleted from neomutt, but not modified on disk. More...
 
bool recip_valid: 1
 Is_recipient is valid. More...
 
bool searched: 1
 Email has been searched. More...
 
bool subject_changed: 1
 Used for threading. More...
 
bool tagged: 1
 Email is tagged. More...
 
bool threaded: 1
 Used for threading. More...
 
int index
 The absolute (unsorted) message number. More...
 
int msgno
 Number displayed to the user. More...
 
int pair
 Color-pair to use when displaying in the index. More...
 
int score
 Message score. More...
 
int vnum
 Virtual message number. More...
 
short attach_total
 Number of qualifying attachments in message, if attach_valid. More...
 
short recipient
 User_is_recipient()'s return value, cached. More...
 
struct MuttThreadthread
 Thread of Emails. More...
 
bool collapsed: 1
 Is this message part of a collapsed thread? More...
 
bool visible: 1
 Is this message part of the view? More...
 
size_t num_hidden
 Number of hidden messages in this view (only valid when collapsed is set) More...
 
char * tree
 Character string to print thread tree. More...
 

Detailed Description

The envelope/body of an email.

Definition at line 36 of file email.h.

Field Documentation

◆ security

SecurityFlags Email::security

bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib.h, smime.h

Definition at line 41 of file email.h.

◆ expired

bool Email::expired

Already expired?

Definition at line 44 of file email.h.

◆ flagged

bool Email::flagged

Marked important?

Definition at line 45 of file email.h.

◆ mime

bool Email::mime

Has a MIME-Version header?

Definition at line 46 of file email.h.

◆ old

bool Email::old

Email is seen, but unread.

Definition at line 47 of file email.h.

◆ read

bool Email::read

Email is read.

Definition at line 48 of file email.h.

◆ replied

bool Email::replied

Email has been replied to.

Definition at line 49 of file email.h.

◆ superseded

bool Email::superseded

Got superseded?

Definition at line 50 of file email.h.

◆ trash

bool Email::trash

Message is marked as trashed on disk (used by the maildir_trash option)

Definition at line 51 of file email.h.

◆ zhours

unsigned int Email::zhours

Hours away from UTC.

Definition at line 54 of file email.h.

◆ zminutes

unsigned int Email::zminutes

Minutes away from UTC.

Definition at line 55 of file email.h.

◆ zoccident

bool Email::zoccident

True, if west of UTC, False if east.

Definition at line 56 of file email.h.

◆ date_sent

time_t Email::date_sent

Time when the message was sent (UTC)

Definition at line 58 of file email.h.

◆ received

time_t Email::received

Time when the message was placed in the mailbox.

Definition at line 59 of file email.h.

◆ lines

int Email::lines

How many lines in the body of this message?

Definition at line 60 of file email.h.

◆ sequence

size_t Email::sequence

Sequence number assigned on creation.

Definition at line 65 of file email.h.

◆ env

struct Envelope* Email::env

Envelope information.

Definition at line 66 of file email.h.

◆ body

struct Body* Email::body

List of MIME parts.

Definition at line 67 of file email.h.

◆ path

char* Email::path

Path of Email (for local Mailboxes)

Definition at line 68 of file email.h.

◆ offset

LOFF_T Email::offset

Where in the stream does this message begin?

Definition at line 69 of file email.h.

◆ tags

struct TagList Email::tags

For drivers that support server tagging.

Definition at line 69 of file email.h.

◆ notify

struct Notify* Email::notify

Notifications: NotifyEmail, EventEmail.

Definition at line 71 of file email.h.

◆ edata

void* Email::edata

Driver-specific data.

Definition at line 72 of file email.h.

◆ active

bool Email::active

Message is not to be removed.

Definition at line 74 of file email.h.

◆ changed

bool Email::changed

Email has been edited.

Definition at line 75 of file email.h.

◆ deleted

bool Email::deleted

Email is deleted.

Definition at line 76 of file email.h.

◆ purge

bool Email::purge

Skip trash folder when deleting.

Definition at line 77 of file email.h.

◆ edata_free

void(* Email::edata_free) (void **ptr)

Free the private data attached to the Email.

Parameters
ptrPrivate data to be freed

Contract

  • ptr is not NULL
  • *ptr is not NULL

Definition at line 87 of file email.h.

◆ chain

struct ListHead Email::chain

Mixmaster chain.

Definition at line 87 of file email.h.

◆ nm_edata

void* Email::nm_edata

Notmuch private data.

Definition at line 93 of file email.h.

◆ attach_del

bool Email::attach_del

Has an attachment marked for deletion.

Definition at line 99 of file email.h.

◆ attach_valid

bool Email::attach_valid

true when the attachment count is valid

Definition at line 100 of file email.h.

◆ display_subject

bool Email::display_subject

Used for threading.

Definition at line 101 of file email.h.

◆ matched

bool Email::matched

Search matches this Email.

Definition at line 102 of file email.h.

◆ quasi_deleted

bool Email::quasi_deleted

Deleted from neomutt, but not modified on disk.

Definition at line 103 of file email.h.

◆ recip_valid

bool Email::recip_valid

Is_recipient is valid.

Definition at line 104 of file email.h.

◆ searched

bool Email::searched

Email has been searched.

Definition at line 105 of file email.h.

◆ subject_changed

bool Email::subject_changed

Used for threading.

Definition at line 106 of file email.h.

◆ tagged

bool Email::tagged

Email is tagged.

Definition at line 107 of file email.h.

◆ threaded

bool Email::threaded

Used for threading.

Definition at line 108 of file email.h.

◆ index

int Email::index

The absolute (unsorted) message number.

Definition at line 110 of file email.h.

◆ msgno

int Email::msgno

Number displayed to the user.

Definition at line 111 of file email.h.

◆ pair

int Email::pair

Color-pair to use when displaying in the index.

Definition at line 112 of file email.h.

◆ score

int Email::score

Message score.

Definition at line 113 of file email.h.

◆ vnum

int Email::vnum

Virtual message number.

Definition at line 114 of file email.h.

◆ attach_total

short Email::attach_total

Number of qualifying attachments in message, if attach_valid.

Definition at line 115 of file email.h.

◆ recipient

short Email::recipient

User_is_recipient()'s return value, cached.

Definition at line 116 of file email.h.

◆ thread

struct MuttThread* Email::thread

Thread of Emails.

Definition at line 119 of file email.h.

◆ collapsed

bool Email::collapsed

Is this message part of a collapsed thread?

Definition at line 120 of file email.h.

◆ visible

bool Email::visible

Is this message part of the view?

Definition at line 121 of file email.h.

◆ num_hidden

size_t Email::num_hidden

Number of hidden messages in this view (only valid when collapsed is set)

Definition at line 122 of file email.h.

◆ tree

char* Email::tree

Character string to print thread tree.

Definition at line 124 of file email.h.


The documentation for this struct was generated from the following file: