mjmap

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 9, 2025 License: MPL-2.0 Imports: 21 Imported by: 0

README

mjmap

a sendmail-compatible JMAP client.

mjmap uses the JMAP EmailSubmission resource to send email. Emails are uploaded to the JMAP server over https. Initially they are put in your drafts folder with the '$draft' flag. On a successful send, the emails are moved to your sent folder and the '$draft' flag is removed.

Installation

System requirements:

  • git (to clone the repository)
  • GNU make
  • go >= 1.20
  • scdoc (to compile the man page)
git clone https://git.sr.ht/~rockorager/mjmap
gmake -C mjmap PREFIX=~/.local

Configuration

mjmap will look for a configuration file at: $XDG_CONFIG_HOME/mjmap/config.scfg

The configuration file is very short:

account "myaccount" {
	session-url "https://api.fastmail.com/jmap/session"
	token "my_token"
	username "me@example.com"
}

Usage

mjmap is sendmail compatible and can be used as a drop-in replacement for it, or msmtp.

Usage: mjmap [-h] [--version] [--mailbox <name>] [-S] [-d] [-t] [-f <from>] [-i] [-X <file>] [<recipients>...]

mjmap is a sendmail-compatible JMAP client.

Positional arguments:

 <recipients>...         Email addresses of recipients to send the message to.

Options:

  -h, --help             Show this help message and exit.
  --version              Print version information.
  --mailbox=<name>       Additional mailbox to add the message to, in addition
                         to Sent. Can be specified multiple times.
  -S, --server-info      Print information about the JMAP server and exit.
  -d, --debug            Print lots of debugging information.
  -t, --read-recipients  Read recipient addresses from the To, Cc, and Bcc
                         headers of the mail in addition of the ones specified
                         on the command line.
  -f, --from=<from>      Set the envelope-from address if it is missing from
                         the email headers.
  -i, --ignore-dots      Compatibility with sendmail, ignored option.
  -X, --logfile=<file>   Compatibility with sendmail, ignored option.

For example, to use for git-send-email:

[sendemail]
    sendmailcmd=mjmap

Contributing

Patches or feature requests can be sent to ~rockorager/mjmap-dev@lists.sr.ht

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL