account.h File Reference

A group of associated Mailboxes. More...

#include <stdbool.h>
#include "mutt/lib.h"
#include "mailbox.h"

Include dependency graph for account.h:

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

Go to the source code of this file.

Data Structures
struct	Account
	A group of associated Mailboxes. More...
struct	EventAccount
	An Event that happened to an Account. More...

Enumerations
enum	NotifyAccount { NT_ACCOUNT_ADD = 1 , NT_ACCOUNT_DELETE , NT_ACCOUNT_DELETE_ALL , NT_ACCOUNT_CHANGE }
	Types of Account Event. More...

Functions
	TAILQ_HEAD (AccountList, Account)
void	account_free (struct Account **ptr)
	Free an Account. More...
bool	account_mailbox_add (struct Account *a, struct Mailbox *m)
	Add a Mailbox to an Account. More...
bool	account_mailbox_remove (struct Account *a, struct Mailbox *m)
	Remove a Mailbox from an Account. More...
struct Account *	account_new (const char *name, struct ConfigSubset *sub)
	Create a new Account. More...

Detailed Description

A group of associated Mailboxes.

Authors

• Michael R. Elkins
• Richard Russon

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

Enumeration Type Documentation

NotifyAccount

enum NotifyAccount

Types of Account Event.

Observers of NT_ACCOUNT will be passed an EventAccount.

Note

Delete notifications are sent before the object is deleted.

Other notifications are sent after the event.

Enumerator
NT_ACCOUNT_ADD	Account has been added.
NT_ACCOUNT_DELETE	Account is about to be deleted.
NT_ACCOUNT_DELETE_ALL	All Accounts are about to be deleted.
NT_ACCOUNT_CHANGE	Account has been changed.

Definition at line 66 of file account.h.

{
  NT_ACCOUNT_ADD = 1,    
  NT_ACCOUNT_DELETE,     
  NT_ACCOUNT_DELETE_ALL, 
  NT_ACCOUNT_CHANGE,     
};

Function Documentation

TAILQ_HEAD()

TAILQ_HEAD	(	AccountList	,
		Account
	)

account_free()

void account_free

(

struct Account **

ptr

)

Free an Account.

Parameters

[out]

ptr

Account to free

Definition at line 141 of file account.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Account *a = *ptr;
 
  mutt_debug(LL_NOTIFY, "NT_ACCOUNT_DELETE: %s %p\n", mailbox_get_type_name(a->type), a);
  struct EventAccount ev_a = { a };
  notify_send(a->notify, NT_ACCOUNT, NT_ACCOUNT_DELETE, &ev_a);
 
  account_mailbox_remove(a, NULL);
 
  if (a->adata && a->adata_free)
    a->adata_free(&a->adata);
 
  cs_subset_free(&a->sub);
  FREE(&a->name);
  notify_free(&a->notify);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

account_mailbox_add()

bool account_mailbox_add	(	struct Account *	a,
		struct Mailbox *	m
	)

Add a Mailbox to an Account.

Parameters

a	Account
m	Mailbox to add

Return values

true	Mailbox was added

Definition at line 66 of file account.c.

{
  if (!a || !m)
    return false;
 
  if (a->type == MUTT_UNKNOWN)
    a->type = m->type;
 
  m->account = a;
  struct MailboxNode *np = mutt_mem_calloc(1, sizeof(*np));
  np->mailbox = m;
  STAILQ_INSERT_TAIL(&a->mailboxes, np, entries);
  mailbox_set_subset(m, a->sub);
  notify_set_parent(m->notify, a->notify);
 
  mutt_debug(LL_NOTIFY, "NT_MAILBOX_ADD: %s %p\n", mailbox_get_type_name(m->type), m);
  struct EventMailbox ev_m = { m };
  notify_send(a->notify, NT_MAILBOX, NT_MAILBOX_ADD, &ev_m);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

account_mailbox_remove()

bool account_mailbox_remove	(	struct Account *	a,
		struct Mailbox *	m
	)

Remove a Mailbox from an Account.

Parameters

a	Account
m	Mailbox to remove

Return values

true	On success

Note

If m is NULL, all the mailboxes will be removed and FREE'd. Otherwise, the specified mailbox is removed from the Account but not FREE'd.

Definition at line 96 of file account.c.

{
  if (!a || STAILQ_EMPTY(&a->mailboxes))
    return false;
 
  if (!m)
  {
    mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE_ALL\n");
    struct EventMailbox ev_m = { NULL };
    notify_send(a->notify, NT_MAILBOX, NT_MAILBOX_DELETE_ALL, &ev_m);
  }
 
  bool result = false;
  struct MailboxNode *np = NULL;
  struct MailboxNode *tmp = NULL;
  STAILQ_FOREACH_SAFE(np, &a->mailboxes, entries, tmp)
  {
    if (m && (np->mailbox != m))
      continue;
 
    STAILQ_REMOVE(&a->mailboxes, np, MailboxNode, entries);
    if (m)
    {
      m->account = NULL;
      notify_set_parent(m->notify, NeoMutt->notify);
    }
    else
    {
      // we make it invisible here to force the deletion of the mailbox
      np->mailbox->visible = false;
      mailbox_free(&np->mailbox);
    }
    FREE(&np);
    result = true;
    if (m)
      break;
  }
 
  return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

account_new()

struct Account * account_new	(	const char *	name,
		struct ConfigSubset *	sub
	)

Create a new Account.

Parameters

name	Name for the Account
sub	Parent Config Subset

Return values

ptr	New Account

Definition at line 43 of file account.c.

{
  if (!sub)
    return NULL;
 
  struct Account *a = mutt_mem_calloc(1, sizeof(struct Account));
 
  STAILQ_INIT(&a->mailboxes);
  a->notify = notify_new();
  a->name = mutt_str_dup(name);
  a->sub = cs_subset_new(name, sub, a->notify);
  a->sub->cs = sub->cs;
  a->sub->scope = SET_SCOPE_ACCOUNT;
 
  return a;
}

Here is the call graph for this function:

Here is the caller graph for this function: