1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2024-11-12 Tue 23:39 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Chotto</title>
<meta name="author" content="User Mms" />
<meta name="generator" content="Org Mode" />
<style>
#content { max-width: 60em; margin: auto; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #e6e6e6;
border-radius: 3px;
background-color: #f2f2f2;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
}
pre.src:before {
display: none;
position: absolute;
top: -8px;
right: 12px;
padding: 3px;
color: #555;
background-color: #f2f2f299;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-authinfo::before { content: 'Authinfo'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { }
</style>
</head>
<body>
<div id="content" class="content">
<h1 class="title">Chotto</h1>
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orgdd2ec1d">1. Naming & Afew</a></li>
<li><a href="#orgb9e39e9">2. Prerequisites</a></li>
<li><a href="#org6363f6d">3. Configuration</a></li>
<li><a href="#org60dbc75">4. Config</a></li>
<li><a href="#org31ef853">5. Rule sets</a></li>
<li><a href="#org50fb573">6. Filter language</a></li>
</ul>
</div>
</div>
<p>
Chotto is an initial tagging script for Notmuch
</p>
<ul class="org-ul">
<li><a href="http://notmuchmail.org/">http://notmuchmail.org/</a></li>
<li><a href="http://notmuchmail.org/initial_tagging/">http://notmuchmail.org/initial_tagging/</a></li>
</ul>
<p>
Chotto is written in Ruby and had a (quite) nice DSL for configuration.
</p>
<div id="outline-container-orgdd2ec1d" class="outline-2">
<h2 id="orgdd2ec1d"><span class="section-number-2">1.</span> Naming & Afew</h2>
<div class="outline-text-2" id="text-1">
<p>
Notmuch ecosystem already has a great script for initial tagging - afew.
However it is written in Python and therefore it's always a gamble if it will consider the user worthy or running.
</p>
<p>
Chotto, <code>a few</code> in Japanese.
Because afew refused to work on my system.
And because I love Ruby!
</p>
</div>
</div>
<div id="outline-container-orgb9e39e9" class="outline-2">
<h2 id="orgb9e39e9"><span class="section-number-2">2.</span> Prerequisites</h2>
<div class="outline-text-2" id="text-2">
<p>
Chotto expects:
</p>
<ul class="org-ul">
<li>ruby 3x</li>
<li>notmuch</li>
<li>notmuch ruby bindings.</li>
</ul>
<p>
While the first 2 are obvious, getting ruby bindings to work may be an adventure on its own.
</p>
<p>
<b>FreeBSD</b> provides a ready package <code>ruby-notmuch</code>.
</p>
<p>
<b>MacOS</b> requires compiling from source, which will be problematic due to linking difficulties.
It's not an OS designed for technical folks.
</p>
<p>
Some <b>Linux</b> distros provide the bindings in their package managers, but otherwise compiling should be easy.
</p>
<p>
If you use <b>Windows</b>, you have my sympathy.
</p>
</div>
</div>
<div id="outline-container-org6363f6d" class="outline-2">
<h2 id="org6363f6d"><span class="section-number-2">3.</span> Configuration</h2>
<div class="outline-text-2" id="text-3">
<p>
Chotto expects the configuration file to be present in
</p>
<p>
<code>~/.config/chotto/config.rb</code>
</p>
<p>
The user needs to add (at least) two blocks to the file: config & rule sets
</p>
</div>
</div>
<div id="outline-container-org60dbc75" class="outline-2">
<h2 id="org60dbc75"><span class="section-number-2">4.</span> Config</h2>
<div class="outline-text-2" id="text-4">
<p>
Presently, the only option Config expects is the absolute path to the Notmuch database:
</p>
<div class="org-src-container">
<pre class="src src-ruby">Chotto.configure do
config.database_path = =/home/<user>/mail=
end
</pre>
</div>
<p>
Please, adjust the path to the valid location
</p>
</div>
</div>
<div id="outline-container-org31ef853" class="outline-2">
<h2 id="org31ef853"><span class="section-number-2">5.</span> Rule sets</h2>
<div class="outline-text-2" id="text-5">
<p>
The actual magic happens in <code>Rule Sets</code> which are sets of filters & tag modifications.
A very simple rule set can look like:
</p>
<div class="org-src-container">
<pre class="src src-ruby">Chotto.rule_set "notes" do
messages.filter(from: "<my email>").each do |msg|
msg.tags << "note"
msg.save!
end
end
</pre>
</div>
<p>
Let's break it down.
</p>
<p>
First, we define a named <code>rule_set</code>.
The name can be a string or a hash and is currently not used anywhere.
It makes it easier to manager bigger rule sets.
</p>
<p>
Then we search for messages.
In this case, we want all messages sent from <code><my email></code> .
</p>
<p>
After, we loop over each found message.
</p>
<p>
msg.tags returns a mutable array, and we can mutate is as such.
</p>
<p>
Lastly, we save! the message in the database.
</p>
</div>
</div>
<div id="outline-container-org50fb573" class="outline-2">
<h2 id="org50fb573"><span class="section-number-2">6.</span> Filter language</h2>
<div class="outline-text-2" id="text-6">
<p>
We can quite easily filter messages based. Chotto accepts filters as:
</p>
<ul class="org-ul">
<li>Strings (from(<code>Subject:Hired!</code>)).
The string will not be modified.</li>
<li><p>
Hash with string values (from(subject: <code>Hired</code>)).
The key of each hash element is a modified header value - it's down cased, and <code>-</code> becomes <code>_</code>, therefore:
</p>
<ul class="org-ul">
<li><code>X-Spam-Id</code> becomes <code>x_spam_id</code></li>
<li><code>X-Thread-Id</code> becomes <code>x_thread_id</code></li>
</ul>
<p>
The values on the other hand can be:
</p>
<ul class="org-ul">
<li>String.
Kind of obvious.</li>
<li>Array.
Arrays here are treated as the current conjunctions.
The default conjunction here is <code>OR</code>, so <code>k: [1,2]</code> will become <code>key:1 OR key:2</code></li>
</ul>
<p>
User can add multiple elements to the hash, and they will be join in the current conjunction mode.
By default the mode is <code>AND</code>, therefore:
</p>
<p>
{key: 'val1', key2: 'val2'} are treated as <code>key:val1 AND key2:val2</code>.
</p>
<p>
<code>filter</code> returns self, therefore we can combine multiple filters <code>filter(key1: 'val').filter(key2: 'val2')</code>.
Filters will be joined in the current conjunction mode.
</p>
<p>
Conjunction mode can be changed using the <code>or</code> and <code>and</code> methods: filter(key1: <code>val1</code>).or.filter(key2: <code>val2</code>).
</p>
<p>
The language is simple, but gives huge chances to go wrong.
You can test what is produced by calling <code>#to_query_string</code> on messages instance.
</p></li>
</ul>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: User Mms</p>
<p class="date">Created: 2024-11-12 Tue 23:39</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>
|
