نام (NAME)

aerc-config - فرمتهای فایل پیکربندی برای کلاینت ایمیل aerc

خلاصه (SYNOPSIS)

سه فایل پیکربندی برای aerc وجود دارد: aerc.conf، binds.conf و accounts.conf. آخرین مورد باید محرمانه نگهداری شود، زیرا ممکن است شامل اطلاعات احراز هویت حساب شما باشد. ما این فایل‌ها را در پوشه پیکربندی خانگی XDG به علاوه aerc جستجو می‌کنیم که پیش‌فرض آن ~/.config/aerc است. فایل‌های جایگزین را می‌توان از طریق آرگومان‌های خط فرمان مشخص کرد، به aerc(1) مراجعه کنید.

نمونه‌هایی از این فایل‌های پیکربندی معمولاً همراه با نصب aerc ارائه می‌شوند و معمولاً در /usr/share/aerc نصب می‌گردند.

هر فایل از فرمت ini استفاده می‌کند و شامل بخش‌هایی با کلیدها و مقادیر است. خطی که با # شروع شود یک کامنت تلقی شده و نادیده گرفته می‌شود، خطوط خالی نیز به همین ترتیب نادیده گرفته می‌شوند. بخش‌های جدید با [section-name] در یک خط مجزا شروع می‌شوند و کلیدها و مقادیر با = از هم جدا می‌گردند.

این صفحه راهنما بر aerc.conf تمرکز دارد. جزئیات binds.conf در aerc-binds(5) و accounts.conf در aerc-accounts(5) آمده است.

فایل aerc.conf برای پیکربندی ظاهر کلی و رفتار aerc استفاده می‌شود.

گزینههای عمومی (GENERAL OPTIONS)

این گزینه‌ها در بخش [general] از aerc.conf پیکربندی می‌شوند.

default-save-path = <path>

pgp-provider = auto|gpg|internal

use-terminal-pinentry = true|false

GPG_TTY=$(tty)
export GPG_TTY

unsafe-accounts-conf = true|false

log-file = <path>

log-level = trace|debug|info|warn|error

disable-ipc = true|false

disable-ipc-mailto = true | false

disable-ipc-mbox = true | false

term = <TERM>

enable-osc8 = true|false

enable-quake-mode = true|false

default-menu-cmd = <cmd>

گزینههای رابط کاربری (UI OPTIONS)

این گزینه‌ها در بخش [ui] از aerc.conf پیکربندی می‌شوند.

index-columns = <column1,column2,column3...>

column-separator = "<separator>"

column-<name> = <go template>

column-flags = {{.Flags | join ""}}
column-name = {{index (.From | names) 0}}
column-subject = {{.ThreadPrefix}}{{.Subject}}
column-date = {{.DateAutoFormat .Date.Local}}

timestamp-format = <timeformat>

this-day-time-format = <timeformat>

this-week-time-format = <timeformat>

this-year-time-format = <timeformat>

message-view-timestamp-format = <timeformat>

message-view-this-day-time-format = <timeformat>

message-view-this-week-time-format = <timeformat>

message-view-this-year-time-format = <timeformat>

sidebar-width = <int>

message-list-split = [<direction>] <size>

empty-message = <string>

empty-dirlist = <string>

empty-subject = <string>

mouse-enabled = true|false

new-message-bell = true|false

tab-title-account = <go_template>

tab-title-composer = <go_template>

tab-title-terminal = <go_template>

tab-title-viewer = <go_template>

pinned-tab-marker = "<string>"

spinner = "<string>"

spinner-delimiter = <string>

spinner-interval = <duration>

sort = <criteria>

dirlist-left = <go template>

dirlist-right = <go template>

dirlist-delay = <duration>

dirlist-tree = true|false

dirlist-collapse = <int>

next-message-on-delete = true|false

auto-mark-read = true|false

auto-mark-read-split = true|false

auto-mark-read-split-delay = <duration>

completion-popovers = true|false

completion-delay = <duration>

completion-min-chars = <int>

border-char-vertical = "<char>"
border-char-horizontal = "<char>"

stylesets-dirs = <path1:path2:path3...>

${XDG_CONFIG_HOME:-~/.config}/aerc/stylesets
${XDG_DATA_HOME:-~/.local/share}/aerc/stylesets
/usr/local/share/aerc/stylesets
/usr/share/aerc/stylesets

styleset-name = <string>

icon-unencrypted = <string>

icon-encrypted = <string>

icon-signed = <string>

icon-signed-encrypted = <string>

icon-unknown = <string>

icon-invalid = <string>

icon-attachment = <string>

icon-new = <string>

icon-old = <string>

icon-replied = <string>

icon-forwarded = <string>

icon-flagged = <string>

icon-marked = <string>

icon-draft = <string>

icon-deleted = <string>

fuzzy-complete = true|false

reverse-msglist-order = true|false

reverse-thread-order = true|false

select-last-message = true|false

sort-thread-siblings = true|false

threading-enabled = true|false

force-client-threads = true|false

threading-by-subject = true|false

client-threads-delay = <duration>

show-thread-context = true|false

msglist-scroll-offset = <int>

dialog-position = top|center|bottom

dialog-width = <width>

dialog-height = <height>

quake-terminal-height = <int>

[PATCH aerc v5] ui: allow thread arrow customisation
├─>[aerc/patches] build success
├─>Re: [PATCH aerc v5] ui: allow thread arrow customisation
├─+
└─>
  ├─>
  │ ├─>
  │ └─>
  │   └─>
  └─>

┌[PATCH aerc v5] ui: allow thread arrow customisation
├─[aerc/patches] build success
├─Re: [PATCH aerc v5] ui: allow thread arrow customisation
├+
╰┬
 ├┬
 │├─
 │╰┬
 │ ╰─
 ╰─

thread-prefix-tip = ""
thread-prefix-indent = ""
thread-prefix-stem = "│"
thread-prefix-limb = "─"
thread-prefix-folded = "+"
thread-prefix-unfolded = ""
thread-prefix-first-child = "┬"
thread-prefix-has-siblings = "├"
thread-prefix-orphan = "┌"
thread-prefix-dummy = "┬"
thread-prefix-lone = " "
thread-prefix-last-sibling = "╰"

[ui:account=Work]
sidebar-width=...
[ui:folder=Sent]
index-format=...
[ui:folder~Archive/d+/.*]
index-format=...

خط وضعیت (STATUSLINE)

این گزینه‌ها در بخش [statusline] از aerc.conf پیکربندی می‌شوند.

status-columns = <column1,column2,column3...>

column-separator = "<separator>"

column-<name> = <go template>

column-left = [{{.Account}}] {{.StatusInfo}}
column-center = {{.PendingKeys}}
column-right = {{.TrayInfo}} | {{cwd}}

separator = "<string>"

display-mode = text|icon

نمایشگر (VIEWER)

این گزینه‌ها در بخش [viewer] از aerc.conf پیکربندی می‌شوند.

pager = <command>

alternatives = <mime,types>

header-layout = <header|layout,list...>

show-headers = true|false

always-show-mime = true|false

max-mime-height = height

parse-http-links = true|false

نگارش (COMPOSE)

این گزینه‌ها در بخش [compose] از aerc.conf پیکربندی می‌شوند.

editor = <command>

header-layout = <header|layout,list...>

edit-headers = true|false

focus-body = true|false

address-book-cmd = <command>

file-picker-cmd = <command>

reply-to-self = true|false

empty-subject-warning = true|false

no-attachment-warning = <regexp>

format-flowed = true|false

lf-editor = true|false

مبدل‌های چندبخشی (MULTIPART CONVERTERS)

مبدل‌ها امکان تولید پیام‌های multipart/alternative را با تبدیل بدنه اصلی text/plain به هر نوع MIME متنی دیگر با دستور :multipart فراهم می‌کنند. فقط انواع دقیق MIME پذیرفته می‌شوند. این دستورات با sh -c فراخوانی می‌شوند و انتظار می‌رود خروجی متن معتبر UTF-8 تولید کنند.

تنها بخش‌های MIME از نوع text/<subtype> را می‌توان تولید کرد. نوع MIME با عنوان text/plain رزرو شده است و قابل تولید نیست. شما همچنان باید رایانامه‌های خود را به صورت دستی در ویرایشگر متنی مورد علاقه خود بنویسید.

مبدل‌ها در بخش [multipart-converters] از aerc.conf پیکربندی می‌شوند.

مثال:

[multipart-converters]
text/html=pandoc -f markdown -t html --standalone

بدیهی است که این امر مستلزم آن است که بدنه اصلی text/plain خود را با نحو نشانه‌گذاری markdown بنویسید. همچنین، در نظر داشته باشید که برخی از فهرست‌های پستی، رایانامه‌های حاوی بخش‌های جایگزین text/html را نمی‌پذیرند. از این قابلیت با احتیاط استفاده کنید و در صورت امکان، از استفاده از آن کاملاً خودداری نمایید.

فیلترها (FILTERS)

فیلترها روشی انعطاف‌پذیر و قدرتمند برای مدیریت مشاهده بخش‌های یک پیام بازشده هستند. هنگام مشاهده پیام‌ها، aerc فهرستی از بخش‌های موجود پیام و نوع MIME آن‌ها را در پایین نشان می‌دهد، اما مگر این‌که فیلتری برای یک نوع MIME خاص تعریف شده باشد، تنها یک منو با چند گزینه نمایش می‌دهد (که به شما امکان می‌دهد آن بخش را در یک برنامه خارجی باز کنید، آن را روی دیسک ذخیره کنید یا به یک دستور پوسته پایپ کنید). پیکربندی یک فیلتر امکان مشاهده خروجی فیلتر در pager پیکربندی‌شده در ترمینال داخلی aerc را فراهم می‌کند.

فیلترها در بخش [filters] از aerc.conf پیکربندی می‌شوند. اولین فیلتری که با نوع MIME آن بخش مطابقت داشته باشد استفاده خواهد شد، بنابراین آن‌ها را از خاص‌ترین به عام‌ترین مرتب کنید. همچنین می‌توانید بر اساس انواع غیر MIME نیز تطابق را انجام دهید، با قرار دادن سرفصلی که باید با آن مطابقت داده شود به عنوان پیشوند (غیرحساس به حروف بزرگ و کوچک) همراه با یک کاما؛ برای مثال subject,text با موضوعی که حاوی text باشد مطابقت خواهد داشت. از header,~regex برای مطابقت با یک regex استفاده کنید. استفاده از .filename به جای یک سرفصل با نام فایل یک فایل پیوست تطابق می‌یابد.

توجه داشته باشید که aerc محتوا را به برنامه فیلتر پیکربندی‌شده پایپ می‌کند، بنابراین فیلترها باید قادر به خواندن از ورودی استاندارد باشند. بسیاری از برنامه‌ها با قرار دادن - به جای مسیر فایل، از خواندن از stdin پشتیبانی می‌کنند. همچنین می‌توانید با لوله‌کشی با | چندین فیلتر را به یکدیگر متصل کنید.

برخی از دستورات فیلتر ممکن است به ورودی تعاملی کاربر نیاز داشته باشند. اگر یک دستور فیلتر با علامت تعجب ! آغاز شود، از pager پیکربندی‌شده استفاده نخواهد شد. در عوض، دستور فیلتر به عنوان فرایند اصلی در ترمینال تعبیه‌شده نمایشگر بخش اجرا خواهد شد. ورودی، خروجی و خطای استاندارد دستور فیلتر روی TTY ترمینال تنظیم خواهد شد. انتظار می‌رود فیلتر صفحه‌بندی اختصاصی خود را پیاده‌سازی کند.

برنامه aerc همراه با برخی فیلترهای پیش‌فرض نصب‌شده در دایرکتوری libexec ارائه می‌شود (معمولاً /usr/libexec/aerc/filters). توجه داشته باشید که این‌ها ممکن است وابستگی‌های اضافه‌ای داشته باشند که aerc به تنهایی فاقد آن‌ها است.

دستورات فیلتر با sh -c command فراخوانی می‌شوند. پوشه‌های زیر به ابتدای متغیر $PATH سیستم اضافه می‌شوند تا امکان ارجاع به فیلترها تنها از طریق نام آن‌ها فراهم شود.

${XDG_CONFIG_HOME:-~/.config}/aerc/filters
~/.local/libexec/aerc/filters
${XDG_DATA_HOME:-~/.local/share}/aerc/filters
$PREFIX/libexec/aerc/filters
$PREFIX/share/aerc/filters
/usr/libexec/aerc/filters
/usr/share/aerc/filters

اگر می‌خواهید برنامه‌ای را در $PATH پیش‌فرض خود اجرا کنید که نامی مشابه یک فیلتر داخلی دارد (مانند /usr/bin/colorize)، از مسیر مطلق آن استفاده کنید.

متغیرهای زیر در محیط دستور فیلتر تعریف شده‌اند:

AERC_MIME_TYPE

توجه داشته باشید که بدنه ایمیل مذکور پیش از انتقال به فیلترها به UTF-8 تبدیل می‌شود.

اگر show-headers فعال باشد، تنها بدنه بخشی که در حال حاضر مشاهده می‌شود به دستور فیلتر پایپ می‌شود. یک دستور فیلتر ویژه به نام .headers می‌تواند برای پردازش تکمیلی سرفصل‌های کامل تعریف شود.

text/plain=colorize

text/plain=wrap -w 100 | colorize

from,thatguywhoneverhardwrapshismessages=wrap -r -w 72 | colorize

subject,~Git(hub|lab)=lolcat -f

text/html=html | colorize

text/html=pandoc -f html -t plain

text/html=! w3m -I UTF-8 -T text/html

text/html=! html-unsafe -sixel

text/calendar=calendar

text/*=bat -fP --file-name="$AERC_FILENAME" --style=plain

.headers=colorize

message/delivery-status=colorize

message/rfc822=caeml | colorize

application/mbox=catbox -c caeml | colorize

application/pdf=pdftotext - -l 10 -nopgbrk -q  - | fmt -w 100

image/*=catimg -w$(tput cols) -

.filename,~.*.csv=column -t --separator=","

برنامه‌های بازکننده (OPENERS)

برنامه‌های بازکننده به شما امکان می‌دهند دستور مورد استفاده برای عملیات‌های :open و :open-link را بر اساس نوع MIME مشخص کنید. طرح نشانی وب (URL scheme) مربوط به :open-link برای تعیین نوع MIME به این صورت به کار می‌رود: x-scheme-handler/<scheme>. این گزینه‌ها در بخش [openers] از aerc.conf پیکربندی می‌شوند.

{} به نام فایل موقت یا نشانی وب بازشونده همراه با نقل‌قول‌گذاری مناسب پوسته بسط داده می‌شود. اگر در دستور وجود نداشته باشد، نام فایل یا نشانی وب به انتهای دستور اضافه خواهد شد. سپس دستور با sh -c اجرا می‌شود.

مشابه [filters]، بازکننده‌ها از الگوهای انطباق مقدماتی پوسته (shell globbing) پشتیبانی می‌کنند. نخستین بازکننده‌ای که با نوع MIME بخش (یا نوع MIME گرداننده طرح نشانی وب) مطابقت داشته باشد استفاده خواهد شد، بنابراین آن‌ها را از خاص‌ترین به عام‌ترین مرتب کنید.

مثال:

[openers]
x-scheme-handler/irc=hexchat
x-scheme-handler/http*=printf '%s' {} | wl-copy
text/html=surf -dfgms
text/plain=gvim {} +125
message/rfc822=thunderbird

قلاب‌ها (HOOKS)

قلاب‌ها هر زمان که رویداد مرتبط رخ دهد اجرا می‌شوند. دستورات در یک محیط پوسته همراه با اطلاعات اضافه‌شده به متغیرهای محیطی اجرا می‌گردند.

آن‌ها در بخش [hooks] از aerc.conf پیکربندی می‌شوند.

aerc-startup = <command>

mail-received = <command>

mail-deleted = <command>

mail-added = <command>

mail-sent = <command>

aerc-shutdown = <command>

tag-modified = <command>

flag-changed = <command>

قالب‌ها (TEMPLATES)

فایل‌های قالب برای پر کردن بدنه یک رایانامه استفاده می‌شوند. دستورات :compose، :reply و :forward را می‌توان با فلگ -T همراه با نام قالب فراخوانی کرد. نمادها و توابع در دسترس در aerc-templates(7) شرح داده شده‌اند.

برنامه aerc همراه با چند قالب پیش‌فرض نصب‌شده در دایرکتوری اشتراکی (معمولاً /usr/share/aerc/templates) عرضه می‌شود.

این گزینه‌ها در بخش [templates] از aerc.conf پیکربندی می‌شوند.

template-dirs = <path1:path2:path3...>

${XDG_CONFIG_HOME:-~/.config}/aerc/templates
${XDG_DATA_HOME:-~/.local/share}/aerc/templates
/usr/local/share/aerc/templates
/usr/share/aerc/templates

new-message = <template_name>

quoted-reply = <template_name>

forwards = <template_name>

همچنین ببینید (SEE ALSO)

aerc(1) aerc-accounts(5) aerc-binds(5) aerc-imap(5) aerc-jmap(5) aerc-maildir(5) aerc-notmuch(5) aerc-templates(7) aerc-sendmail(5) aerc-smtp(5) aerc-stylesets(7) carddav-query(1)

نویسندگان (AUTHORS)

در ابتدا توسط Drew DeVault ایجاد شده و توسط Robin Jarry نگهداری می‌شود که توسط سایر مشارکت‌کنندگان متن‌باز یاری می‌گردد. برای اطلاعات بیشتر در مورد توسعه aerc، به https://sr.ht/~rjarry/aerc مراجعه کنید.