email.h File Reference

Representation of an email. More...

#include "config.h"
#include <stdbool.h>
#include <time.h>
#include "mutt/lib.h"
#include "ncrypt/lib.h"
#include "tags.h"

Include dependency graph for email.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Email
	The envelope/body of an email. More...
struct	EmailNode
	List of Emails. More...
struct	EventEmail
	An Event that happened to an Email. More...
struct	EventHeader
	An event that happened to a header. More...

Enumerations
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 }
	Expando UIDs for Emails. More...
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 }
	Types of Email Event. More...
enum	NotifyHeader { NT_HEADER_ADD = 1 , NT_HEADER_DELETE , NT_HEADER_CHANGE }
	Types of Header Event. More...

Functions
	ARRAY_HEAD (EmailArray, struct Email *)
bool	email_cmp_strict (const struct Email *e1, const struct Email *e2)
	Strictly compare message emails.
void	email_free (struct Email **ptr)
	Free an Email.
struct Email *	email_new (void)
	Create a new Email.
size_t	email_size (const struct Email *e)
	Compute the size of an email.
struct ListNode *	header_add (struct ListHead *hdrlist, const char *header)
	Add a header to a list.
struct ListNode *	header_find (const struct ListHead *hdrlist, const char *header)
	Find a header, matching on its field, in a list of headers.
void	header_free (struct ListHead *hdrlist, struct ListNode *target)
	Free and remove a header from a header list.
struct ListNode *	header_set (struct ListHead *hdrlist, const char *header)
	Set a header value in a list.
struct ListNode *	header_update (struct ListNode *hdrnode, const char *header)
	Update an existing header.

Detailed Description

Representation of an email.

Authors

• Richard Russon
• Matthew Hughes
• Pietro Cerutti

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 email.h.

Enumeration Type Documentation

ExpandoDataEmail

enum ExpandoDataEmail

Expando UIDs for Emails.

See also

ED_EMAIL, ExpandoDomain

Enumerator
ED_EMA_ATTACHMENT_COUNT	Email, mutt_count_body_parts()
ED_EMA_BODY_CHARACTERS	Body.length.
ED_EMA_COMBINED_FLAGS	Email.read, Email.old, thread_is_new(), ...
ED_EMA_CRYPTO_FLAGS	Email.security, SecurityFlags.
ED_EMA_DATE_FORMAT	Email.date_sent.
ED_EMA_DATE_FORMAT_LOCAL	Email.date_sent.
ED_EMA_FLAG_CHARS	Email.deleted, Email.attach_del, ...
ED_EMA_FROM_LIST	Envelope.to, Envelope.cc.
ED_EMA_INDEX_HOOK	Mailbox, Email, mutt_idxfmt_hook()
ED_EMA_LINES	Email.lines.
ED_EMA_LIST_OR_SAVE_FOLDER	Envelope.to, Envelope.cc, check_for_mailing_list()
ED_EMA_MESSAGE_FLAGS	Email.tagged, Email.flagged.
ED_EMA_NUMBER	Email.msgno.
ED_EMA_SCORE	Email.score.
ED_EMA_SIZE	Body.length.
ED_EMA_STATUS_FLAGS	Email.deleted, Email.attach_del, ...
ED_EMA_STRF	Email.date_sent, Email.zhours, Email.zminutes, Email.zoccident.
ED_EMA_STRF_LOCAL	Email.date_sent.
ED_EMA_STRF_RECV_LOCAL	Email.received.
ED_EMA_TAGS	Email.tags.
ED_EMA_TAGS_TRANSFORMED	Email.tags, driver_tags_get_transformed()
ED_EMA_THREAD_COUNT	Email, mutt_messages_in_thread()
ED_EMA_THREAD_HIDDEN_COUNT	Email.collapsed, Email.num_hidden, ...
ED_EMA_THREAD_NUMBER	Email, mutt_messages_in_thread()
ED_EMA_THREAD_TAGS	Email.tags.
ED_EMA_TO_CHARS	Email, User_is_recipient()

Definition at line 134 of file email.h.

{
  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,             
};

NotifyEmail

enum NotifyEmail

Types of Email Event.

Observers of NT_EMAIL will be passed an EventEmail.

Note

Delete notifications are sent before the object is deleted.

Other notifications are sent after the event.

Enumerator
NT_EMAIL_ADD	Email has been added.
NT_EMAIL_DELETE	Email is about to be deleted.
NT_EMAIL_DELETE_ALL	All the Emails are about to be deleted.
NT_EMAIL_CHANGE	Email has changed.
NT_EMAIL_CHANGE_ENVELOPE	Email's Envelope has changed.
NT_EMAIL_CHANGE_ATTACH	Email's Attachments have changed.
NT_EMAIL_CHANGE_SECURITY	Email's security settings have changed.

Definition at line 181 of file email.h.

{
  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, 
};

NotifyHeader

enum NotifyHeader

Types of Header Event.

Observers of NT_HEADER will be passed an EventHeader.

Enumerator
NT_HEADER_ADD	Header has been added.
NT_HEADER_DELETE	Header has been removed.
NT_HEADER_CHANGE	An existing header has been changed.

Definition at line 206 of file email.h.

{
  NT_HEADER_ADD = 1, 
  NT_HEADER_DELETE,  
  NT_HEADER_CHANGE,  
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	EmailArray	,
		struct Email *
	)

email_cmp_strict()

bool email_cmp_strict	(	const struct Email *	e1,
		const struct Email *	e2
	)

Strictly compare message emails.

Parameters

e1	First Email
e2	Second Email

Return values

true	Emails are strictly identical

Definition at line 96 of file email.c.

{
  if (e1 && e2)
  {
    if ((e1->received != e2->received) || (e1->date_sent != e2->date_sent) ||
        (e1->body->length != e2->body->length) || (e1->lines != e2->lines) ||
        (e1->zhours != e2->zhours) || (e1->zminutes != e2->zminutes) ||
        (e1->zoccident != e2->zoccident) || (e1->mime != e2->mime) ||
        !mutt_env_cmp_strict(e1->env, e2->env) || !mutt_body_cmp_strict(e1->body, e2->body))
    {
      return false;
    }
    return true;
  }
  else
  {
    return (!e1 && !e2);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

email_free()

void email_free

(

struct Email **

ptr

)

Free an Email.

Parameters

[out]

ptr

Email to free

Definition at line 46 of file email.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Email *e = *ptr;
 
  mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE: %p\n", (void *) e);
  struct EventEmail ev_e = { 1, &e };
  notify_send(e->notify, NT_EMAIL, NT_EMAIL_DELETE, &ev_e);
 
  if (e->edata_free && e->edata)
    e->edata_free(&e->edata);
 
  mutt_env_free(&e->env);
  mutt_body_free(&e->body);
  FREE(&e->tree);
  FREE(&e->path);
#ifdef USE_NOTMUCH
  nm_edata_free(&e->nm_edata);
#endif
  driver_tags_free(&e->tags);
  notify_free(&e->notify);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

email_new()

struct Email * email_new

(

void

)

Create a new Email.

Return values

ptr	Newly created Email

Definition at line 77 of file email.c.

{
  static size_t sequence = 0;
 
  struct Email *e = MUTT_MEM_CALLOC(1, struct Email);
  STAILQ_INIT(&e->tags);
  e->visible = true;
  e->sequence = sequence++;
  e->notify = notify_new();
 
  return e;
}

Here is the call graph for this function:

Here is the caller graph for this function:

email_size()

size_t email_size

(

const struct Email *

e

)

Compute the size of an email.

Parameters

e

Email

Return values

num	Size of the email, in bytes

Definition at line 121 of file email.c.

{
  if (!e || !e->body)
    return 0;
  return e->body->length + e->body->offset - e->body->hdr_offset;
}

Here is the caller graph for this function:

header_add()

struct ListNode * header_add	(	struct ListHead *	hdrlist,
		const char *	header
	)

Add a header to a list.

Parameters

hdrlist	List of headers to search
header	String to set as the header

Return values

ptr	The created header

Definition at line 160 of file email.c.

{
  struct ListNode *n = mutt_list_insert_tail(hdrlist, NULL);
  n->data = mutt_str_dup(header);
 
  return n;
}

Here is the call graph for this function:

Here is the caller graph for this function:

header_find()

struct ListNode * header_find	(	const struct ListHead *	hdrlist,
		const char *	header
	)

Find a header, matching on its field, in a list of headers.

Parameters

hdrlist	List of headers to search
header	The header to search for

Return values

ptr	The node in the list matching the header
NULL	No matching header is found

The header should either of the form "X-Header:" or "X-Header: value"

Definition at line 137 of file email.c.

{
  const char *key_end = strchr(header, ':');
  if (!key_end)
    return NULL;
 
  const int keylen = key_end - header + 1;
 
  struct ListNode *n = NULL;
  STAILQ_FOREACH(n, hdrlist, entries)
  {
    if (mutt_istrn_equal(n->data, header, keylen))
      return n;
  }
  return n;
}

Here is the call graph for this function:

Here is the caller graph for this function:

header_free()

void header_free	(	struct ListHead *	hdrlist,
		struct ListNode *	target
	)

Free and remove a header from a header list.

Parameters

hdrlist	List to free the header from
target	The header to free

Definition at line 202 of file email.c.

{
  STAILQ_REMOVE(hdrlist, target, ListNode, entries);
  FREE(&target->data);
  FREE(&target);
}

Here is the caller graph for this function:

header_set()

struct ListNode * header_set	(	struct ListHead *	hdrlist,
		const char *	header
	)

Set a header value in a list.

Parameters

hdrlist	List of headers to search
header	String to set the value of the header to

Return values

ptr	The updated or created header

If a header exists with the same field, update it, otherwise add a new header.

Definition at line 190 of file email.c.

{
  struct ListNode *n = header_find(hdrlist, header);
 
  return n ? header_update(n, header) : header_add(hdrlist, header);
}

Here is the call graph for this function:

Here is the caller graph for this function:

header_update()

struct ListNode * header_update	(	struct ListNode *	hdr,
		const char *	header
	)

Update an existing header.

Parameters

hdr	The header to update
header	String to update the header with

Return values

ptr	The updated header

Definition at line 174 of file email.c.

{
  FREE(&hdr->data);
  hdr->data = mutt_str_dup(header);
 
  return hdr;
}

Here is the call graph for this function:

Here is the caller graph for this function: