my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	# Himalaya Configuration Reference
#2
#3	Configuration file location: `~/.config/himalaya/config.toml`
#4
#5	## Minimal IMAP + SMTP Setup
#6
#7	```toml
#8	[accounts.default]
#9	email = "user@example.com"
#10	display-name = "Your Name"
#11	default = true
#12
#13	# IMAP backend for reading emails
#14	backend.type = "imap"
#15	backend.host = "imap.example.com"
#16	backend.port = 993
#17	backend.encryption.type = "tls"
#18	backend.login = "user@example.com"
#19	backend.auth.type = "password"
#20	backend.auth.raw = "your-password"
#21
#22	# SMTP backend for sending emails
#23	message.send.backend.type = "smtp"
#24	message.send.backend.host = "smtp.example.com"
#25	message.send.backend.port = 587
#26	message.send.backend.encryption.type = "start-tls"
#27	message.send.backend.login = "user@example.com"
#28	message.send.backend.auth.type = "password"
#29	message.send.backend.auth.raw = "your-password"
#30	```
#31
#32	## Password Options
#33
#34	### Raw password (testing only, not recommended)
#35	```toml
#36	backend.auth.raw = "your-password"
#37	```
#38
#39	### Password from command (recommended)
#40	```toml
#41	backend.auth.cmd = "pass show email/imap"
#42	# backend.auth.cmd = "security find-generic-password -a user@example.com -s imap -w"
#43	```
#44
#45	### System keyring (requires keyring feature)
#46	```toml
#47	backend.auth.keyring = "imap-example"
#48	```
#49	Then run `himalaya account configure <account>` to store the password.
#50
#51	## Gmail Configuration
#52
#53	```toml
#54	[accounts.gmail]
#55	email = "you@gmail.com"
#56	display-name = "Your Name"
#57	default = true
#58
#59	backend.type = "imap"
#60	backend.host = "imap.gmail.com"
#61	backend.port = 993
#62	backend.encryption.type = "tls"
#63	backend.login = "you@gmail.com"
#64	backend.auth.type = "password"
#65	backend.auth.cmd = "pass show google/app-password"
#66
#67	message.send.backend.type = "smtp"
#68	message.send.backend.host = "smtp.gmail.com"
#69	message.send.backend.port = 587
#70	message.send.backend.encryption.type = "start-tls"
#71	message.send.backend.login = "you@gmail.com"
#72	message.send.backend.auth.type = "password"
#73	message.send.backend.auth.cmd = "pass show google/app-password"
#74	```
#75
#76	Note: Gmail requires an App Password if 2FA is enabled.
#77
#78	## iCloud Configuration
#79
#80	```toml
#81	[accounts.icloud]
#82	email = "you@icloud.com"
#83	display-name = "Your Name"
#84
#85	backend.type = "imap"
#86	backend.host = "imap.mail.me.com"
#87	backend.port = 993
#88	backend.encryption.type = "tls"
#89	backend.login = "you@icloud.com"
#90	backend.auth.type = "password"
#91	backend.auth.cmd = "pass show icloud/app-password"
#92
#93	message.send.backend.type = "smtp"
#94	message.send.backend.host = "smtp.mail.me.com"
#95	message.send.backend.port = 587
#96	message.send.backend.encryption.type = "start-tls"
#97	message.send.backend.login = "you@icloud.com"
#98	message.send.backend.auth.type = "password"
#99	message.send.backend.auth.cmd = "pass show icloud/app-password"
#100	```
#101
#102	Note: Generate an app-specific password at appleid.apple.com
#103
#104	## Folder Aliases
#105
#106	Map custom folder names:
#107	```toml
#108	[accounts.default.folder.alias]
#109	inbox = "INBOX"
#110	sent = "Sent"
#111	drafts = "Drafts"
#112	trash = "Trash"
#113	```
#114
#115	## Multiple Accounts
#116
#117	```toml
#118	[accounts.personal]
#119	email = "personal@example.com"
#120	default = true
#121	# ... backend config ...
#122
#123	[accounts.work]
#124	email = "work@company.com"
#125	# ... backend config ...
#126	```
#127
#128	Switch accounts with `--account`:
#129	```bash
#130	himalaya --account work envelope list
#131	```
#132
#133	## Notmuch Backend (local mail)
#134
#135	```toml
#136	[accounts.local]
#137	email = "user@example.com"
#138
#139	backend.type = "notmuch"
#140	backend.db-path = "~/.mail/.notmuch"
#141	```
#142
#143	## OAuth2 Authentication (for providers that support it)
#144
#145	```toml
#146	backend.auth.type = "oauth2"
#147	backend.auth.client-id = "your-client-id"
#148	backend.auth.client-secret.cmd = "pass show oauth/client-secret"
#149	backend.auth.access-token.cmd = "pass show oauth/access-token"
#150	backend.auth.refresh-token.cmd = "pass show oauth/refresh-token"
#151	backend.auth.auth-url = "https://provider.com/oauth/authorize"
#152	backend.auth.token-url = "https://provider.com/oauth/token"
#153	```
#154
#155	## Additional Options
#156
#157	### Signature
#158	```toml
#159	[accounts.default]
#160	signature = "Best regards,\nYour Name"
#161	signature-delim = "-- \n"
#162	```
#163
#164	### Downloads directory
#165	```toml
#166	[accounts.default]
#167	downloads-dir = "~/Downloads/himalaya"
#168	```
#169
#170	### Editor for composing
#171	Set via environment variable:
#172	```bash
#173	export EDITOR="vim"
#174	```
#175

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public