alternates.h File Reference

Alternate address handling. More...

#include <stdbool.h>
#include <stdint.h>
#include "core/lib.h"

Include dependency graph for alternates.h:

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

Go to the source code of this file.

Enumerations
enum	NotifyAlternates { NT_ALTERN_ADD = 1 , NT_ALTERN_DELETE , NT_ALTERN_DELETE_ALL }
	Alternates command notification types. More...

Functions
void	alternates_init (void)
	Set up the alternates lists.
void	alternates_cleanup (void)
	Free the alternates lists.
enum CommandResult	parse_alternates (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'alternates' command - Implements Command::parse() -.
enum CommandResult	parse_unalternates (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unalternates' command - Implements Command::parse() -.
bool	mutt_alternates_match (const char *addr)
	Compare an Address to the Un/Alternates lists.
void	mutt_alternates_reset (struct MailboxView *mv)
	Clear the recipient valid flag of all emails.

Detailed Description

Alternate address handling.

Authors

• 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 alternates.h.

Enumeration Type Documentation

NotifyAlternates

enum NotifyAlternates

Alternates command notification types.

Observers of NT_ALTERN will not be passed any Event data.

Note

Notifications are sent after the event.

Enumerator
NT_ALTERN_ADD	Alternate address has been added.
NT_ALTERN_DELETE	Alternate address has been deleted.
NT_ALTERN_DELETE_ALL	All Alternate addresses have been deleted.

Definition at line 40 of file alternates.h.

{
  NT_ALTERN_ADD = 1,    
  NT_ALTERN_DELETE,     
  NT_ALTERN_DELETE_ALL, 
};

Function Documentation

alternates_init()

void alternates_init

(

void

)

Set up the alternates lists.

Definition at line 60 of file alternates.c.

{
  if (AlternatesNotify)
    return;
 
  AlternatesNotify = notify_new();
  notify_set_parent(AlternatesNotify, NeoMutt->notify);
}

Here is the call graph for this function:

Here is the caller graph for this function:

alternates_cleanup()

void alternates_cleanup

(

void

)

Free the alternates lists.

Definition at line 49 of file alternates.c.

{
  notify_free(&AlternatesNotify);
 
  mutt_regexlist_free(&Alternates);
  mutt_regexlist_free(&UnAlternates);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_alternates_match()

bool mutt_alternates_match

(

const char *

addr

)

Compare an Address to the Un/Alternates lists.

Parameters

addr	Address to check

Return values

true	Address matches

Definition at line 155 of file alternates.c.

{
  if (!addr)
    return false;
 
  if (mutt_regexlist_match(&Alternates, addr))
  {
    mutt_debug(LL_DEBUG5, "yes, %s matched by alternates\n", addr);
    if (mutt_regexlist_match(&UnAlternates, addr))
      mutt_debug(LL_DEBUG5, "but, %s matched by unalternates\n", addr);
    else
      return true;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_alternates_reset()

void mutt_alternates_reset

(

struct MailboxView *

mv

)

Clear the recipient valid flag of all emails.

Parameters

mv	Mailbox view

Definition at line 73 of file alternates.c.

{
  if (!mv || !mv->mailbox)
    return;
 
  struct Mailbox *m = mv->mailbox;
 
  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e)
      break;
    e->recip_valid = false;
  }
}

Here is the caller graph for this function: