documentation /api provider

Email

API provider

Outbound SMTP email API config. Used by the Email service and by ingredients like Send email. Does not send emails directly; this is done by the service or ingredient, just provides the SMTP config.

  • API category: Email
  • Needs login: No, two-legged: no end-user interaction is required

Configuration parameters

Required

  • server : string; required
    SMTP server hostname (e.g. smtp.gmail.com).
  • requireSSL : true/false; required
    Whether to require TLS/SSL for the SMTP connection.
  • certificate : string; required
    PEM-encoded SSL certificate to validate against. Leave blank to accept the server’s default cert.
  • username : string; required
    SMTP login username.
  • password : string; required
    SMTP login password (or app-specific password).
  • from : string; required
    Email address to use in the From: header of outgoing messages.

What components can use this API

Concepts:

Ingredients: