Skip to content

config properties email_delivery

GitHub Action edited this page Sep 4, 2024 · 3 revisions

Version

v1.0.3

email_delivery Type

object (email_delivery)

email_delivery Properties

Property Type Required Nullable Defined by
enabled boolean Optional cannot be null Config
from_address string Optional cannot be null Config
from_name string Optional cannot be null Config
smtp object Optional cannot be null Config

enabled

enabled determines whether the API delivers emails. Disable if you want to send the emails yourself. To do so you must subscribe to the email.create webhook event.

enabled

  • is optional

  • cannot be null

enabled Type

boolean

enabled Default Value

The default value is:

true

from_address

from_address configures the sender address of emails sent to users.

from_address

  • is optional

  • cannot be null

from_address Type

string

from_address Default Value

The default value is:

from_name

from_name configures the sender name of emails sent to users.

from_name

  • is optional

  • cannot be null

from_name Type

string

from_name Default Value

The default value is:

"Hanko"

smtp

SMTP contains the SMTP server settings for sending mails.

smtp

  • is optional

  • cannot be null

smtp Type

object (smtp)

Clone this wiki locally