Marten SMTP Emailing

Marten SMTP Emailing provides an SMTP backend that can be used with Marten web framework's emailing system.

Installation

Simply add the following entry to your project's shard.yml:

dependencies:
  marten_smtp_emailing:
    github: martenframework/marten-smtp-emailing

And run shards install afterward.

Configuration

First, add the following requirement to your project's src/project.cr file:

require "marten_smtp_emailing"

You can then configure your project to use the SMTP backend by setting the corresponding configuration option as follows:

Marten.configure do |config|
  config.emailing.backend = MartenSMTPEmailing::Backend.new
end

By default, the backend will attempt to deliver emails to an SMTP server running on localhost and listening on the standard SMTP port (25). If you need to, you can change these backend properties at initialization time:

Marten.configure do |config|
  config.emailing.backend = MartenSMTPEmailing::Backend.new(
    host: "localhost",
    port: 25,
    helo_domain: "localhost",
    use_tls: true,
    username: nil,
    password: nil
  )
end

If delivery fails (connection error, handshake failure, or a rejected message), #deliver raises MartenSMTPEmailing::Backend::DeliveryError. Underlying connection exceptions are available as the error's #cause.

Authors

Morgan Aubert (@ellmetha) and contributors.

License

MIT. See LICENSE for more details.