expando_index.h File Reference

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

#include "expando/lib.h"

Include dependency graph for expando_index.h:

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

Go to the source code of 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...

Variables
const struct ExpandoRenderCallback	IndexRenderCallbacks []
	Callbacks for Index 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 expando_index.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 35 of file expando_index.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 53 of file expando_index.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 65 of file expando_index.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,          
};

Variable Documentation

IndexRenderCallbacks

const struct ExpandoRenderCallback IndexRenderCallbacks[]

extern

Callbacks for Index Expandos.

See also

IndexFormatDef, ExpandoDataEmail, ExpandoDataEnvelope, ExpandoDataGlobal, ExpandoDataMailbox

Definition at line 1707 of file expando_index.c.

                                                            {
  // clang-format off
  { ED_EMAIL,    ED_EMA_ATTACHMENT_COUNT,    NULL,                      email_attachment_count },
  { ED_EMAIL,    ED_EMA_BODY_CHARACTERS,     email_body_characters,     NULL },
  { ED_EMAIL,    ED_EMA_COMBINED_FLAGS,      email_combined_flags,      NULL },
  { ED_EMAIL,    ED_EMA_CRYPTO_FLAGS,        email_crypto_flags,        NULL },
  { ED_EMAIL,    ED_EMA_DATE_FORMAT,         email_date_format,         email_date_format_num },
  { ED_EMAIL,    ED_EMA_DATE_FORMAT_LOCAL,   email_date_format_local,   email_date_format_local_num },
  { ED_EMAIL,    ED_EMA_DATE_STRF,           email_date_strf,           email_date_strf_num },
  { ED_EMAIL,    ED_EMA_DATE_STRF_LOCAL,     email_date_strf_local,     email_date_strf_local_num },
  { ED_EMAIL,    ED_EMA_FLAG_CHARS,          email_flag_chars,          NULL },
  { ED_EMAIL,    ED_EMA_FROM_LIST,           email_from_list,           NULL },
  { ED_EMAIL,    ED_EMA_INDEX_HOOK,          email_index_hook,          NULL },
  { ED_EMAIL,    ED_EMA_LINES,               NULL,                      email_lines },
  { ED_EMAIL,    ED_EMA_LIST_OR_SAVE_FOLDER, email_list_or_save_folder, NULL },
  { ED_EMAIL,    ED_EMA_MESSAGE_FLAGS,       email_message_flags,       NULL },
  { ED_EMAIL,    ED_EMA_NUMBER,              NULL,                      email_number },
  { ED_EMAIL,    ED_EMA_SCORE,               NULL,                      email_score },
  { ED_EMAIL,    ED_EMA_SIZE,                email_size,                email_size_num },
  { ED_EMAIL,    ED_EMA_STATUS_FLAGS,        email_status_flags,        NULL },
  { ED_EMAIL,    ED_EMA_STRF_RECV_LOCAL,     email_strf_recv_local,     email_strf_recv_local_num },
  { ED_EMAIL,    ED_EMA_TAGS,                email_tags,                NULL },
  { ED_EMAIL,    ED_EMA_TAGS_TRANSFORMED,    email_tags_transformed,    NULL },
  { ED_EMAIL,    ED_EMA_THREAD_COUNT,        NULL,                      email_thread_count },
  { ED_EMAIL,    ED_EMA_THREAD_HIDDEN_COUNT, email_thread_hidden_count, email_thread_hidden_count_num },
  { ED_EMAIL,    ED_EMA_THREAD_NUMBER,       NULL,                      email_thread_number },
  { ED_EMAIL,    ED_EMA_THREAD_TAGS,         email_thread_tags,         NULL },
  { ED_EMAIL,    ED_EMA_TO_CHARS,            email_to_chars,            NULL },
  { ED_ENVELOPE, ED_ENV_CC_ALL,              envelope_cc_all,           NULL },
  { ED_ENVELOPE, ED_ENV_FIRST_NAME,          envelope_first_name,       NULL },
  { ED_ENVELOPE, ED_ENV_FROM,                envelope_from,             NULL },
  { ED_ENVELOPE, ED_ENV_FROM_FULL,           envelope_from_full,        NULL },
  { ED_ENVELOPE, ED_ENV_INITIALS,            envelope_initials,         NULL },
  { ED_ENVELOPE, ED_ENV_LIST_ADDRESS,        envelope_list_address,     NULL },
  { ED_ENVELOPE, ED_ENV_LIST_EMPTY,          envelope_list_empty,       NULL },
  { ED_ENVELOPE, ED_ENV_MESSAGE_ID,          envelope_message_id,       NULL },
  { ED_ENVELOPE, ED_ENV_NAME,                envelope_name,             NULL },
  { ED_ENVELOPE, ED_ENV_NEWSGROUP,           envelope_newsgroup,        NULL },
  { ED_ENVELOPE, ED_ENV_ORGANIZATION,        envelope_organization,     NULL },
  { ED_ENVELOPE, ED_ENV_REPLY_TO,            envelope_reply_to,         NULL },
  { ED_ENVELOPE, ED_ENV_SENDER,              envelope_sender,           NULL },
  { ED_ENVELOPE, ED_ENV_SENDER_PLAIN,        envelope_sender_plain,     NULL },
  { ED_ENVELOPE, ED_ENV_SPAM,                envelope_spam,             NULL },
  { ED_ENVELOPE, ED_ENV_SUBJECT,             envelope_subject,          NULL },
  { ED_ENVELOPE, ED_ENV_THREAD_TREE,         envelope_thread_tree,      NULL },
  { ED_ENVELOPE, ED_ENV_THREAD_X_LABEL,      envelope_thread_x_label,   NULL },
  { ED_ENVELOPE, ED_ENV_TO,                  envelope_to,               NULL },
  { ED_ENVELOPE, ED_ENV_TO_ALL,              envelope_to_all,           NULL },
  { ED_ENVELOPE, ED_ENV_USERNAME,            envelope_username,         NULL },
  { ED_ENVELOPE, ED_ENV_X_COMMENT_TO,        envelope_x_comment_to,     NULL },
  { ED_ENVELOPE, ED_ENV_X_LABEL,             envelope_x_label,          NULL },
  { ED_MAILBOX,  ED_MBX_MAILBOX_NAME,        mailbox_mailbox_name,      NULL },
  { ED_MAILBOX,  ED_MBX_MESSAGE_COUNT,       NULL,                      mailbox_message_count },
  { ED_MAILBOX,  ED_MBX_PERCENTAGE,          mailbox_percentage,        NULL },
  { -1, -1, NULL, NULL },
  // clang-format on
};