MELI.CONF.EXAMPLES(5)

NAME
meli.conf examples - Example configurations for various mail backends supported by the meli(1) terminal e-mail client

MAILDIR ACCOUNT
An example configuration:

    [accounts.account-name]
    root_mailbox = "/path/to/root/folder"
    format = "Maildir"
    listing.index_style = "Compact"
    identity="email@example.com"
    display_name = "Name"
    send_mail = 'msmtp --read-recipients --read-envelope-from'
    #send_mail = { hostname = "smtp.example.com", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
    # Set mailbox-specific settings
      [accounts.account-name.mailboxes]
      "INBOX" = { alias="Inbox" } #inline table
      "drafts" = { alias="Drafts" } #inline table
      [accounts.account-name.mailboxes."foobar-devel"] # or a regular table
        ignore = true # don't show notifications for this mailbox

MBOX ACCOUNT
An example configuration:

    [accounts.account-name]
    root_mailbox = "/var/mail/username"
    format = "mbox"
    listing.index_style = "Compact"
    identity="username@hostname.local"
    composing.send_mail = '/bin/false'

IMAP ACCOUNT

    [accounts."account-name"]
    root_mailbox = "INBOX"
    format = "imap"
    server_hostname="mail.example.com"
    server_password="pha2hiLohs2eeeish2phaii1We3ood4chakaiv0hien2ahie3m"
    server_username="username@example.com"
    #server_port="993" # imaps
    server_port="143" # STARTTLS
    use_starttls=true #optional
    send_mail = { hostname = "smtp.example.com", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
    display_name = "Name Name"
    identity = "username@example.com"
    ## show only specific mailboxes:
    #subscribed_mailboxes = ["INBOX", "INBOX/Sent", "INBOX/Drafts", "INBOX/Junk"]

  Gmail account example

    [accounts."account-name"]
    root_mailbox = '[Gmail]'
    format = "imap"
    send_mail = { hostname = "smtp.gmail.com", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
    server_hostname='imap.gmail.com'
    server_password="password"
    server_username="username@gmail.com"
    server_port="993"
    listing.index_style = "Conversations"
    identity = "username@gmail.com"
    display_name = "Name Name"
    # Gmail auto saves sent mail to Sent folder, so don't duplicate the effort:
    composing.store_sent_mail = false

JMAP ACCOUNT
The server_url option must hold the address of the server's session endpoint.

    [accounts."account-name"]
    root_mailbox = "INBOX"
    format = "jmap"
    send_mail = 'server_submission'
    server_url="http://localhost:8080"
    server_username="user@hostname.local"
    server_password="changeme"
    identity = "user@hostname.local"

  fastmail.com account example
Fastmail: https://fastmail.com/ uses the Bearer token authentication mechanism, so the option use_token must be enabled:

    [accounts."fastmail-jmap"]
    root_mailbox = "INBOX"
    format = "jmap"
    server_url="https://api.fastmail.com/jmap/session"
    server_username="user@fastmail.com"
    server_password="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    use_token=true
    identity = "My Name <user@fastmail.com>"
    send_mail = "server_submission"

NOTMUCH ACCOUNT
TODO

NNTP / USENET ACCOUNT
TODO

SEE ALSO
meli.conf(5), meli(1), meli-themes(5)

AUTHORS
Copyright 2017–2024 Manos Pitsidianakis <manos@pitsidianak.is>

Released under the GPL, version 3 or greater. This software carries no warranty of any kind. ( See COPYING for full copyright and warranty notices.)

  Links
Website: https://meli-email.org
Main git repository and issue tracker: https://git.meli-email.org/meli/meli
Official read-only git mirror on codeberg.org: https://codeberg.org/meli/meli
Official read-only git mirror on github.com: https://github.com/meli/meli
meli crate on crates.io: https://crates.io/crates/meli