Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DockYard/elixir-mail
Build composable mail messages
https://github.com/DockYard/elixir-mail
elixir mail rfc-2822
Last synced: about 2 months ago
JSON representation
Build composable mail messages
- Host: GitHub
- URL: https://github.com/DockYard/elixir-mail
- Owner: DockYard
- Created: 2016-02-09T16:43:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T17:56:22.000Z (4 months ago)
- Last Synced: 2024-04-08T16:44:41.051Z (2 months ago)
- Topics: elixir, mail, rfc-2822
- Language: Elixir
- Size: 234 KB
- Stars: 379
- Watchers: 15
- Forks: 61
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-elixir - mail - An RFC2822 implementation in Elixir, built for composability. (Email)
- freaking_awesome_elixir - Elixir - An RFC2822 implementation in Elixir, built for composability. (Email)
- awesome-stars - DockYard/elixir-mail - Build composable mail messages (Elixir)
- awesome-elixir - mail - An RFC2822 implementation in Elixir, built for composability. (Email)
- fucking-awesome-elixir - mail - An RFC2822 implementation in Elixir, built for composability. (Email)
README
# Mail
An RFC2822 implementation in Elixir, built for composability.
**[Mail is built and maintained by DockYard, contact us for expert Elixir and Phoenix consulting](https://dockyard.com/phoenix-consulting)**.
## Installation
```elixir
def deps do
[
# Get from hex
{:mail, "~> 0.3"},
# Or use the latest from master
{:mail, github: "DockYard/elixir-mail"}
]
end
```
## Building
You can quickly build an RFC2822 spec compliant message.
#### Single-Part
```elixir
message =
Mail.build()
|> Mail.put_text("A great message")
|> Mail.put_to("[email protected]")
|> Mail.put_from("[email protected]")
|> Mail.put_subject("Open me")
```
#### Multi-Part
```elixir
message =
Mail.build_multipart()
|> Mail.put_text("Hello there!")
|> Mail.put_html("
Hello there!
")
|> Mail.put_attachment("path/to/README.md")
|> Mail.put_attachment({"README.md", file_data})
```
## Rendering
After you have built your message you can render it:
```elixir
rendered_message = Mail.render(message)
```
## Parsing
If you'd like to parse an already rendered message back into
a data model:
```elixir
%Mail.Message{} = message = Mail.parse(rendered_message)
```
[There are more functions described in the docs](https://hexdocs.pm/mail/Mail.html)
## Authors ##
* [Brian Cardarella](https://twitter.com/bcardarella)
[We are very thankful for the many contributors](https://github.com/dockyard/elixir-mail/graphs/contributors)
## Versioning ##
This library follows [Semantic Versioning](https://semver.org)
## Looking for help with your Elixir project? ##
[At DockYard we are ready to help you build your next Elixir project](https://dockyard.com/phoenix-consulting). We have a unique expertise
in Elixir and Phoenix development that is unmatched. [Get in touch!](https://dockyard.com/contact/hire-us)
At DockYard we love Elixir! You can [read our Elixir blog posts](https://dockyard.com/blog/categories/elixir)
or come visit us at [The Boston Elixir Meetup](https://www.meetup.com/Boston-Elixir/) that we organize.
## Want to help? ##
Please do! We are always looking to improve this library. Please see our
[Contribution Guidelines](https://github.com/dockyard/elixir-mail/blob/master/CONTRIBUTING.md)
on how to properly submit issues and pull requests.
## Legal ##
[DockYard](https://dockyard.com/), Inc. © 2015
[@dockyard](https://twitter.com/dockyard)
[Licensed under the MIT license](https://www.opensource.org/licenses/mit-license.php)