metabase.email
email-configured?clj
(email-configured?)Predicate function which returns true if we have a viable email configuration for the app, false otherwise.
Predicate function which returns `true` if we have a viable email configuration for the app, `false` otherwise.
email-from-addressclj
(email-from-address)(email-from-address new-value)Email address you want to use as the sender of Metabase.
email-from-address is a string Setting. You can get its value by calling:
(email-from-address)
and set its value by calling:
(email-from-address <new-value>)
You can also set its value with the env var MB_EMAIL_FROM_ADDRESS.
Clear its value by calling:
(email-from-address nil)
Its default value is notifications@metabase.com.
Email address you want to use as the sender of Metabase.
`email-from-address` is a string Setting. You can get its value by calling:
(email-from-address)
and set its value by calling:
(email-from-address <new-value>)
You can also set its value with the env var `MB_EMAIL_FROM_ADDRESS`.
Clear its value by calling:
(email-from-address nil)
Its default value is `notifications@metabase.com`.email-smtp-hostclj
(email-smtp-host)(email-smtp-host new-value)The address of the SMTP server that handles your emails.
email-smtp-host is a string Setting. You can get its value by calling:
(email-smtp-host)
and set its value by calling:
(email-smtp-host <new-value>)
You can also set its value with the env var MB_EMAIL_SMTP_HOST.
Clear its value by calling:
(email-smtp-host nil)
Its default value is nil.
The address of the SMTP server that handles your emails.
`email-smtp-host` is a string Setting. You can get its value by calling:
(email-smtp-host)
and set its value by calling:
(email-smtp-host <new-value>)
You can also set its value with the env var `MB_EMAIL_SMTP_HOST`.
Clear its value by calling:
(email-smtp-host nil)
Its default value is `nil`.email-smtp-passwordclj
(email-smtp-password)(email-smtp-password new-value)SMTP password.
email-smtp-password is a string Setting. You can get its value by calling:
(email-smtp-password)
and set its value by calling:
(email-smtp-password <new-value>)
You can also set its value with the env var MB_EMAIL_SMTP_PASSWORD.
Clear its value by calling:
(email-smtp-password nil)
Its default value is nil.
SMTP password.
`email-smtp-password` is a string Setting. You can get its value by calling:
(email-smtp-password)
and set its value by calling:
(email-smtp-password <new-value>)
You can also set its value with the env var `MB_EMAIL_SMTP_PASSWORD`.
Clear its value by calling:
(email-smtp-password nil)
Its default value is `nil`.email-smtp-portclj
(email-smtp-port)(email-smtp-port new-value)The port your SMTP server uses for outgoing emails.
email-smtp-port is a string Setting. You can get its value by calling:
(email-smtp-port)
and set its value by calling:
(email-smtp-port <new-value>)
You can also set its value with the env var MB_EMAIL_SMTP_PORT.
Clear its value by calling:
(email-smtp-port nil)
Its default value is nil.
The port your SMTP server uses for outgoing emails.
`email-smtp-port` is a string Setting. You can get its value by calling:
(email-smtp-port)
and set its value by calling:
(email-smtp-port <new-value>)
You can also set its value with the env var `MB_EMAIL_SMTP_PORT`.
Clear its value by calling:
(email-smtp-port nil)
Its default value is `nil`.email-smtp-securityclj
(email-smtp-security)(email-smtp-security new-value)SMTP secure connection protocol. (tls, ssl, starttls, or none)
email-smtp-security is a string Setting. You can get its value by calling:
(email-smtp-security)
and set its value by calling:
(email-smtp-security <new-value>)
You can also set its value with the env var MB_EMAIL_SMTP_SECURITY.
Clear its value by calling:
(email-smtp-security nil)
Its default value is none.
SMTP secure connection protocol. (tls, ssl, starttls, or none)
`email-smtp-security` is a string Setting. You can get its value by calling:
(email-smtp-security)
and set its value by calling:
(email-smtp-security <new-value>)
You can also set its value with the env var `MB_EMAIL_SMTP_SECURITY`.
Clear its value by calling:
(email-smtp-security nil)
Its default value is `none`.email-smtp-usernameclj
(email-smtp-username)(email-smtp-username new-value)SMTP username.
email-smtp-username is a string Setting. You can get its value by calling:
(email-smtp-username)
and set its value by calling:
(email-smtp-username <new-value>)
You can also set its value with the env var MB_EMAIL_SMTP_USERNAME.
Clear its value by calling:
(email-smtp-username nil)
Its default value is nil.
SMTP username.
`email-smtp-username` is a string Setting. You can get its value by calling:
(email-smtp-username)
and set its value by calling:
(email-smtp-username <new-value>)
You can also set its value with the env var `MB_EMAIL_SMTP_USERNAME`.
Clear its value by calling:
(email-smtp-username nil)
Its default value is `nil`.send-email!clj
(send-email! smtp-credentials email-details)Internal function used to send messages. Should take 2 args - a map of SMTP credentials, and a map of email details. Provided so you can swap this out with an "inbox" for test purposes.
Internal function used to send messages. Should take 2 args - a map of SMTP credentials, and a map of email details. Provided so you can swap this out with an "inbox" for test purposes.
send-message!clj
(send-message! & {:keys [subject recipients message-type message] :as msg-args})Send an email to one or more RECIPIENTS.
RECIPIENTS is a sequence of email addresses; MESSAGE-TYPE must be either :text or :html or :attachments.
(email/send-message! :subject "[Metabase] Password Reset Request" :recipients ["cam@metabase.com"] :message-type :text :message "How are you today?")
Upon success, this returns the MESSAGE that was just sent. This function will catch and log any exception, returning a map with a description of the error
Send an email to one or more RECIPIENTS.
RECIPIENTS is a sequence of email addresses; MESSAGE-TYPE must be either `:text` or `:html` or `:attachments`.
(email/send-message!
:subject "[Metabase] Password Reset Request"
:recipients ["cam@metabase.com"]
:message-type :text
:message "How are you today?")
Upon success, this returns the MESSAGE that was just sent. This function will catch and log any exception,
returning a map with a description of the errorsend-message-or-throw!clj
(send-message-or-throw! {:keys [subject recipients message-type message]})Inputs: [{:keys [subject recipients message-type message]} :- EmailMessage]
Send an email to one or more RECIPIENTS. Upon success, this returns the MESSAGE that was just sent. This function does not catch and swallow thrown exceptions, it will bubble up.
Inputs: [{:keys [subject recipients message-type message]} :- EmailMessage]
Send an email to one or more RECIPIENTS. Upon success, this returns the MESSAGE that was just sent. This function
does not catch and swallow thrown exceptions, it will bubble up.test-smtp-connectionclj
(test-smtp-connection details)Test the connection to an SMTP server to determine if we can send emails.
Takes in a dictionary of properties such as: {:host "localhost" :port 587 :user "bigbird" :pass "luckyme" :sender "foo@mycompany.com" :security "tls"}
Test the connection to an SMTP server to determine if we can send emails.
Takes in a dictionary of properties such as:
{:host "localhost"
:port 587
:user "bigbird"
:pass "luckyme"
:sender "foo@mycompany.com"
:security "tls"}cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close