NeoMutt  2020-11-20
Teaching an old dog new tricks
DOXYGEN
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_REMOVE, NT_ACCOUNT_CHANGED }
 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 Accountaccount_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

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

Types of Account Event.

Observers of NT_ACCOUNT will be passed an EventAccount.

Enumerator
NT_ACCOUNT_ADD 

A new Account has been created.

NT_ACCOUNT_REMOVE 

An Account is about to be destroyed.

NT_ACCOUNT_CHANGED 

An Account has changed.

Definition at line 60 of file account.h.

61 {
62  NT_ACCOUNT_ADD = 1,
65 };
An Account has changed.
Definition: account.h:64
An Account is about to be destroyed.
Definition: account.h:63
A new Account has been created.
Definition: account.h:62

Function Documentation

◆ TAILQ_HEAD()

TAILQ_HEAD ( AccountList  ,
Account   
)

◆ account_free()

void account_free ( struct Account **  ptr)

Free an Account.

Parameters
[out]ptrAccount to free

Definition at line 125 of file account.c.

126 {
127  if (!ptr || !*ptr)
128  return;
129 
130  struct Account *a = *ptr;
131 
132  if (a->adata_free)
133  a->adata_free(&a->adata);
134 
135  account_mailbox_remove(a, NULL);
136  cs_subset_free(&a->sub);
137  FREE(&a->name);
138  notify_free(&a->notify);
139 
140  FREE(ptr);
141 }
char * name
Name of Account.
Definition: account.h:39
void notify_free(struct Notify **ptr)
Free a notification handler.
Definition: notify.c:62
struct Notify * notify
Notifications handler.
Definition: account.h:42
A group of associated Mailboxes.
Definition: account.h:36
void cs_subset_free(struct ConfigSubset **ptr)
Free a Config Subset.
Definition: subset.c:93
void(* adata_free)(void **ptr)
Free the private data attached to the Account.
Definition: account.h:49
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
#define FREE(x)
Definition: memory.h:40
bool account_mailbox_remove(struct Account *a, struct Mailbox *m)
Remove a Mailbox from an Account.
Definition: account.c:94
struct ConfigSubset * sub
Inherited config items.
Definition: account.h:40
+ 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
aAccount
mMailbox to add
Return values
trueIf Mailbox was added

Definition at line 66 of file account.c.

67 {
68  if (!a || !m)
69  return false;
70 
71  if (a->type == MUTT_UNKNOWN)
72  a->type = m->type;
73 
74  m->account = a;
75  struct MailboxNode *np = mutt_mem_calloc(1, sizeof(*np));
76  np->mailbox = m;
77  STAILQ_INSERT_TAIL(&a->mailboxes, np, entries);
78  mailbox_set_subset(m, a->sub);
80 
81  struct EventMailbox ev_m = { m };
83  return true;
84 }
enum MailboxType type
Mailbox type.
Definition: mailbox.h:105
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
struct Notify * notify
Notifications handler.
Definition: account.h:42
struct MailboxList mailboxes
List of Mailboxes.
Definition: account.h:41
Mailbox wasn&#39;t recognised.
Definition: mailbox.h:47
#define STAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:386
enum MailboxType type
Type of Mailboxes this Account contains.
Definition: account.h:38
An Event that happened to a Mailbox.
Definition: mailbox.h:183
A new Mailbox has been created.
Definition: mailbox.h:166
struct Account * account
Account that owns this Mailbox.
Definition: mailbox.h:131
bool mailbox_set_subset(struct Mailbox *m, struct ConfigSubset *sub)
Set a Mailbox&#39;s Config Subset.
Definition: mailbox.c:212
Mailbox has changed, NotifyMailbox, EventMailbox.
Definition: notify_type.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: account.h:40
void notify_set_parent(struct Notify *notify, struct Notify *parent)
Set the parent notification handler.
Definition: notify.c:82
List of Mailboxes.
Definition: mailbox.h:152
struct Notify * notify
Notifications handler.
Definition: mailbox.h:144
struct Mailbox * mailbox
Mailbox in the list.
Definition: mailbox.h:154
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:152
+ 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
aAccount
mMailbox to remove
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 94 of file account.c.

95 {
96  if (!a)
97  return false;
98 
99  bool result = false;
100  struct MailboxNode *np = NULL;
101  struct MailboxNode *tmp = NULL;
102  STAILQ_FOREACH_SAFE(np, &a->mailboxes, entries, tmp)
103  {
104  if (!m || (np->mailbox == m))
105  {
106  struct EventMailbox ev_m = { m };
108  STAILQ_REMOVE(&a->mailboxes, np, MailboxNode, entries);
109  if (!m)
110  mailbox_free(&np->mailbox);
111  FREE(&np);
112  result = true;
113  if (m)
114  break;
115  }
116  }
117 
118  return result;
119 }
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:399
struct Notify * notify
Notifications handler.
Definition: account.h:42
struct MailboxList mailboxes
List of Mailboxes.
Definition: account.h:41
An Event that happened to a Mailbox.
Definition: mailbox.h:183
void mailbox_free(struct Mailbox **ptr)
Free a Mailbox.
Definition: mailbox.c:63
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:359
A Mailbox is about to be destroyed.
Definition: mailbox.h:167
#define FREE(x)
Definition: memory.h:40
Mailbox has changed, NotifyMailbox, EventMailbox.
Definition: notify_type.h:42
List of Mailboxes.
Definition: mailbox.h:152
struct Mailbox * mailbox
Mailbox in the list.
Definition: mailbox.h:154
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:152
+ 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
nameName for the Account
subParent Config Subset
Return values
ptrNew Account

Definition at line 43 of file account.c.

44 {
45  if (!sub)
46  return NULL;
47 
48  struct Account *a = mutt_mem_calloc(1, sizeof(struct Account));
49 
51  a->notify = notify_new();
52  a->name = mutt_str_dup(name);
53  a->sub = cs_subset_new(name, sub, a->notify);
54  a->sub->cs = sub->cs;
56 
57  return a;
58 }
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
char * name
Name of Account.
Definition: account.h:39
struct Notify * notify
Notifications handler.
Definition: account.h:42
struct MailboxList mailboxes
List of Mailboxes.
Definition: account.h:41
A group of associated Mailboxes.
Definition: account.h:36
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:370
struct ConfigSet * cs
Parent ConfigSet.
Definition: subset.h:51
#define STAILQ_INIT(head)
Definition: queue.h:369
struct Notify * notify_new(void)
Create a new notifications handler.
Definition: notify.c:49
This Config is Account-specific.
Definition: subset.h:39
enum ConfigScope scope
Scope of Subset, e.g. SET_SCOPE_ACCOUNT.
Definition: subset.h:49
struct ConfigSubset * cs_subset_new(const char *name, struct ConfigSubset *sub_parent, struct Notify *not_parent)
Create a new Config Subset.
Definition: subset.c:133
struct ConfigSubset * sub
Inherited config items.
Definition: account.h:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function: