Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wout/mailjet.cr
Mailjet API Client for Crystal https://app.mailjet.com
https://github.com/wout/mailjet.cr
crystal mailing mailjet mailjet-api mailjet-sdk
Last synced: 2 months ago
JSON representation
Mailjet API Client for Crystal https://app.mailjet.com
- Host: GitHub
- URL: https://github.com/wout/mailjet.cr
- Owner: wout
- License: mit
- Created: 2020-04-26T12:31:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T06:39:53.000Z (8 months ago)
- Last Synced: 2024-05-06T00:05:06.843Z (8 months ago)
- Topics: crystal, mailing, mailjet, mailjet-api, mailjet-sdk
- Language: Crystal
- Homepage:
- Size: 1.19 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailjet API client for Crystal
Mailjet is an email platform for teams to send transactional & marketing emails.
It is a GDPR compliant and ISO 27001 certified Email Service Provider.
## Disclaimer
This is the unofficial [Crystal](https://crystal-lang.org/) shard for Mailjet.
The majority of the API is covered, but some parts still need to be added.
## Requirements
To use the Mailjet API client, you will need a free
[Mailjet account](https://app.mailjet.com/signup).
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
mailjet:
github: wout/mailjet.cr
```
2. Run `shards install`
## Usage
### Include the shard
```crystal
require "mailjet"
```
### Configure your crendentials
```crystal
Mailjet.configure do |settings|
settings.api_key = "your-api-key"
settings.secret_key = "your-secret-key"
settings.default_from = "[email protected]"
end
```
### Send your first email
```crystal
response = Mailjet::SendV3_1.message({
From: {
Email: "[email protected]",
Name: "Me",
},
To: [
{
Email: "[email protected]",
Name: "You",
},
],
Subject: "My first Mailjet Email!",
TextPart: "Greetings from Mailjet!",
HTMLPart: <<-HTML
Dear passenger 1, welcome to
Mailjet!
May the delivery force be with you!
HTML
})
puts response.status
# => "success"
```
### Send multiple messages
```crystal
response = Mailjet::SendV3_1.messages([
{...},
{...}
])
puts response.first.status
# => "success"
```
### Retrieve sent messages
Now, let’s view the status of the sent message and its configuration specifics.
```crystal
message = Mailjet::Message.find(576460754655154659)
puts message.status
# => "opened"
```
### View message history
You can track important events linked to the sent emails, for example whether
the recipient opened the message, or clicked on a link within.
```crystal
events = Mailjet::Messagehistory.all(576460754655154659)
puts events.first.event_type
# => "sent"
puts events.last.event_type
# => "opened"
```
### Retrieve Statistics
The Mailjet API also has a variety of resources that help retrieve aggregated
statistics for key performance indicators like opens, clicks, unsubscribes, etc.
Let's take a look at just one of those resources to give you a sample of the
data you can read - we’ll retrieve total aggregated statistics for your API key.
```crystal
counters = Mailjet::Statcounters.by_api_key({
counter_timing: "event",
counter_resolution: "hour",
from_ts: Time.local.at_beginning_of_day.to_unix,
to_ts: Time.local.to_unix,
})
puts counters.first.event_opened_count
# => 28
```
### Temporarily use other settings
```crystal
Mailjet.temp_config(api_version: Mailjet::Api::V3_1) do
# ... do something ...
end
```
### Using this shard in a Lucky app
If you want to use this shard in a [Lucky](https://luckyframework.org/) app, you can use the [carbon_mailjet_adapter](https://github.com/wout/carbon_mailjet_adapter).
## Documentation
- [Shard API Docs](https://wout.github.io/mailjet.cr/)
## To-do
Most of the API is covered, but the following endpoints are not:
- [ ] All Message Events
- [ ] Bulk contact management and CSV import
- [ ] Parse
- [ ] Settings
- [ ] SMS
- [ ] Statistics (only statcounters is done)
- [ ] Webhook
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'feat: add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [wout](https://github.com/wout) - creator and maintainer