expando_msgid.h File Reference

Message Id Expando definitions. More...

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

Include dependency graph for expando_msgid.h:

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

Go to the source code of this file.

Data Structures
struct	MsgIdData
	Data to generate a Message-Id. More...

Enumerations
enum	ExpandoDataMsgId {   ED_MSG_COUNTER = 1 , ED_MSG_DAY , ED_MSG_HOSTNAME , ED_MSG_HOUR ,   ED_MSG_MINUTE , ED_MSG_MONTH , ED_MSG_PID , ED_MSG_RANDOM_1 ,   ED_MSG_RANDOM_3 , ED_MSG_RANDOM_12 , ED_MSG_SECOND , ED_MSG_YEAR }
	Expando Fields for the Message-Id. More...

Functions
char *	msgid_generate (void)
	Generate a Message-Id.

Variables
const struct ExpandoRenderCallback	MsgIdRenderCallbacks []
	Callbacks for Message Id Expandos.

Detailed Description

Message Id Expando definitions.

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

Enumeration Type Documentation

ExpandoDataMsgId

enum ExpandoDataMsgId

Expando Fields for the Message-Id.

See also

ED_MSG, ExpandoDomain

Enumerator
ED_MSG_COUNTER	Step counter looping from 'A' to 'Z'.
ED_MSG_DAY	Current day of the month (GMT)
ED_MSG_HOSTNAME	$hostname
ED_MSG_HOUR	Current hour using a 24-hour clock (GMT)
ED_MSG_MINUTE	Current month number (GMT)
ED_MSG_MONTH	Current minute of the hour (GMT)
ED_MSG_PID	PID of the running mutt process.
ED_MSG_RANDOM_1	3 bytes of pseudo-random data encoded in Base64
ED_MSG_RANDOM_3	Current second of the minute (GMT)
ED_MSG_RANDOM_12	1 byte of pseudo-random data hex encoded (example: '1b')
ED_MSG_SECOND	Current year using 4 digits (GMT)
ED_MSG_YEAR	4 byte timestamp + 8 bytes of pseudo-random data encoded in Base64

Definition at line 44 of file expando_msgid.h.

{
  ED_MSG_COUNTER = 1,   
  ED_MSG_DAY,           
  ED_MSG_HOSTNAME,      
  ED_MSG_HOUR,          
  ED_MSG_MINUTE,        
  ED_MSG_MONTH,         
  ED_MSG_PID,           
  ED_MSG_RANDOM_1,      
  ED_MSG_RANDOM_3,      
  ED_MSG_RANDOM_12,     
  ED_MSG_SECOND,        
  ED_MSG_YEAR,          
};

Function Documentation

msgid_generate()

char * msgid_generate

(

void

)

Generate a Message-Id.

Return values

ptr	Message ID

Note

The caller should free the string

Definition at line 250 of file expando_msgid.c.

{
  const struct Expando *c_message_id_format = cs_subset_expando(NeoMutt->sub, "message_id_format");
  if (!c_message_id_format)
    return msgid_gen_random();
 
  struct MsgIdData mid = { 0 };
 
  mid.now = time(NULL);
  mid.tm = mutt_date_gmtime(mid.now);
 
  mid.fqdn = mutt_fqdn(false, NeoMutt->sub);
  if (!mid.fqdn)
    mid.fqdn = NONULL(ShortHostname);
 
  struct Buffer *buf = buf_pool_get();
 
  expando_filter(c_message_id_format, MsgIdRenderCallbacks, &mid,
                 MUTT_FORMAT_NO_FLAGS, buf->dsize, NeoMutt->env, buf);
  if (buf_is_empty(buf))
  {
    buf_pool_release(&buf);
    return msgid_gen_random();
  }
 
  if (buf_at(buf, 0) != '<')
    buf_insert(buf, 0, "<");
 
  const int last = buf_len(buf) - 1;
  if (buf_at(buf, last) != '>')
    buf_addch(buf, '>');
 
  char *msgid = buf_strdup(buf);
  buf_pool_release(&buf);
 
  return msgid;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MsgIdRenderCallbacks

const struct ExpandoRenderCallback MsgIdRenderCallbacks[]

extern

Callbacks for Message Id Expandos.

See also

MsgIdFormatDef, ExpandoDataEnvelope

Definition at line 186 of file expando_msgid.c.

                                                            {
  // clang-format off
  { ED_MSG_ID, ED_MSG_COUNTER,   msgid_counter,   NULL             },
  { ED_MSG_ID, ED_MSG_DAY,       NULL,            msgid_day_num    },
  { ED_MSG_ID, ED_MSG_HOSTNAME,  msgid_hostname,  NULL             },
  { ED_MSG_ID, ED_MSG_HOUR,      NULL,            msgid_hour_num   },
  { ED_MSG_ID, ED_MSG_MINUTE,    NULL,            msgid_minute_num },
  { ED_MSG_ID, ED_MSG_MONTH,     NULL,            msgid_month_num  },
  { ED_MSG_ID, ED_MSG_PID,       NULL,            msgid_pid_num    },
  { ED_MSG_ID, ED_MSG_RANDOM_1,  msgid_random_1,  NULL             },
  { ED_MSG_ID, ED_MSG_RANDOM_3,  msgid_random_3,  NULL             },
  { ED_MSG_ID, ED_MSG_RANDOM_12, msgid_random_12, NULL             },
  { ED_MSG_ID, ED_MSG_SECOND,    NULL,            msgid_second_num },
  { ED_MSG_ID, ED_MSG_YEAR,      NULL,            msgid_year_num   },
  { -1, -1, NULL, NULL },
  // clang-format on
};