NeoMutt  2022-04-29-247-gc6aae8
Teaching an old dog new tricks
DOXYGEN
adata.h File Reference

Pop-specific Account data. More...

#include <stdbool.h>
#include <time.h>
#include "private.h"
#include "mutt/lib.h"
+ Include dependency graph for adata.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PopAccountData
 POP-specific Account data -. More...
 

Functions

void pop_adata_free (void **ptr)
 Free the private Account data - Implements Account::adata_free() More...
 
struct PopAccountDatapop_adata_get (struct Mailbox *m)
 Get the Account data for this mailbox. More...
 
struct PopAccountDatapop_adata_new (void)
 Create a new PopAccountData object. More...
 

Detailed Description

Pop-specific Account data.

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

Function Documentation

◆ pop_adata_free()

void pop_adata_free ( void **  ptr)

Free the private Account data - Implements Account::adata_free()

The PopAccountData struct stores global POP data, such as the connection to the database. This function will close the database, free the resources and the struct itself.

Definition at line 40 of file adata.c.

41{
42 if (!ptr || !*ptr)
43 return;
44
45 struct PopAccountData *adata = *ptr;
46 FREE(&adata->auth_list.data);
47 FREE(ptr);
48}
#define FREE(x)
Definition: memory.h:43
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
POP-specific Account data -.
Definition: adata.h:37
+ Here is the caller graph for this function:

◆ pop_adata_get()

struct PopAccountData * pop_adata_get ( struct Mailbox m)

Get the Account data for this mailbox.

Parameters
mMailbox
Return values
ptrPopAccountData

Definition at line 64 of file adata.c.

65{
66 if (!m || (m->type != MUTT_POP))
67 return NULL;
68 struct Account *a = m->account;
69 if (!a)
70 return NULL;
71 return a->adata;
72}
@ MUTT_POP
'POP3' Mailbox type
Definition: mailbox.h:52
A group of associated Mailboxes.
Definition: account.h:37
enum MailboxType type
Mailbox type.
Definition: mailbox.h:102
struct Account * account
Account that owns this Mailbox.
Definition: mailbox.h:127
+ Here is the caller graph for this function:

◆ pop_adata_new()

struct PopAccountData * pop_adata_new ( void  )

Create a new PopAccountData object.

Return values
ptrNew PopAccountData struct

Definition at line 54 of file adata.c.

55{
56 return mutt_mem_calloc(1, sizeof(struct PopAccountData));
57}
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function: