https://github.com/luckyframework/carbon_smtp_adapter

An smtp adapter for the carbon email library
https://github.com/luckyframework/carbon_smtp_adapter

carbon crystal email smtp

Last synced: 2 months ago
JSON representation

An smtp adapter for the carbon email library

• Host: GitHub
• URL: https://github.com/luckyframework/carbon_smtp_adapter
• Owner: luckyframework
• License: mit
• Created: 2018-11-02T11:23:48.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-09T16:29:22.000Z (5 months ago)
• Last Synced: 2024-04-11T03:05:08.322Z (3 months ago)
• Topics: carbon, crystal, email, smtp
• Language: Crystal
• Size: 22.5 KB
• Stars: 10
• Watchers: 4
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-lucky - carbon_smtp_adapter

README

        
# carbon\_smtp\_adapter

A simple SMTP-Adapter for [carbon](https://github.com/luckyframework/carbon).

## Versioning

The current plan is to track carbon's major and minor numbers, so that

carbon\_smtp\_adapter `0.1.x` is compatible with carbon `0.1.x` and so on.

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  carbon_smtp_adapter:

    github: luckyframework/carbon_smtp_adapter

```

## Usage

```crystal

require "carbon_smtp_adapter"

# configure your base email class to use the smtp adapter:

BaseEmail.configure do |setting|

  settings.adapter = Carbon::SmtpAdapter.new

end

```

By default, carbon will try to deliver the email to an smtp server running on

`localhost` and listening on port `25`. If you need different settings, you can

configure the following (values shown are the defaults):

```crystal

Carbon::SmtpAdapter.configure do |settings|

  settings.host = "localhost"

  settings.port = 25

  settings.helo_domain = nil

  settings.use_tls = true

  settings.username = nil

  settings.password = nil

end

```

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [oneiros](https://github.com/oneiros) David Roetzel - creator

With many thanks to:

- [paulcsmith](https://github.com/paulcsmith) Paul Smith - creator of carbon

- [arcage](https://github.com/arcage) arcage - creator of crystal-email

- [tijn](https://github.com/tijn) Tijn Schuurmans - creator of devmail