hdrline.h File Reference

String processing routines to generate the mail index. More...

#include <stdbool.h>
#include <stdio.h>
#include "format_flags.h"

Include dependency graph for hdrline.h:

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

Go to the source code of this file.

Data Structures
struct	HdrFormatInfo
	Data passed to index_format_str() More...

Macros
#define	mutt_make_string(BUF, BUFLEN, COLS, S, CTX, M, E)   mutt_make_string_flags(BUF, BUFLEN, COLS, S, CTX, M, E, MUTT_FORMAT_NO_FLAGS)

Functions
bool	mutt_is_mail_list (const struct Address *addr)
	Is this the email address of a mailing list? More...
bool	mutt_is_subscribed_list (const struct Address *addr)
	Is this the email address of a user-subscribed mailing list? More...
void	mutt_make_string_flags (char *buf, size_t buflen, int cols, const char *s, struct Context *ctx, struct Mailbox *m, struct Email *e, MuttFormatFlags flags)
	Create formatted strings using mailbox expandos. More...
void	mutt_make_string_info (char *buf, size_t buflen, int cols, const char *s, struct HdrFormatInfo *hfi, MuttFormatFlags flags)
	Create pager status bar string. More...

Variables
struct MbTable *	C_CryptChars
	Config: User-configurable crypto flags: signed, encrypted etc. More...
struct MbTable *	C_FlagChars
	Config: User-configurable index flags: tagged, new, etc. More...
struct MbTable *	C_FromChars
	Config: User-configurable index flags: to address, cc address, etc. More...
struct MbTable *	C_ToChars
	Config: Indicator characters for the 'To' field in the index. More...

Detailed Description

String processing routines to generate the mail index.

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

Macro Definition Documentation

mutt_make_string

#define mutt_make_string	(		BUF,
			BUFLEN,
			COLS,
			S,
			CTX,
			M,
			E
	)		mutt_make_string_flags(BUF, BUFLEN, COLS, S, CTX, M, E, MUTT_FORMAT_NO_FLAGS)

Definition at line 61 of file hdrline.h.

Function Documentation

mutt_is_mail_list()

bool mutt_is_mail_list

(

const struct Address *

addr

)

Is this the email address of a mailing list?

Parameters

addr	Address to test

Return values

true	If it's a mailing list

Definition at line 114 of file hdrline.c.

{
  if (!mutt_regexlist_match(&UnMailLists, addr->mailbox))
    return mutt_regexlist_match(&MailLists, addr->mailbox);
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_is_subscribed_list()

bool mutt_is_subscribed_list

(

const struct Address *

addr

)

Is this the email address of a user-subscribed mailing list?

Parameters

addr	Address to test

Return values

true	If it's a subscribed mailing list

Definition at line 126 of file hdrline.c.

{
  if (!mutt_regexlist_match(&UnMailLists, addr->mailbox) &&
      !mutt_regexlist_match(&UnSubscribedLists, addr->mailbox))
  {
    return mutt_regexlist_match(&SubscribedLists, addr->mailbox);
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_make_string_flags()

void mutt_make_string_flags	(	char *	buf,
		size_t	buflen,
		int	cols,
		const char *	s,
		struct Context *	ctx,
		struct Mailbox *	m,
		struct Email *	e,
		MuttFormatFlags	flags
	)

Create formatted strings using mailbox expandos.

Parameters

buf	Buffer for the result
buflen	Buffer length
cols	Number of screen columns (OPTIONAL)
s	printf-line format string
ctx	Mailbox Context
m	Mailbox
e	Email
flags	Flags, see MuttFormatFlags

Definition at line 1505 of file hdrline.c.

{
  struct HdrFormatInfo hfi;

  hfi.email = e;
  hfi.ctx = ctx;
  hfi.mailbox = m;
  hfi.pager_progress = 0;

  mutt_expando_format(buf, buflen, 0, cols, s, index_format_str, (unsigned long) &hfi, flags);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_make_string_info()

void mutt_make_string_info	(	char *	buf,
		size_t	buflen,
		int	cols,
		const char *	s,
		struct HdrFormatInfo *	hfi,
		MuttFormatFlags	flags
	)

Create pager status bar string.

Parameters

buf	Buffer for the result
buflen	Buffer length
cols	Number of screen columns
s	printf-line format string
hfi	Mailbox data to pass to the formatter
flags	Flags, see MuttFormatFlags

Definition at line 1528 of file hdrline.c.

{
  mutt_expando_format(buf, buflen, 0, cols, s, index_format_str, (unsigned long) hfi, flags);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C_CryptChars

struct MbTable* C_CryptChars

Config: User-configurable crypto flags: signed, encrypted etc.

Definition at line 59 of file hdrline.c.

C_FlagChars

struct MbTable* C_FlagChars

Config: User-configurable index flags: tagged, new, etc.

Definition at line 60 of file hdrline.c.

C_FromChars

struct MbTable* C_FromChars

Config: User-configurable index flags: to address, cc address, etc.

Definition at line 61 of file hdrline.c.

C_ToChars

struct MbTable* C_ToChars

Config: Indicator characters for the 'To' field in the index.

Definition at line 62 of file hdrline.c.