Skip to content
This repository has been archived by the owner on Apr 13, 2023. It is now read-only.
/ flux-mail-rest-api Public archive

Mail Rest Api for fetch or send mails

Notifications You must be signed in to change notification settings

fluxfw/flux-mail-rest-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flux-mail-rest-api

Mail Rest Api for fetch or send mails

Environment variables

Variable Description Default value
FLUX_MAIL_REST_API_MAIL_HOST Mail server host name -
FLUX_MAIL_REST_API_MAIL_PORT Mail server port -
FLUX_MAIL_REST_API_MAIL_TYPE Mail server type
imap, pop3 or nntp
-
FLUX_MAIL_REST_API_MAIL_USER_NAME Mail user name
Use FLUX_MAIL_REST_API_MAIL_USER_NAME_FILE for docker secrets
-
FLUX_MAIL_REST_API_MAIL_PASSWORD Mail password
Use FLUX_MAIL_REST_API_MAIL_PASSWORD_FILE for docker secrets
-
FLUX_MAIL_REST_API_MAIL_ENCRYPTION_TYPE Type to encrypt the connection to the server
ssl, tls or tls-auto
-
FLUX_MAIL_REST_API_MAIL_BOX Mail box path INBOX
FLUX_MAIL_REST_API_MAIL_MARK_AS_READ Mark fetched mails as read true
FLUX_MAIL_REST_API_SMTP_HOST SMTP server host name -
FLUX_MAIL_REST_API_SMTP_PORT SMTP server port -
FLUX_MAIL_REST_API_SMTP_FROM From email address -
FLUX_MAIL_REST_API_SMTP_FROM_NAME From name -
FLUX_MAIL_REST_API_SMTP_ENCRYPTION_TYPE Type to encrypt the connection to the server
ssl, tls or tls-auto
-
FLUX_MAIL_REST_API_SMTP_USER_NAME SMTP user name
Use FLUX_MAIL_REST_API_SMTP_USER_NAME_FILE for docker secrets
-
FLUX_MAIL_REST_API_SMTP_PASSWORD SMTP password
Use FLUX_MAIL_REST_API_SMTP_PASSWORD_FILE for docker secrets
-
FLUX_MAIL_REST_API_SMTP_AUTH_TYPE Type to authenticate on the server
PLAIN, LOGIN, CRAM-MD5 or XOAUTH2
(Auto detect)
FLUX_MAIL_REST_API_SERVER_HTTPS_CERT Path to HTTPS certificate file
Set this will enable listen on HTTPS
Should be on a volume
-
FLUX_MAIL_REST_API_SERVER_HTTPS_KEY Path to HTTPS key file
Should be on a volume
-
FLUX_MAIL_REST_API_SERVER_LISTEN Listen IP 0.0.0.0
FLUX_MAIL_REST_API_SERVER_PORT Listen port 9501

Minimal variables required to set are bold

Example

examples