Overleaf docs
Plans and pricingTemplatesUser docsGo to Overleaf
On-premises
On-premises
  • Welcome
    • Server Pro vs. Community Edition
  • Release notes
    • Release notes 5.x.x
      • Doc version recovery
    • Release notes 4.x.x
    • Release notes 3.x.x
      • Full project history migration
    • Release notes 2.x.x
    • Release notes 1.x.x
    • Release notes 0.x.x
  • Getting started
    • Before you start
    • Requirements
      • Skills needed
      • Hardware requirements
      • Software requirements
    • Microservices
    • Server Pro infrastructure
    • What is the Overleaf Toolkit?
  • Installation
    • Introduction
    • Using the Toolkit
      • 1: Download the Toolkit
      • 2: Familiarize yourself with the Toolkit
      • 3: Initialize the configuration
      • 4. Choose Community Edition or Server Pro
      • 5. Personalizing your instance
      • 6. Post-installation tasks
    • Air-gapped/offline deployments
    • Upgrading TeX Live
  • Configuration
    • Overleaf Toolkit
      • Files and locations
      • Toolkit settings
      • Environment variables
      • Server Pro-only configuration
        • LDAP
        • SAML 2.0
        • Sandboxed Compiles
        • Git integration
        • Templates
        • Adding LaTeX user help
      • Logging
      • TLS proxy
      • Branding
      • Localization
      • Email delivery
      • Redis
      • S3
  • Maintenance
    • docker-compose.yml to Toolkit migration
    • Upgrading your deployment
    • Data and backups
      • Exporting projects
    • Extending TeX Live
    • Horizontal scaling
    • S3 migration
    • Updating MongoDB
  • User and project management
    • User management
      • Username migration
    • Understanding license usage
    • Project management
  • Support
    • Project limits
    • Troubleshooting
    • Getting help
    • Support guides
      • Using templates as an individual
    • Overleaf user docs
Powered by GitBook
LogoLogo

Discover Overleaf

  • Home
  • Features

Solutions

  • Plans and pricing
  • For universities
  • For business
  • For government

Resources

  • Templates
  • User docs and LaTeX learning
  • Blog

© Overleaf

On this page

Was this helpful?

Export as PDF
  1. Configuration
  2. Overleaf Toolkit

Email delivery

PreviousLocalizationNextRedis

Last updated 6 months ago

Was this helpful?

Overleaf supports sending email through two methods: Simple Mail Transfer Protocol (SMTP) and . SMTP can be used if you have an email server enabled on your localhost that is listening for local connections.

Configuration

Email is configured using the following environmental variables.

Sender Configuration

Name
Description

OVERLEAF_EMAIL_FROM_ADDRESS

The from address e.g. 'support@mycompany.com' - Required: yes

OVERLEAF_EMAIL_REPLY_TO

The reply to address e.g. 'noreply@mycompany.com'

SMTP

Name
Description

OVERLEAF_EMAIL_SMTP_HOST

The hostname or IP address to connect to. Needs to be accessible from the Docker container

OVERLEAF_EMAIL_SMTP_PORT

The port to connect to

OVERLEAF_EMAIL_SMTP_SECURE

If true the connection will use TLS when connecting to server. If false or not set, then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false

OVERLEAF_EMAIL_SMTP_USER

The username that should be used to authenticate against the SMTP server

OVERLEAF_EMAIL_SMTP_PASS

The password associated with the SMTP username

OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH

If 'false' this would open a connection to TLS server with self-signed or invalid TLS certificate

OVERLEAF_EMAIL_SMTP_IGNORE_TLS

When true and OVERLEAF_EMAIL_SMTP_SECURE is false then TLS is not used even if the server supports STARTTLS extension

OVERLEAF_EMAIL_SMTP_NAME

Optional hostname for TLS validation if OVERLEAF_EMAIL_SMTP_HOST was set to an IP address, defaults to hostname of the machine.

OVERLEAF_EMAIL_SMTP_LOGGER

When true prints logging messages to web.log.

Amazon SES SMTP interface

Name
Description

OVERLEAF_EMAIL_SMTP_HOST

The hostname or IP address to connect to. Needs to be accessible from the Docker container

OVERLEAF_EMAIL_SMTP_PORT

The port to connect to

OVERLEAF_EMAIL_SMTP_USER

The username that should be used to authenticate against the SMTP server

OVERLEAF_EMAIL_SMTP_PASS

The password associated with the SMTP username

Amazon SES API

Name
Description

OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID

If using AWS SES the access key

OVERLEAF_EMAIL_AWS_SES_SECRET_KEY

If using AWS SES the secret key

OVERLEAF_EMAIL_AWS_SES_REGION

If not set, the default region is US-EAST-1

AWS SES with Instance Roles

Name
Description

OVERLEAF_EMAIL_DRIVER:

When this is set to ses, the email system will use the SES API method and rely on the configured instance roles to send email.

Customisation

Name
Description

OVERLEAF_CUSTOM_EMAIL_FOOTER

Custom HTML which is appended to all emails. e.g. Example: "<div>This system is run by department x </div> <div> If you have any questions please look at our faq <a href='https://somwhere.com'>here</a></div>"

You can read more about using the Amazon SES SMTP interface to send email .

You can read more about using the Amazon SES API to send email .

Amazon Simple Email Service (SES)
here
here