]> code.delx.au - gnu-emacs-elpa/blob - packages/gnorb/gnorb.info
Merging Gnorb commits up to 1.0.1
[gnu-emacs-elpa] / packages / gnorb / gnorb.info
1 This is gnorb.info, produced by makeinfo version 5.2 from gnorb.texi.
2
3 INFO-DIR-SECTION Emacs
4 START-INFO-DIR-ENTRY
5 * Gnorb: (gnorb). Glue code for Gnus, Org, and BBDB.
6 END-INFO-DIR-ENTRY
7
8 \1f
9 File: gnorb.info, Node: Top, Next: Introduction, Up: (dir)
10
11 Gnorb Manual
12 ************
13
14 * Menu:
15
16 * Introduction::
17 * Installation::
18 * Setup::
19 * Email Tracking::
20 * Restoring Window Layout::
21 * Recent Mails From BBDB Contacts::
22 * BBDB posting styles::
23 * BBDB Org tagging::
24 * Misc BBDB::
25 * Misc Org::
26 * Misc Gnus::
27 * Suggested Keybindings::
28
29 — The Detailed Node Listing —
30
31 Email Tracking
32
33 * Email-Related Commands::
34 * Trigger Actions::
35 * Viewing Tracked Messages in *Summary* Buffers::
36 * Hinting in Gnus::
37 * Message Attachments::
38 * Likely Workflow::
39
40 Misc BBDB
41
42 * Searching for messages from BBDB contacts::
43 * Citing BBDB contacts::
44 * User Options::
45
46 Misc Org
47
48 * Inserting BBDB links::
49 * User Options: User Optionsx.
50
51 Misc Gnus
52
53 * Viewing Org headlines relevant to a message::
54 * User Options: User Optionsxx.
55
56 \1f
57 File: gnorb.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
58
59 1 Introduction
60 **************
61
62 Gnorb provides glue code between the Gnus, Org, and BBDB packages. It’s
63 aimed at supporting email-based project management, and generally making
64 it easier to keep track of email communication.
65
66 Much of the code consists of single-use convenience functions, but
67 tracking email conversations with Org requires is more complicated, and
68 requires a bit of setup.
69
70 Gnorb can be used in a modular fashion, by selectively loading the
71 files “gnorb-org”, “gnorb-gnus” or “gnorb-bbdb” instead of plain old
72 “gnorb”. The package as a whole is rather Org-centric, though, and it
73 won’t do much of interest without “gnorb-org”.
74
75 This means that Gnorb doesn’t have hard requirements to any of the
76 three base libraries. For the libraries you are using, however, you’ll
77 get best results from using the most recent stable version (yes, that
78 means BBDB 3). Some of the features in Gnorb only work with development
79 versions of these libraries (those cases are noted below).
80
81 \1f
82 File: gnorb.info, Node: Installation, Next: Setup, Prev: Introduction, Up: Top
83
84 2 Installation
85 **************
86
87 Gnorb is best installed via the Elpa package manager – look for it in
88 ‘list-packages’.
89
90 You can also clone the source code from
91 <https://github.com/girzel/gnorb>, and put the “gnorb” directory on your
92 load-path. The Github site is also a good place to report bugs and
93 other issues.
94
95 \1f
96 File: gnorb.info, Node: Setup, Next: Email Tracking, Prev: Installation, Up: Top
97
98 3 Setup
99 *******
100
101 Loading “gnorb” will make the basic functions available. Using Gnorb
102 for email tracking takes a bit more setup, however:
103
104 1. Email tracking is done via the Gnus registry, so that must be
105 activated with ‘gnus-registry-initialize’.
106 2. It also requires the org-id package to be loaded, and
107 ‘org-id-track-globally’ set to t (that’s the default value, so
108 simply loading the package should be enough).
109 3. Add a nngnorb entry to your ‘gnus-secondary-select-methods’
110 variable. It will look like (nngnorb “Server name”). This does
111 nothing but provide a place to hang nnir searches.
112 4. Then put a call to ‘gnorb-tracking-initialize’ in your init files,
113 at some point after the Gnus registry is initialized.
114 5. If you’re not using a local archive method for saving your sent
115 messages (ie you’re using IMAP), you’ll also need to tell Gnorb
116 where to find your sent messages. Set the variable
117 ‘gnorb-gnus-sent-groups’ to a list of strings; each string should
118 indicate a fully-qualified group name, eg “nnimap+SERVER:GROUP”.
119
120 Lastly, Gnorb doesn’t bind any keys by default; see the *note
121 Suggested Keybindings: Suggested Keybindings. section below for
122 possibilities.
123
124 \1f
125 File: gnorb.info, Node: Email Tracking, Next: Restoring Window Layout, Prev: Setup, Up: Top
126
127 4 Email Tracking
128 ****************
129
130 The most interesting thing Gnorb does is using Org headings to track
131 email conversations. This can mean anything from reminding yourself to
132 write to your mother, to conducting delicate business negotiations over
133 email, to running an email-based bug tracker.
134
135 Gnorb assists in this process by using the Gnus registry to track
136 correspondences between emails and Org headings – specifically, message
137 IDs are associated with Org heading ids. As a conversation develops,
138 messages are collected on a heading (and/or its children). You can
139 compose new messages directly from the Org heading, and Gnorb will
140 automatically associate your sent message with the conversation. You
141 can open temporary Gnus *Summary* buffers holding all the messages
142 associated with an Org subtree, and reply from there. When you receive
143 new messages relevant to a conversation, Gnorb will notice them and
144 prompt you to associate them with the appropriate Org heading.
145 Attachments on incoming messages can be automatically saved as
146 attachments on Org headings, using org-attach.
147
148 In general, the goal is to keep track of whole conversations, reduce
149 friction when moving between Gnus and Org, and keep you in the Org
150 agenda rather than in Gnus.
151 * Menu:
152
153 * Email-Related Commands::
154 * Trigger Actions::
155 * Viewing Tracked Messages in *Summary* Buffers::
156 * Hinting in Gnus::
157 * Message Attachments::
158 * Likely Workflow::
159
160 \1f
161 File: gnorb.info, Node: Email-Related Commands, Next: Trigger Actions, Up: Email Tracking
162
163 4.1 Email-Related Commands
164 ==========================
165
166 Email tracking starts in one of three ways:
167
168 1. With an Org heading that represents an email TODO. Call
169 ‘gnorb-org-handle-mail’ (see below) on the heading to compose a new
170 message, and start the tracking process.
171 2. By calling org-capture on a received message. Any heading captured
172 from a message will automatically be associated with that message.
173 3. By calling ‘gnorb-gnus-outgoing-do-todo’ in a message composition
174 buffer – see below.
175
176 There are three main email-related commands:
177
178 1. ‘gnorb-org-handle-mail’ is called on an Org heading to compose a
179 new message. By default, this will begin a reply to the most
180 recent message in the conversation. If there are no associated
181 messages to reply to (or you call the function with a double prefix
182 arg), Gnorb will look for mailto: or bbdb: links in the heading,
183 and compose a new message to them.
184
185 The sent message will be associated with the Org heading, and
186 you’ll be brought back to the heading and asked to trigger an
187 action on it.
188
189 ‘gnorb-email-subtree’ is an alternative entry-point to
190 ‘gnorb-org-handle-mail’. It does the same thing as the latter, but
191 first exports the body of the subtree as either text or a file,
192 then inserts the text into the message body, or attaches the file
193 to the message, depending on what you’ve chosen.
194 2. ‘gnorb-gnus-incoming-do-todo’ is called on a message in a Gnus
195 *Summary* buffer. You’ll be prompted for an Org heading, taken to
196 that heading, and asked to trigger an action on it.
197 3. ‘gnorb-gnus-outgoing-do-todo’ is called in message mode, while
198 composing a new message.
199
200 If called without a prefix arg, a new Org heading will be created
201 after the message is sent, and the sent message associated with it.
202 The new heading will be created as a capture heading, using the
203 template specified by the ‘gnorb-gnus-new-todo-capture-key’ option.
204
205 If you call this function with a single prefix arg, you’ll be
206 prompted to choose an existing Org heading instead. After the the
207 message is sent, you’ll be taken to that heading and prompted to
208 trigger an action on it.
209
210 If you’ve called this function, and then realize you’ve associated
211 the message with the wrong TODO, call it again with a double prefix
212 to clear all associations.
213
214 It’s also possible to call this function *after* a message is sent,
215 in case you forgot. Gnorb saves information about the most
216 recently sent message for this purpose.
217
218 Because these three commands all express a similar intent, but are
219 called in different modes, it can make sense to give each of them the
220 same keybinding in the keymaps for Org mode, Gnus summary mode, and
221 Message mode, respectively.
222
223 \1f
224 File: gnorb.info, Node: Trigger Actions, Next: Viewing Tracked Messages in *Summary* Buffers, Prev: Email-Related Commands, Up: Email Tracking
225
226 4.2 Trigger Actions
227 ===================
228
229 After calling ‘gnorb-gnus-incoming-do-todo’ on a message, or after
230 sending a message associated with an Org heading, you’ll be taken to the
231 heading and asked to “trigger an action” on it. At the moment there are
232 four different possibilities: triggering a TODO state-change on the
233 heading, taking a note on the heading (both these options will associate
234 the message with the heading), associating the message but doing nothing
235 else, and lastly, doing nothing at all.
236
237 More actions will be added in the future; it’s also possible to
238 rearrange or delete existing actions, and add your own: see the
239 docstring of ‘gnorb-org-trigger-actions’.
240
241 \1f
242 File: gnorb.info, Node: Viewing Tracked Messages in *Summary* Buffers, Next: Hinting in Gnus, Prev: Trigger Actions, Up: Email Tracking
243
244 4.3 Viewing Tracked Messages in *Summary* Buffers
245 =================================================
246
247 Call ‘gnorb-org-view’ on an Org heading to open an nnir *Summary* buffer
248 showing all the messages associated with that heading (this requires
249 that you’ve added an nngnorb server to your Gnus backends). A minor
250 mode will be in effect, ensuring that any replies you send to messages
251 in this buffer will automatically be associated with the original Org
252 heading. You can also invoke ‘gnorb-summary-disassociate-message’ (“C-c
253 d”) to disassociate the message with the Org heading.
254
255 As a bonus, it’s possible to go into Gnus’ *Server* buffer, find the
256 line specifying your nngnorb server, and hit “G” (aka
257 ‘gnus-group-make-nnir-group’). At the query prompt, enter an Org-style
258 tags-todo Agenda query string (eg “+work-computer”, or what have you).
259 Gnorb will find all headings matching this query, scan their subtrees
260 for gnus links, and then give you a Summary buffer containing all the
261 linked messages. This is dog-slow at the moment; it will get faster.
262
263 \1f
264 File: gnorb.info, Node: Hinting in Gnus, Next: Message Attachments, Prev: Viewing Tracked Messages in *Summary* Buffers, Up: Email Tracking
265
266 4.4 Hinting in Gnus
267 ===================
268
269 When you receive new mails that might be relevant to existing Org TODOs,
270 Gnorb can alert you to that fact. When
271 ‘gnorb-gnus-hint-relevant-article’ is t (the default), Gnorb will
272 display a message in the minibuffer when opening potentially relevant
273 messages. You can then use ‘gnorb-gnus-incoming-to-todo’ to trigger an
274 action on the relevant TODO.
275
276 This hinting can happen in the Gnus summary buffer as well. If you
277 use the escape indicated by ‘gnorb-gnus-summary-mark-format-letter” as
278 part of your ‘gnus-summary-line-format’, articles that are relevant to
279 TODOs will be marked with a special character in the Summary buffer, as
280 determined by ‘gnorb-gnus-summary-mark’. By default, the format letter
281 is “g” (meaning it is used as “%ug” in the format line), and the mark is
282 “¡”.
283
284 \1f
285 File: gnorb.info, Node: Message Attachments, Next: Likely Workflow, Prev: Hinting in Gnus, Up: Email Tracking
286
287 4.5 Message Attachments
288 =======================
289
290 Gnorb simplifies the handling of attachments that you receive in emails.
291 When you call ‘gnorb-gnus-incoming-do-todo’ on a message, you’ll be
292 prompted to re-attach the email’s attachments onto the Org heading,
293 using the org-attach library.
294
295 You can also do this as part of the capture process. Set the new
296 :gnus-attachments key to “t” in a capture template that you use on mail
297 messages, and you’ll be queried to re-attach the message’s attachments
298 onto the newly-captured heading. Or set
299 ‘gnorb-gnus-capture-always-attach’ to “t” to have Gnorb do this for all
300 capture templates.
301
302 You can also do this using the regular system of MIME commands,
303 without invoking the email tracking process. See *note Suggested
304 Keybindings: Suggested Keybindings, below.
305
306 The same process works in reverse: when you send a message from an
307 Org heading using ‘gnorb-org-handle-mail’, Gnorb will ask if you want to
308 attach the files in the heading’s org-attach directory to the outgoing
309 message.
310
311 \1f
312 File: gnorb.info, Node: Likely Workflow, Prev: Message Attachments, Up: Email Tracking
313
314 4.6 Likely Workflow
315 ===================
316
317 You receive an email from Jimmy, who wants to rent a room in your house.
318 “I’ll respond to this later,” you think.
319
320 You capture an Org TODO from the email, call it “Jimmy renting a
321 room”, and give it a REPLY keyword. Gnorb quietly records the
322 correspondence between the email and the TODO, using the Gnus registry.
323
324 The next day, looking at your Agenda, you see the TODO and decide to
325 respond to the email. You call ‘gnorb-org-handle-mail’ on the heading,
326 and Gnorb opens Jimmy’s email and starts a reply to it.
327
328 You tell Jimmy the room’s available in March, and send the message.
329 Gnorb takes you back to the heading, and asks you to trigger an action
330 on it. You choose “todo state”, and change the heading keyword to WAIT.
331
332 Two days later, Jimmy replies to your message, saying that March is
333 perfect. When you open his response, Gnorb politely reminds you that
334 the message is relevant to an existing TODO. You call
335 ‘gnorb-gnus-incoming-do-todo’ on the message, and are again taken to the
336 TODO and asked to trigger an action. Again you choose “todo state”, and
337 change the heading keyword back to REPLY.
338
339 You get another email, from Samantha, warning you not to rent the
340 room to Jimmy. She even attaches a picture of a room in her house, as
341 it looked after Jimmy had stayed there for six months. It’s bad. You
342 call ‘gnorb-gnus-incoming-do-todo’ on her message, and pick the “Jimmy
343 renting a room” heading. This time, you choose “take note” as the
344 trigger action, and make a brief note about how bad that room looked.
345 Gnorb asks if you’d like to attach the picture to the Org heading. You
346 decide you will.
347
348 Now it’s time to write to Jimmy and say something noncommittal.
349 Calling ‘gnorb-org-handle-mail’ on the heading would respond to
350 Samantha’s email, the most recent of the associated messages, which
351 isn’t what you want. Instead you call ‘gnorb-org-view’ on the heading,
352 which opens up a Gnus *Summary* buffer containing all four messages:
353 Jimmy’s first, your response, his response to that, and Samantha’s
354 message. You pick Jimmy’s second email, and reply to it normally.
355 Gnorb asks if you’d like to send the picture of the room as an
356 attachment. You would not. When you send the reply Gnorb tracks that
357 as well, and does the “trigger an action” trick again.
358
359 In this way Gnorb helps you manage an entire conversation, possibly
360 with multiple threads and multiple participants. Mostly all you need to
361 do is call ‘gnorb-gnus-incoming-do-todo’ on newly-received messages, and
362 ‘gnorb-org-handle-mail’ on the heading when it’s time to compose a new
363 reply.
364
365 \1f
366 File: gnorb.info, Node: Restoring Window Layout, Next: Recent Mails From BBDB Contacts, Prev: Email Tracking, Up: Top
367
368 5 Restoring Window Layout
369 *************************
370
371 Many Gnorb functions alter the window layout and value of point. In
372 most of these cases, you can restore the previous layout using the
373 interactive function ‘gnorb-restore-layout’.
374
375 \1f
376 File: gnorb.info, Node: Recent Mails From BBDB Contacts, Next: BBDB posting styles, Prev: Restoring Window Layout, Up: Top
377
378 6 Recent Mails From BBDB Contacts
379 *********************************
380
381 If you’re using a recent git version of BBDB (circa mid-May 2014 or
382 later), you can give your BBDB contacts a special field which will
383 collect links to recent emails from that contact. The default name of
384 the field is “messages”, but you can customize that name using the
385 ‘gnorb-bbdb-messages-field’ option.
386
387 Gnorb will not collect links by default: you need to call
388 ‘gnorb-bbdb-open-link’ on a contact once to start the process.
389 Thereafter, opening mails from that contact will store a link to the
390 message.
391
392 Once some links are stored, ‘gnorb-bbdb-open-link’ will open them:
393 Use a prefix arg to the function call to select particular messages to
394 open. There are several options controlling how all this works; see the
395 gnorb-bbdb user options section below for details.
396
397 \1f
398 File: gnorb.info, Node: BBDB posting styles, Next: BBDB Org tagging, Prev: Recent Mails From BBDB Contacts, Up: Top
399
400 7 BBDB posting styles
401 *********************
402
403 Gnorb comes with a BBDB posting-style system, inspired by (copied from)
404 gnus-posting-styles. You can specify how messages are composed to
405 specific contacts, by matching on contact field values (the same way
406 gnus-posting-styles matches on group names). See the docstring of
407 ‘gnorb-bbdb-posting-styles’ for details.
408
409 In order not to be too intrusive, Gnorb doesn’t alter the behavior of
410 ‘bbdb-mail’, the usual mail-composition function. Instead it provides
411 an alternate ‘gnorb-bbdb-mail’, which does exactly the same thing, but
412 first processes the new mail according to ‘gnorb-bbdb-posting-styles’.
413 If you want to use this feature regularly, you can remap ‘bbdb-mail’ to
414 ‘gnorb-bbdb-mail’ in the ‘bbdb-mode-map’.
415
416 \1f
417 File: gnorb.info, Node: BBDB Org tagging, Next: Misc BBDB, Prev: BBDB posting styles, Up: Top
418
419 8 BBDB Org tagging
420 ******************
421
422 BBDB contacts can be tagged with the same tags you use in your Org
423 files. This allows you to pop up a *BBDB* buffer alongside your Org
424 Agenda when searching for certain tags. This can happen automatically
425 for all Org tags-todo searches, if you set the option
426 ‘gnorb-org-agenda-popup-bbdb’ to t. Or you can do it manually, by
427 calling the command of the same name. This command only shows TODOs by
428 default: use a prefix argument to show all tagged headings.
429
430 Tags are stored in an xfield named org-tags, by default. You can
431 customize the name of this field using ‘gnorb-bbdb-org-tag-field’.
432
433 \1f
434 File: gnorb.info, Node: Misc BBDB, Next: Misc Org, Prev: BBDB Org tagging, Up: Top
435
436 9 Misc BBDB
437 ***********
438
439 * Menu:
440
441 * Searching for messages from BBDB contacts::
442 * Citing BBDB contacts::
443 * User Options::
444
445 \1f
446 File: gnorb.info, Node: Searching for messages from BBDB contacts, Next: Citing BBDB contacts, Up: Misc BBDB
447
448 9.1 Searching for messages from BBDB contacts
449 =============================================
450
451 Call ‘gnorb-bbdb-mail-search’ to search for all mail messages from the
452 record(s) displayed. Currently supports the notmuch, mairix, and namazu
453 search backends; set ‘gnorb-gnus-mail-search-backend’ to one of those
454 symbol values.
455
456 \1f
457 File: gnorb.info, Node: Citing BBDB contacts, Next: User Options, Prev: Searching for messages from BBDB contacts, Up: Misc BBDB
458
459 9.2 Citing BBDB contacts
460 ========================
461
462 Calling ‘gnorb-bbdb-cite-contact’ will prompt for a BBDB record and
463 insert a string of the type “Bob Smith <bob@smith.com>”.
464
465 \1f
466 File: gnorb.info, Node: User Options, Prev: Citing BBDB contacts, Up: Misc BBDB
467
468 9.3 User Options
469 ================
470
471 ‘`gnorb-bbdb-org-tag-field’
472 The name of the BBDB xfield, as a symbol, that holds Org-related
473 tags. Specified as a string with the “:” separator between tags,
474 same as for Org headings. Defaults to org-tag.
475 ‘`gnorb-bbdb-messages-field'’
476 The name of the BBDB xfield that holds links to recently-received
477 messages from this contact. Defaults to ‘messages.
478 ‘`gnorb-bbdb-collect-N-messages'’
479 Collect at most this many links to messages from this contact.
480 Defaults to 5.
481 ‘`gnorb-bbdb-define-recent'’
482 What does “recently-received” mean? Possible values are the
483 symbols seen and received. When set to seen, the most
484 recently-opened messages are collected. When set to received, the
485 most recently-received (by Date header) messages are collected.
486 Defaults to seen.
487 ‘`gnorb-bbdb-message-link-format-multi'’
488 How is a single message’s link formatted in the multi-line BBDB
489 layout format? Defaults to “%:count. %D: %:subject” (see the
490 docstring for details).
491 ‘` gnorb-bbdb-message-link-format-one'’
492 How is a single message’s link formatted in the one-line BBDB
493 layout format? Defaults to nil (see the docstring for details).
494 ‘`gnorb-bbdb-posting-styles'’
495 Styles to use for influencing the format of mails composed to the
496 BBDB record(s) under point (see the docstring for details).
497
498 \1f
499 File: gnorb.info, Node: Misc Org, Next: Misc Gnus, Prev: Misc BBDB, Up: Top
500
501 10 Misc Org
502 ***********
503
504 * Menu:
505
506 * Inserting BBDB links::
507 * User Options: User Optionsx.
508
509 \1f
510 File: gnorb.info, Node: Inserting BBDB links, Next: User Optionsx, Up: Misc Org
511
512 10.1 Inserting BBDB links
513 =========================
514
515 Calling ‘gnorb-org-contact-link’ will prompt for a BBDB record and
516 insert an Org link to that record at point.
517
518 \1f
519 File: gnorb.info, Node: User Optionsx, Prev: Inserting BBDB links, Up: Misc Org
520
521 10.2 User Options
522 =================
523
524 ‘`gnorb-org-after-message-setup-hook'’
525 Hook run in a message buffer after setting up the message, from
526 ‘gnorb-org-handle-mail’ or ‘gnorb-org-email-subtree’.
527 ‘`gnorb-org-trigger-actions'’
528 List of potential actions that can be taken on headings after a
529 message is sent. See docstring for details.
530 ‘`gnorb-org-mail-scan-scope'’
531 The number of paragraphs to scan for mail-related links. This
532 comes into play when calling ‘gnorb-org-handle-mail’ on a heading
533 with no associated messages, or when ‘gnorb-org-handle-mail’ is
534 called with a prefix arg.
535 ‘`gnorb-org-find-candidates-match'’
536 When searching all Org files for headings to collect messages from,
537 this option can limit which headings are searched. It is used as
538 the second argument to a call to ‘org-map-entries’, and has the
539 same syntax as that used in an agenda tags view.
540 ‘`gnorb-org-email-subtree-text-parameters'’
541 A plist of export parameters corresponding to the EXT-PLIST
542 argument to the export functions, for use when exporting to text.
543 ‘`gnorb-org-email-subtree-file-parameters'’
544 A plist of export parameters corresponding to the EXT-PLIST
545 argument to the export functions, for use when exporting to a file.
546 ‘`gnorb-org-email-subtree-text-options'’
547 A list of ts and nils corresponding to Org’s export options, to be
548 used when exporting to text. The options, in order, are async,
549 subtreep, visible-only, and body-only.
550 ‘`gnorb-org-email-subtree-file-options'’
551 A list of ts and nils corresponding to Org’s export options, to be
552 used when exporting to a file. The options, in order, are async,
553 subtreep, visible-only, and body-only.
554 ‘`gnorb-org-export-extensions'’
555 Correspondence between export backends and their respective (usual)
556 file extensions.
557 ‘`gnorb-org-capture-collect-link-p'’
558 When this is set to t, the capture process will always store a link
559 to the Gnus message or BBDB record under point, even when the link
560 isn’t part of the capture template. It can then be added to the
561 captured heading with org-insert-link, as usual.
562 ‘`gnorb-org-agenda-popup-bbdb'’
563 Set to “t” to automatically pop up the BBDB buffer displaying
564 records corresponding to the Org Agenda tags search underway. If
565 this is nil you can always do it manually with the command of the
566 same name.
567 ‘`gnorb-org-bbdb-popup-layout'’
568 Controls the layout of the Agenda-related BBDB popup, takes the
569 same values as bbdb-pop-up-layout.
570
571 \1f
572 File: gnorb.info, Node: Misc Gnus, Next: Suggested Keybindings, Prev: Misc Org, Up: Top
573
574 11 Misc Gnus
575 ************
576
577 * Menu:
578
579 * Viewing Org headlines relevant to a message::
580 * User Options: User Optionsxx.
581
582 \1f
583 File: gnorb.info, Node: Viewing Org headlines relevant to a message, Next: User Optionsxx, Up: Misc Gnus
584
585 11.1 Viewing Org headlines relevant to a message
586 ================================================
587
588 Call ‘gnorb-gnus-view’ on a message that is associated with an Org
589 heading to jump to that heading.
590
591 \1f
592 File: gnorb.info, Node: User Optionsxx, Prev: Viewing Org headlines relevant to a message, Up: Misc Gnus
593
594 11.2 User Options
595 =================
596
597 ‘`gnorb-gnus-mail-search-backend'’
598 Specifies the search backend that you use for searching mails.
599 Currently supports notmuch, mairix, and namazu: set this option to
600 one of those symbols.
601 ‘`gnorb-gnus-capture-always-attach'’
602 Treat all capture templates as if they had the :gnus-attachments
603 key set to “t”. This only has any effect if you’re capturing from
604 a Gnus summary or article buffer.
605 ‘`gnorb-trigger-todo-default'’
606 Set to either ‘note or ‘todo to tell ‘gnorb-gnus-incoming-do-todo’
607 what to do by default. You can reach the non-default behavior by
608 calling that function with a prefix argument. Alternately, set to
609 ‘prompt to always prompt for the appropriate action.
610 ‘`gnorb-gnus-trigger-refile-targets'’
611 If you use ‘gnorb-gnus-incoming-do-todo’ on an incoming message,
612 Gnorb will try to locate a TODO heading that’s relevant to that
613 message. If it can’t, it will prompt you for one, using the refile
614 interface. This option will be used as the value of
615 ‘org-refile-targets’ during that process: see the docstring of
616 ‘org-refile-targets’ for the appropriate syntax.
617 ‘`gnorb-gnus-new-todo-capture-key'’
618 Set this to a single-character string pointing at an Org capture
619 template to use when creating TODOs from outgoing messages. The
620 template is a regular capture template, with a few exceptions. If
621 Gnus helps you archive outgoing messages (ie you have
622 ‘gnus-message-archive-group’ set to something, and your outgoing
623 messages have a “Fcc” header), a link to that message will be made,
624 and you’ll be able to use all the escapes related to gnus messages.
625 If you don’t archive outgoing messages, you’ll still be able to use
626 the %:subject, %:to, %:toname, %:toaddress, and %:date escapes in
627 the capture template.
628 ‘`gnorb-gnus-hint-relevant-article'’
629 Set to “t” (the default) to have Gnorb give you a hint in the
630 minibuffer when opening messages that might be relevant to existing
631 Org TODOs.
632 ‘`gnorb-gnus-summary-mark-format-letter'’
633 The formatting letter to use as part of your
634 ‘gnus-summary-line-format’, to indicate messages which might be
635 relevant to Org TODOs. Defaults to “g”, meaning it should be used
636 as “%ug” in the format line.
637 ‘`gnorb-gnus-summary-mark'’
638 The mark used to indicate relevant messages in the Summary buffer,
639 when ‘gnorb-gnus-summary-mark-format-letter’ is present in the
640 format line. Defaults to “¡”.
641
642 \1f
643 File: gnorb.info, Node: Suggested Keybindings, Prev: Misc Gnus, Up: Top
644
645 12 Suggested Keybindings
646 ************************
647
648 (eval-after-load "gnorb-bbdb"
649 '(progn
650 (define-key bbdb-mode-map (kbd "O") 'gnorb-bbdb-tag-agenda)
651 (define-key bbdb-mode-map (kbd "S") 'gnorb-bbdb-mail-search)
652 (define-key bbdb-mode-map [remap bbdb-mail] 'gnorb-bbdb-mail)
653 (define-key bbdb-mode-map (kbd "l") 'gnorb-bbdb-open-link)
654 (global-set-key (kbd "C-c C") 'gnorb-bbdb-cite-contact)))
655
656 (eval-after-load "gnorb-org"
657 '(progn
658 (org-defkey org-mode-map (kbd "C-c C") 'gnorb-org-contact-link)
659 (org-defkey org-mode-map (kbd "C-c t") 'gnorb-org-handle-mail)
660 (org-defkey org-mode-map (kbd "C-c e") 'gnorb-org-view)
661 (org-defkey org-mode-map (kbd "C-c E") 'gnorb-org-email-subtree)
662 (org-defkey org-mode-map (kbd "C-c V") 'gnorb-org-popup-bbdb)
663 (setq gnorb-org-agenda-popup-bbdb t)
664 (eval-after-load "org-agenda"
665 '(progn (org-defkey org-agenda-mode-map (kbd "H") 'gnorb-org-handle-mail)
666 (org-defkey org-agenda-mode-map (kbd "V") 'gnorb-org-popup-bbdb)))))
667
668 (eval-after-load "gnorb-gnus"
669 '(progn
670 (define-key gnus-summary-mime-map "a" 'gnorb-gnus-article-org-attach)
671 (define-key gnus-summary-mode-map (kbd "C-c t") 'gnorb-gnus-incoming-do-todo)
672 (push '("attach to org heading" . gnorb-gnus-mime-org-attach)
673 gnus-mime-action-alist)
674 ;; The only way to add mime button command keys is by redefining
675 ;; gnus-mime-button-map, possibly not ideal. Ideal would be a
676 ;; setter function in gnus itself.
677 (push '(gnorb-gnus-mime-org-attach "a" "Attach to Org heading")
678 gnus-mime-button-commands)
679 (setq gnus-mime-button-map
680 (let ((map (make-sparse-keymap)))
681 (define-key map gnus-mouse-2 'gnus-article-push-button)
682 (define-key map gnus-down-mouse-3 'gnus-mime-button-menu)
683 (dolist (c gnus-mime-button-commands)
684 (define-key map (cadr c) (car c)))
685 map))))
686
687 (eval-after-load "message"
688 '(progn
689 (define-key message-mode-map (kbd "C-c t") 'gnorb-gnus-outgoing-do-todo)))
690
691
692 \1f
693 Tag Table:
694 Node: Top\7f194
695 Node: Introduction\7f1009
696 Node: Installation\7f2118
697 Node: Setup\7f2532
698 Node: Email Tracking\7f3899
699 Node: Email-Related Commands\7f5430
700 Node: Trigger Actions\7f8440
701 Node: Viewing Tracked Messages in *Summary* Buffers\7f9289
702 Node: Hinting in Gnus\7f10523
703 Node: Message Attachments\7f11531
704 Node: Likely Workflow\7f12713
705 Node: Restoring Window Layout\7f15518
706 Node: Recent Mails From BBDB Contacts\7f15882
707 Node: BBDB posting styles\7f16878
708 Node: BBDB Org tagging\7f17794
709 Node: Misc BBDB\7f18540
710 Node: Searching for messages from BBDB contacts\7f18753
711 Node: Citing BBDB contacts\7f19199
712 Node: User Options\7f19520
713 Node: Misc Org\7f21059
714 Node: Inserting BBDB links\7f21234
715 Node: User Optionsx\7f21489
716 Node: Misc Gnus\7f24226
717 Node: Viewing Org headlines relevant to a message\7f24439
718 Node: User Optionsxx\7f24754
719 Node: Suggested Keybindings\7f27518
720 \1f
721 End Tag Table
722
723 \1f
724 Local Variables:
725 coding: utf-8
726 End: