email.c File Reference

Representation of an email. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include "mutt/lib.h"
#include "email.h"
#include "body.h"
#include "envelope.h"
#include "tags.h"

Include dependency graph for email.c:

Go to the source code of this file.

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

Detailed Description

Representation of an email.

Authors

• Richard Russon
• Pietro Cerutti
• Matthew Hughes

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.c.

Function Documentation

nm_edata_free()

void nm_edata_free

(

void **

ptr

)

Free data attached to an Email.

Parameters

[out]

ptr

Email data

Each email has an attached NmEmailData, which contains things like the tags (labels).

Definition at line 42 of file edata.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct NmEmailData *edata = *ptr;
 
  mutt_debug(LL_DEBUG2, "nm: freeing email %p\n", (void *) edata);
  FREE(&edata->folder);
  FREE(&edata->oldpath);
  FREE(&edata->virtual_id);
 
  FREE(ptr);
}

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_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_get_size()

size_t email_get_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_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_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_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:

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_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: