NeoMutt  2021-02-05-666-ge300cd
Teaching an old dog new tricks
DOXYGEN
account.c File Reference

A group of associated Mailboxes. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "account.h"
#include "mailbox.h"
+ Include dependency graph for account.c:

Go to the source code of this file.

Functions

struct Accountaccount_new (const char *name, struct ConfigSubset *sub)
 Create a new 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...
 
void account_free (struct Account **ptr)
 Free an Account. More...
 

Detailed Description

A group of associated Mailboxes.

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

Function Documentation

◆ 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 42 of file account.c.

43 {
44  if (!sub)
45  return NULL;
46 
47  struct Account *a = mutt_mem_calloc(1, sizeof(struct Account));
48 
50  a->notify = notify_new();
51  a->name = mutt_str_dup(name);
52  a->sub = cs_subset_new(name, sub, a->notify);
53  a->sub->cs = sub->cs;
55 
56  return a;
57 }
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: NotifyAccount, EventAccount.
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:372
struct Notify * notify_new(void)
Create a new notifications handler.
Definition: notify.c:60
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:144
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
trueMailbox was added

Definition at line 65 of file account.c.

66 {
67  if (!a || !m)
68  return false;
69 
70  if (a->type == MUTT_UNKNOWN)
71  a->type = m->type;
72 
73  m->account = a;
74  struct MailboxNode *np = mutt_mem_calloc(1, sizeof(*np));
75  np->mailbox = m;
76  STAILQ_INSERT_TAIL(&a->mailboxes, np, entries);
77  mailbox_set_subset(m, a->sub);
79 
80  mutt_debug(LL_NOTIFY, "NT_MAILBOX_ADD: %s %p\n", mailbox_get_type_name(m->type), m);
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
Log of notifications.
Definition: logging.h:45
struct Notify * notify
Notifications: NotifyAccount, EventAccount.
Definition: account.h:42
struct MailboxList mailboxes
List of Mailboxes.
Definition: account.h:41
Mailbox wasn&#39;t recognised.
Definition: mailbox.h:47
const char * mailbox_get_type_name(enum MailboxType type)
Get the type of a Mailbox.
Definition: mailbox.c:292
#define STAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:389
enum MailboxType type
Type of Mailboxes this Account contains.
Definition: account.h:38
An Event that happened to a Mailbox.
Definition: mailbox.h:190
Mailbox has been added.
Definition: mailbox.h:173
#define mutt_debug(LEVEL,...)
Definition: logging.h:85
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:244
Mailbox has changed, NotifyMailbox, EventMailbox.
Definition: notify_type.h:48
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:93
List of Mailboxes.
Definition: mailbox.h:156
struct Notify * notify
Notifications: NotifyMailbox, EventMailbox.
Definition: mailbox.h:148
struct Mailbox * mailbox
Mailbox in the list.
Definition: mailbox.h:158
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
+ 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
Return values
trueOn 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 95 of file account.c.

96 {
97  if (!a || STAILQ_EMPTY(&a->mailboxes))
98  return false;
99 
100  if (!m)
101  {
102  mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE_ALL\n");
103  struct EventMailbox ev_m = { NULL };
105  }
106 
107  bool result = false;
108  struct MailboxNode *np = NULL;
109  struct MailboxNode *tmp = NULL;
110  STAILQ_FOREACH_SAFE(np, &a->mailboxes, entries, tmp)
111  {
112  if (m && (np->mailbox != m))
113  continue;
114 
115  STAILQ_REMOVE(&a->mailboxes, np, MailboxNode, entries);
116  if (!m)
117  mailbox_free(&np->mailbox);
118  FREE(&np);
119  result = true;
120  if (m)
121  break;
122  }
123 
124  return result;
125 }
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:402
Log of notifications.
Definition: logging.h:45
struct Notify * notify
Notifications: NotifyAccount, EventAccount.
Definition: account.h:42
struct MailboxList mailboxes
List of Mailboxes.
Definition: account.h:41
An Event that happened to a Mailbox.
Definition: mailbox.h:190
void mailbox_free(struct Mailbox **ptr)
Free a Mailbox.
Definition: mailbox.c:87
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:362
#define mutt_debug(LEVEL,...)
Definition: logging.h:85
All Mailboxes are about to be deleted.
Definition: mailbox.h:175
#define FREE(x)
Definition: memory.h:40
Mailbox has changed, NotifyMailbox, EventMailbox.
Definition: notify_type.h:48
#define STAILQ_EMPTY(head)
Definition: queue.h:348
List of Mailboxes.
Definition: mailbox.h:156
struct Mailbox * mailbox
Mailbox in the list.
Definition: mailbox.h:158
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ account_free()

void account_free ( struct Account **  ptr)

Free an Account.

Parameters
[out]ptrAccount to free

Definition at line 131 of file account.c.

132 {
133  if (!ptr || !*ptr)
134  return;
135 
136  struct Account *a = *ptr;
137 
138  mutt_debug(LL_NOTIFY, "NT_ACCOUNT_DELETE: %s %p\n", mailbox_get_type_name(a->type), a);
139  struct EventAccount ev_a = { a };
141 
142  account_mailbox_remove(a, NULL);
143 
144  if (a->adata && a->adata_free)
145  a->adata_free(&a->adata);
146 
147  cs_subset_free(&a->sub);
148  FREE(&a->name);
149  notify_free(&a->notify);
150 
151  FREE(ptr);
152 }
char * name
Name of Account.
Definition: account.h:39
Log of notifications.
Definition: logging.h:45
void notify_free(struct Notify **ptr)
Free a notification handler.
Definition: notify.c:73
struct Notify * notify
Notifications: NotifyAccount, EventAccount.
Definition: account.h:42
A group of associated Mailboxes.
Definition: account.h:36
const char * mailbox_get_type_name(enum MailboxType type)
Get the type of a Mailbox.
Definition: mailbox.c:292
void cs_subset_free(struct ConfigSubset **ptr)
Free a Config Subset.
Definition: subset.c:104
enum MailboxType type
Type of Mailboxes this Account contains.
Definition: account.h:38
An Event that happened to an Account.
Definition: account.h:78
void(* adata_free)(void **ptr)
Free the private data attached to the Account.
Definition: account.h:53
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
Account has changed, NotifyAccount, EventAccount.
Definition: notify_type.h:34
#define mutt_debug(LEVEL,...)
Definition: logging.h:85
#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:95
struct ConfigSubset * sub
Inherited config items.
Definition: account.h:40
Account is about to be deleted.
Definition: account.h:70
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
+ Here is the call graph for this function:
+ Here is the caller graph for this function: