email.c File Reference

Representation of an email. More...

#include "config.h"
#include <stdbool.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	email_free (struct Email **ptr)
	Free an Email. More...
struct Email *	email_new (void)
	Create a new Email. More...
bool	email_cmp_strict (const struct Email *e1, const struct Email *e2)
	Strictly compare message emails. More...
size_t	email_size (const struct Email *e)
	compute the size of an email More...
void	emaillist_clear (struct EmailList *el)
	Drop a private list of Emails. More...
int	emaillist_add_email (struct EmailList *el, struct Email *e)
	Add an Email to a list. More...

Detailed Description

Representation of an email.

Authors

• Michael R. Elkins

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

email_free()

void email_free

(

struct Email **

ptr

)

Free an Email.

Parameters

[out]

ptr

Email to free

Definition at line 41 of file email.c.

{
  if (!ptr || !*ptr)
    return;

  struct Email *e = *ptr;

  if (e->edata && e->edata_free)
    e->edata_free(&e->edata);

  mutt_env_free(&e->env);
  mutt_body_free(&e->content);
  FREE(&e->maildir_flags);
  FREE(&e->tree);
  FREE(&e->path);
#ifdef MIXMASTER
  mutt_list_free(&e->chain);
#endif
  driver_tags_free(&e->tags);

  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 68 of file email.c.

{
  struct Email *e = mutt_mem_calloc(1, sizeof(struct Email));
#ifdef MIXMASTER
  STAILQ_INIT(&e->chain);
#endif
  STAILQ_INIT(&e->tags);
  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 84 of file email.c.

{
  if (e1 && e2)
  {
    if ((e1->received != e2->received) || (e1->date_sent != e2->date_sent) ||
        (e1->content->length != e2->content->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->content, e2->content))
    {
      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_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 110 of file email.c.

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

Here is the caller graph for this function:

emaillist_clear()

void emaillist_clear

(

struct EmailList *

el

)

Drop a private list of Emails.

Parameters

el	EmailList to empty

The Emails are not freed.

Definition at line 123 of file email.c.

{
  if (!el)
    return;

  struct EmailNode *en = NULL, *tmp = NULL;
  STAILQ_FOREACH_SAFE(en, el, entries, tmp)
  {
    STAILQ_REMOVE(el, en, EmailNode, entries);
    FREE(&en);
  }
  STAILQ_INIT(el);
}

Here is the caller graph for this function:

emaillist_add_email()

int emaillist_add_email	(	struct EmailList *	el,
		struct Email *	e
	)

Add an Email to a list.

Parameters

e	Email to add
el	EmailList to add to

Return values

0	Success
-1	Error

Definition at line 144 of file email.c.

{
  if (!el || !e)
    return -1;

  struct EmailNode *en = mutt_mem_calloc(1, sizeof(*en));
  en->email = e;
  STAILQ_INSERT_TAIL(el, en, entries);

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function: