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

#include <stddef.h>
#include "expando/lib.h"

Include dependency graph for hdrline.h:

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

Enumerations
enum	FlagChars { FLAG_CHAR_TAGGED , FLAG_CHAR_IMPORTANT , FLAG_CHAR_DELETED , FLAG_CHAR_DELETED_ATTACH , FLAG_CHAR_REPLIED , FLAG_CHAR_OLD , FLAG_CHAR_NEW , FLAG_CHAR_OLD_THREAD , FLAG_CHAR_NEW_THREAD , FLAG_CHAR_SEMPTY , FLAG_CHAR_ZEMPTY }
	Index into the `$flag_chars` config variable. More...

enum	CryptChars { FLAG_CHAR_CRYPT_GOOD_SIGN , FLAG_CHAR_CRYPT_ENCRYPTED , FLAG_CHAR_CRYPT_SIGNED , FLAG_CHAR_CRYPT_CONTAINS_KEY , FLAG_CHAR_CRYPT_NO_CRYPTO }
	Index into the `$crypt_chars` config variable. More...

enum	ToChars { FLAG_CHAR_TO_NOT_IN_THE_LIST , FLAG_CHAR_TO_UNIQUE , FLAG_CHAR_TO_TO , FLAG_CHAR_TO_CC , FLAG_CHAR_TO_ORIGINATOR , FLAG_CHAR_TO_SUBSCRIBED_LIST , FLAG_CHAR_TO_REPLY_TO }
	Index into the `$to_chars` config variable. More...

Functions
int	mutt_make_string (struct Buffer buf, size_t max_cols, const struct Expando exp, struct Mailbox m, int inpgr, struct Email e, MuttFormatFlags flags, const char *progress)
	Create formatted strings using mailbox expandos.

Detailed Description

String processing routines to generate the mail index.

Authors

Richard Russon
Pietro Cerutti
Tóth János

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.

Enumeration Type Documentation

◆ FlagChars

enum FlagChars

Index into the $flag_chars config variable.

Enumerator
FLAG_CHAR_TAGGED	Character denoting a tagged email.
FLAG_CHAR_IMPORTANT	Character denoting a important (flagged) email.
FLAG_CHAR_DELETED	Character denoting a deleted email.
FLAG_CHAR_DELETED_ATTACH	Character denoting a deleted attachment.
FLAG_CHAR_REPLIED	Character denoting an email that has been replied to.
FLAG_CHAR_OLD	Character denoting an email that has been read.
FLAG_CHAR_NEW	Character denoting an unread email.
FLAG_CHAR_OLD_THREAD	Character denoting a thread of emails that has been read.
FLAG_CHAR_NEW_THREAD	Character denoting a thread containing at least one new email.
FLAG_CHAR_SEMPTY	Character denoting a read email, $index_format S expando.
FLAG_CHAR_ZEMPTY	Character denoting a read email, $index_format Z expando.

Definition at line 38 of file hdrline.h.

{
  FLAG_CHAR_TAGGED,           
  FLAG_CHAR_IMPORTANT,        
  FLAG_CHAR_DELETED,          
  FLAG_CHAR_DELETED_ATTACH,   
  FLAG_CHAR_REPLIED,          
  FLAG_CHAR_OLD,              
  FLAG_CHAR_NEW,              
  FLAG_CHAR_OLD_THREAD,       
  FLAG_CHAR_NEW_THREAD,       
  FLAG_CHAR_SEMPTY,           
  FLAG_CHAR_ZEMPTY,           
};

◆ CryptChars

enum CryptChars

Index into the $crypt_chars config variable.

Enumerator
FLAG_CHAR_CRYPT_GOOD_SIGN	Character denoting a message signed with a verified key.
FLAG_CHAR_CRYPT_ENCRYPTED	Character denoting a message is PGP-encrypted.
FLAG_CHAR_CRYPT_SIGNED	Character denoting a message is signed.
FLAG_CHAR_CRYPT_CONTAINS_KEY	Character denoting a message contains a PGP key.
FLAG_CHAR_CRYPT_NO_CRYPTO	Character denoting a message has no cryptography information.

Definition at line 56 of file hdrline.h.

{
  FLAG_CHAR_CRYPT_GOOD_SIGN,      
  FLAG_CHAR_CRYPT_ENCRYPTED,      
  FLAG_CHAR_CRYPT_SIGNED,         
  FLAG_CHAR_CRYPT_CONTAINS_KEY,   
  FLAG_CHAR_CRYPT_NO_CRYPTO,      
};

◆ ToChars

enum ToChars

Index into the $to_chars config variable.

Enumerator
FLAG_CHAR_TO_NOT_IN_THE_LIST	Character denoting that the user is not in list.
FLAG_CHAR_TO_UNIQUE	Character denoting that the user is unique recipient.
FLAG_CHAR_TO_TO	Character denoting that the user is in the TO list.
FLAG_CHAR_TO_CC	Character denoting that the user is in the CC list.
FLAG_CHAR_TO_ORIGINATOR	Character denoting that the user is originator.
FLAG_CHAR_TO_SUBSCRIBED_LIST	Character denoting that the message is sent to a subscribed mailing list.
FLAG_CHAR_TO_REPLY_TO	Character denoting that the user is in the Reply-To list.

Definition at line 68 of file hdrline.h.

{
  FLAG_CHAR_TO_NOT_IN_THE_LIST,   
  FLAG_CHAR_TO_UNIQUE,            
  FLAG_CHAR_TO_TO,                
  FLAG_CHAR_TO_CC,                
  FLAG_CHAR_TO_ORIGINATOR,        
  FLAG_CHAR_TO_SUBSCRIBED_LIST,   
  FLAG_CHAR_TO_REPLY_TO,          
};

Function Documentation

◆ mutt_make_string()

int mutt_make_string	(	struct Buffer *	buf,
		size_t	max_cols,
		const struct Expando *	exp,
		struct Mailbox *	m,
		int	inpgr,
		struct Email *	e,
		MuttFormatFlags	flags,
		const char *	progress
	)

Create formatted strings using mailbox expandos.

Parameters

buf	Buffer for the result
max_cols	Number of screen columns (-1 means unlimited)
exp	Expando containing expando tree
m	Mailbox
inpgr	Message shown in the pager
e	Email
flags	Flags, see MuttFormatFlags
progress	Pager progress string

Return values

num	Number of screen columns used

Definition at line 1719 of file hdrline.c.

{
  if (!exp)
    return 0;
 
  struct HdrFormatInfo hfi = { 0 };
 
  hfi.email = e;
  hfi.mailbox = m;
  hfi.msg_in_pager = inpgr;
  hfi.pager_progress = progress;
 
  return expando_filter(exp, IndexRenderData, &hfi, flags, max_cols, buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Enumerations