Files
sct-overseerr/docs/using-overseerr/notifications/email.md
TheCatLady e0491ab02a docs: update documentation to reflect recent changes/additions (#1730) [skip ci]
* docs: update documentation to reflect recent changes/additions

* docs: add list of third-party integrations

* docs: add v3 warning

* docs: fix Docker for Windows link text

* docs: fix Telegram 'Send Silently' setting description

* docs: note that application URL is required for password reset/generation

* docs: add additional details on webhook template variables
2021-06-04 22:15:32 +09:00

2.0 KiB

Email

Configuration

{% hint style="info" %} If the Application URL setting is configured in Settings → General, Overseerr will explicitly set the origin server hostname when connecting to the SMTP host. {% endhint %}

Sender Name (optional)

Configure a friendly name for the email sender (e.g., "Overseerr").

Sender Address

Set this to the email address you would like to appear in the "from" field of the email message.

Depending on your email provider, this may need to be an address you own. For example, Gmail requires this to be your actual email address.

SMTP Host

Set this to the hostname or IP address of your SMTP host/server.

SMTP Port

Set this to a supported port number for your SMTP host. 465 and 587 are commonly used.

Enable SSL (optional)

This setting should only be enabled for ports that use implicit SSL/TLS (e.g., port 465 in most cases).

For servers that support opportunistic TLS/STARTTLS (typically via port 587), this setting should not be enabled.

SMTP Username & Password

{% hint style="info" %} If your account has two-factor authentication enabled, you may need to create an application password instead of using your account password. {% endhint %}

Configure these values as appropriate to authenticate with your SMTP host.

PGP Private Key & Password (optional)

Configure these values to enable encrypting and signing of email messages using OpenPGP. Note that individual users must also have their PGP public keys configured in their user settings in order for PGP encryption to be used in messages addressed to them.

When configuring the PGP keys, be sure to keep the entire contents of the key intact. For example, private keys always begin with -----BEGIN PGP PRIVATE KEY BLOCK----- and end with -----END PGP PRIVATE KEY BLOCK-----.