Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
aerc-templates(7)      Miscellaneous Information Manual	     aerc-templates(7)

NAME
       aerc-templates -	template file specification for	aerc(1)

SYNOPSIS
       aerc uses the go	"text/template"	package	for the	template parsing. Re-
       fer to the go text/template documentation for the general syntax.

       Template	files are composed of headers, followed	by a newline, followed
       by the body text.

       Example:

	   X-Clacks-Overhead: GNU Terry	Pratchett

	   Hello,

	   Greetings,
	   Chuck

       If you have a template that doesn't add any header, it must be preceded
       by a newline, to	avoid parsing parts of the body	as header text.

MESSAGE	DATA
       The following data can be used in templates. Though they	are not	all
       available always.

       Addresses
	   An array of mail.Address. That can be used to add sender or recipi-
	   ent names to	the template.

	   o   From: List of senders.
	   o   To: List	of To recipients. Not always Available.
	   o   Cc: List	of Cc recipients. Not always Available.
	   o   Bcc: List of Cc recipients. Not always Available.
	   o   OriginalFrom: List of senders of	the original message. Avail-
	       able for	quoted reply and forward.

	   Example:

	   Get the name	of the first sender.
	       {{(index	.From 0).Name}}

	   Get the email address of the	first sender.
	       {{(index	.From 0).Address}}

       Date and	Time
	   The date and	time information is always available and can be	easily
	   formated.

	   o   Date: Date and Time information when the	compose	window is
	       opened.
	   o   OriginalDate: Date and Time when	the original message of	re-
	       ceived. Available for quoted reply and forward.

	   To format the date fields, dateFormat and toLocal are provided. Re-
	   fer to the TEMPLATE FUNCTIONS section for details.

       Subject
	   The subject of the email is available for quoted reply and forward.

	   {{.Subject}}

       MIME Type
	   MIME	Type is	available for quoted reply.

	   o   OriginalMIMEType: MIME type info	of quoted mail part. Usually
	       "text/plain" or "text/html".

       Original	Message
	   When	using quoted reply or forward, the original message is avail-
	   able	in a field called ".OriginalText".

	       {{.OriginalText}}

TEMPLATE FUNCTIONS
       Besides the standard functions described	in go's	text/template documen-
       tation, aerc provides the following additional functions:

       wrap
	   Wrap	the original text to the specified number of characters	per
	   line.

	       {{wrap 72 .OriginalText}}

       quote
	   Prepends each line with "> ".

	       {{quote .OriginalText}}

       exec
	   Execute external command, provide the second	argument to its	stdin.

	       {{exec `/usr/local/share/aerc/filters/html` .OriginalText}}

       toLocal
	   Convert the date to the local timezone as specified by the locale.

	       {{toLocal .Date}}

       dateFormat
	   Format date and time	according to the format	passed as the second
	   argument. The format	must be	specified according to go's time pack-
	   age format.

	       {{dateFormat .Date "Mon Jan 2 15:04:05 -0700 MST	2006"}}

       version
	   Returns the version of aerc,	which can be useful for	things like X-
	   Mailer.

	       X-Mailer: aerc {{version}}

       Function	chaining
	   All of the template functions can be	chained	together if needed.

	   Example: Automatic HTML parsing for text/html mime type messages
	       {{if eq .OriginalMIMEType "text/html"}}
	       {{exec `/usr/local/share/aerc/filters/html` .OriginalText | wrap	72 | quote}}
	       {{else}}
	       {{wrap 72 .OriginalText | quote}}
	       {{end}}

SEE ALSO
       aerc(1) aerc-config(5)

AUTHORS
       Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
       open source contributors. For more information about aerc development,
       see https://git.sr.ht/~sircmpwn/aerc.

				  2021-03-01		     aerc-templates(7)

NAME | SYNOPSIS | MESSAGE DATA | TEMPLATE FUNCTIONS | SEE ALSO | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=aerc-templates&sektion=7&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help