NAME

notemap, git-notemap — mirror notes to IMAP

SYNOPSIS

notemap [-afvw] [-M mailbox] [-h host] [-m file] [-p port] user [file ...]

git notemap [-afv] [-M mailbox] [-h host] [-m file] [-p port] [-u user] [file ...]

DESCRIPTION

The notemap utility mirrors text notes to an IMAP mailbox appropriate for display by the Apple Notes application. Files are mapped to IMAP messages using a map file, by default .notemap in the current directory. If no files are specified, all mapped files are mirrored. New files are added to the map file using -a.

IMAP over TLS is assumed. The IMAP host and port are automatically discovered through SRV record lookup on the domain portion of user. The password is read from /dev/tty, or standard input if -w is used.

The git-notemap wrapper uses git-config(1) and gitcredentials(7) for defaults and authentication.

The arguments are as follows:

-M mailbox: Mirror notes to mailbox. The default is Notes.
-a: Add new notes to the map file.
-f: Overwrite modified notes in the mailbox.
-h host: Connect to IMAP on host.
-m file: Set the path of the map file. The default is .notemap.
-p port: Connect to IMAP on port.
-v: Log IMAP protocol to standard error.
-w: Read the password from standard input.

The git-notemap wrapper loads defaults from the following git-config(1) options: notemap.imapServer, notemap.imapServerPort, notemap.imapUser, notemap.imapPass, notemap.imapMailbox, notemap.mapFile. If notemap.imapPass is unset, the password is obtained through gitcredentials(7).

EXAMPLES

notemap -a june@causal.agency note.txt
git config notemap.imapUser june@causal.agency
git notemap note.txt

STANDARDS

N. Borenstein and N. Freed, MIME Part One: Format of Internet Message Bodies, IETF, RFC 2045, https://tools.ietf.org/html/rfc2045, November 1996.
M. Crispin, INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1, IETF, RFC 3501, https://tools.ietf.org/html/rfc3501, University of Washington, March 2003.
L. Esibov, A. Gulbrandsen, and P. Vixie, A DNS RR for specifying the location of services (DNS SRV), IETF, RFC 2782, https://tools.ietf.org/html/rfc2782, February 2000.
P. Leach, M. Mealling, and R. Salz, A Universally Unique IDentifier (UUID) URN Namespace, IETF, RFC 4122, https://tools.ietf.org/html/rfc4122, July 2005.
P. Mockapetris, DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION, IETF, RFC 1035, https://tools.ietf.org/html/rfc1035, November 1987.
P. Resnick, Ed., Internet Message Format, IETF, RFC 5322, https://tools.ietf.org/html/rfc5322, October 2008.

AUTHORS

June McEnroe <june@causal.agency>

CAVEATS

Notes are assumed to be plain UTF-8 text with LF line endings.

BUGS

Send mail to <list+notemap@causal.agency> or join #ascii.town on irc.tilde.chat.

December 16, 2020

OpenBSD 7.4