Skip to content


URL Format


URL Fields

  • Username - SMTP server username
    Default: empty
    URL part: smtp://username:password@host:port/
  • Password - SMTP server password or hash (for OAuth2)
    Default: empty
    URL part: smtp://username:password@host:port/
  • Host - SMTP server hostname or IP address (Required)
    URL part: smtp://username:password@host:port/
  • Port - SMTP server port, common ones are 25, 465, 587 or 2525
    Default: 25
    URL part: smtp://username:password@host:port/

Query/Param Props

Props can be either supplied using the params argument, or through the URL using
?key=value&key=value etc.

  • FromAddress - E-mail address that the mail are sent from (Required)
    Aliases: from

  • ToAddresses - List of recipient e-mails separated by "," (comma) (Required)
    Aliases: to

  • Auth - SMTP authentication method
    Default: Unknown
    Possible values: None, Plain, CRAMMD5, Unknown, OAuth2

  • ClientHost - The client host name sent to the SMTP server during HELLO phase. If set to "auto" it will use the OS hostname
    Default: localhost

  • Encryption - Encryption method
    Default: Auto
    Possible values: None, ExplicitTLS, ImplicitTLS, Auto

  • FromName - Name of the sender
    Default: empty

  • Subject - The subject of the sent mail
    Default: Shoutrrr Notification
    Aliases: title

  • UseHTML - Whether the message being sent is in HTML
    Default: ❌ No

  • UseStartTLS - Whether to use StartTLS encryption
    Default: ✔ Yes
    Aliases: starttls