plunk/transactional

Types

Contact

pub type Contact {
  Contact(id: String, email: String)
}

Constructors

```
Contact(id: String, email: String)
```

Email

</>

pub type Email {
  Email(contact: Contact, email: String)
}

Constructors

```
Email(contact: Contact, email: String)
```

SendTransactionalEmailResponse

</>

pub type SendTransactionalEmailResponse {
  SendTransactionalEmailResponse(
    success: Bool,
    emails: List(Email),
    timestamp: Option(String),
  )
}

Constructors

SendTransactionalEmailResponse(
  success: Bool,
  emails: List(Email),
  timestamp: Option(String),
)

To

</>

pub type To {
  Address(String)
  Addresses(List(String))
}

Constructors

```
Address(String)
```
```
Addresses(List(String))
```

TransactionalEmail

</>

pub type TransactionalEmail {
  TransactionalEmail(
    to: To,
    subject: String,
    body: String,
    name: Option(String),
    from: Option(String),
  )
}

Constructors

TransactionalEmail(
  to: To,
  subject: String,
  body: String,
  name: Option(String),
  from: Option(String),
)

Functions

decode

</>

pub fn decode(
  res: Response(String),
) -> Result(SendTransactionalEmailResponse, PlunkError)

Decode the raw response into a SendTransactionalEmailResponse type wrapped in a Result type that can be pattern matched on.

send

</>

pub fn send(
  instance: Instance,
  mail mail: TransactionalEmail,
) -> Request(String)

Send a transactional email

Example

import gleam/option.{None}
import gleam/hackney
import plunk
import plunk/transactional.{Single, TransactionalEmail}

fn main() {
  let instance = plunk.new(key: "YOUR_API_KEY")

  let req =
    instance
    |> transactional.send(
      mail: TransactionalEmail(
        to: Address("someone@example.com"),
        subject: "Hello",
        body: "<h1>Hello, World!</h1>",
        name: None,
        from: None,
      )
    )
  let assert Ok(resp) = hackney.send(req)
  let assert Ok(data) = transactional.decode(resp)
  // do whatever you want with the data
}

send_transactional_email_decoder

</>

pub fn send_transactional_email_decoder() -> fn(Dynamic) ->
  Result(SendTransactionalEmailResponse, List(DecodeError))