alias.h File Reference

Representation of a single alias to an email address. More...

#include "mutt/lib.h"
#include "address/lib.h"
#include "email/lib.h"

Include dependency graph for alias.h:

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

Go to the source code of this file.

Data Structures
struct	Alias
	A shortcut for an email address or addresses. More...
struct	EventAlias
	An alias-change event. More...

Enumerations
enum	NotifyAlias { NT_ALIAS_ADD = 1 , NT_ALIAS_DELETE , NT_ALIAS_DELETE_ALL , NT_ALIAS_CHANGE }
	Alias notification types. More...

Functions
	TAILQ_HEAD (AliasList, Alias)
void	alias_free (struct Alias **ptr)
	Free an Alias.
struct Alias *	alias_new (void)
	Create a new Alias.
void	aliaslist_clear (struct AliasList *al)
	Empty a List of Aliases.

Variables
struct AliasList	Aliases
	List of all the user's email aliases.

Detailed Description

Representation of a single alias to an email address.

Authors

• Richard Russon
• Pietro Cerutti

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

Enumeration Type Documentation

NotifyAlias

enum NotifyAlias

Alias notification types.

Observers of NT_ALIAS will be passed an EventAlias.

Note

Delete notifications are sent before the object is deleted.

Other notifications are sent after the event.

Enumerator
NT_ALIAS_ADD	Alias has been added.
NT_ALIAS_DELETE	Alias is about to be deleted.
NT_ALIAS_DELETE_ALL	All Aliases are about to be deleted.
NT_ALIAS_CHANGE	Alias has been changed.

Definition at line 54 of file alias.h.

{
  NT_ALIAS_ADD = 1,    
  NT_ALIAS_DELETE,     
  NT_ALIAS_DELETE_ALL, 
  NT_ALIAS_CHANGE,     
};

Function Documentation

TAILQ_HEAD()

TAILQ_HEAD	(	AliasList	,
		Alias
	)

alias_free()

void alias_free

(

struct Alias **

ptr

)

Free an Alias.

Parameters

[out]

ptr

Alias to free

Definition at line 672 of file alias.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Alias *alias = *ptr;
 
  mutt_debug(LL_NOTIFY, "NT_ALIAS_DELETE: %s\n", alias->name);
  struct EventAlias ev_a = { alias };
  notify_send(NeoMutt->notify, NT_ALIAS, NT_ALIAS_DELETE, &ev_a);
 
  FREE(&alias->name);
  FREE(&alias->comment);
  driver_tags_free(&alias->tags);
  mutt_addrlist_clear(&(alias->addr));
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

alias_new()

struct Alias * alias_new

(

void

)

Create a new Alias.

Return values

ptr	Newly allocated Alias

Free the result with alias_free()

Definition at line 660 of file alias.c.

{
  struct Alias *a = mutt_mem_calloc(1, sizeof(struct Alias));
  TAILQ_INIT(&a->addr);
  STAILQ_INIT(&a->tags);
  return a;
}

Here is the call graph for this function:

Here is the caller graph for this function:

aliaslist_clear()

void aliaslist_clear

(

struct AliasList *

al

)

Empty a List of Aliases.

Parameters

al	AliasList to empty

Each Alias will be freed and the AliasList will be left empty.

Definition at line 697 of file alias.c.

{
  if (!al)
    return;
 
  struct Alias *np = NULL, *tmp = NULL;
  TAILQ_FOREACH_SAFE(np, al, entries, tmp)
  {
    TAILQ_REMOVE(al, np, entries);
    alias_free(&np);
  }
  TAILQ_INIT(al);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

Aliases

struct AliasList Aliases

extern

List of all the user's email aliases.

Definition at line 62 of file alias.c.