subjectrx.h File Reference

Subject Regex handling. More...

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

Include dependency graph for subjectrx.h:

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

Go to the source code of this file.

Enumerations
enum	NotifySubjRx { NT_SUBJRX_ADD = 1 , NT_SUBJRX_DELETE , NT_SUBJRX_DELETE_ALL }
	Subject Regex notification types. More...

Functions
void	subjrx_init (void)
	Create new Subject Regex List.
void	subjrx_cleanup (void)
	Free the Subject Regex List.
enum CommandResult	parse_subjectrx_list (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'subjectrx' command - Implements Command::parse() -.
enum CommandResult	parse_unsubjectrx_list (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unsubjectrx' command - Implements Command::parse() -.
bool	subjrx_apply_mods (struct Envelope *env)
	Apply regex modifications to the subject.
void	subjrx_clear_mods (struct MailboxView *mv)
	Clear out all modified email subjects.

Detailed Description

Subject Regex 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 subjectrx.h.

Enumeration Type Documentation

NotifySubjRx

enum NotifySubjRx

Subject Regex notification types.

Observers of NT_SUBJRX will not be passed any Event data.

Note

Notifications are sent after the event.

Enumerator
NT_SUBJRX_ADD	Subject Regex has been added.
NT_SUBJRX_DELETE	Subject Regex has been deleted.
NT_SUBJRX_DELETE_ALL	All Subject Regexes have been deleted.

Definition at line 41 of file subjectrx.h.

{
  NT_SUBJRX_ADD = 1,    
  NT_SUBJRX_DELETE,     
  NT_SUBJRX_DELETE_ALL, 
};

Function Documentation

subjrx_init()

void subjrx_init

(

void

)

Create new Subject Regex List.

Definition at line 55 of file subjectrx.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

subjrx_cleanup()

void subjrx_cleanup

(

void

)

Free the Subject Regex List.

Definition at line 46 of file subjectrx.c.

{
  notify_free(&SubjRxNotify);
  mutt_replacelist_free(&SubjectRegexList);
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjrx_apply_mods()

bool subjrx_apply_mods

(

struct Envelope *

env

)

Apply regex modifications to the subject.

Parameters

env	Envelope of Email

Return values

true	Subject modified

Definition at line 133 of file subjectrx.c.

{
  if (!env || !env->subject || (*env->subject == '\0'))
    return false;
 
  if (env->disp_subj)
    return true;
 
  if (STAILQ_EMPTY(&SubjectRegexList))
    return false;
 
  env->disp_subj = mutt_replacelist_apply(&SubjectRegexList, env->subject);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjrx_clear_mods()

void subjrx_clear_mods

(

struct MailboxView *

mv

)

Clear out all modified email subjects.

Parameters

mv	Mailbox view

Definition at line 152 of file subjectrx.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 || !e->env)
      continue;
    FREE(&e->env->disp_subj);
  }
}

Here is the caller graph for this function: