mailibex v0.1.6 MimeMail

Link to this section Summary

Link to this section Types

Link to this type

body()

body() :: binary() | [MimeMail.t()] | {:raw, binary()}
Link to this type

header()

header() :: {:raw, binary()} | MimeMail.Header.t()
Link to this type

t()

t() :: %MimeMail{body: body(), headers: [{key :: binary(), header()}]}

Link to this section Functions

Link to this function

decode_body(mail)

Link to this function

decode_headers(mail, decoders)

Link to this function

encode_body(mail)

Link to this function

encode_header(key, value)

Link to this function

encode_header_key(key)

Link to this function

encode_headers(mail)

Link to this function

ensure_ascii(bin)

Link to this function

ensure_utf8(bin)

Invoked in order to access the value stored under key in the given term term.

This function should return {:ok, value} where value is the value under key if the key exists in the term, or :error if the key does not exist in the term.

Many of the functions defined in the Access module internally call this function. This function is also used when the square-brackets access syntax (structure[key]) is used: the fetch/2 callback implemented by the module that defines the structure struct is invoked and if it returns {:ok, value} then value is returned, or if it returns :error then nil is returned.

See the Map.fetch/2 and Keyword.fetch/2 implementations for examples of how to implement this callback.

Callback implementation for Access.fetch/2.

Link to this function

fix_linebreak(data)

Link to this function

fold_header(header)

Link to this function

fold_header(other, acc)

Link to this function

from_string(data)

Link to this function

get(dict, k, v)

See Map.get/3.

Link to this function

get_and_update(dict, k, v)

Invoked in order to access the value under key and update it at the same time.

The implementation of this callback should invoke fun with the value under key in the passed structure data, or with nil if key is not present in it. This function must return either {get_value, update_value} or :pop.

If the passed function returns {get_value, update_value}, the return value of this callback should be {get_value, new_data}, where:

  • get_value is the retrieved value (which can be operated on before being returned)

  • update_value is the new value to be stored under key

  • new_data is data after updating the value of key with update_value.

If the passed function returns :pop, the return value of this callback must be {value, new_data} where value is the value under key (or nil if not present) and new_data is data without key.

See the implementations of Map.get_and_update/3 or Keyword.get_and_update/3 for more examples.

Callback implementation for Access.get_and_update/3.

Link to this function

header_key(word)

Link to this function

header_value(value)

Link to this function

ok_or(arg1, default)

Invoked to "pop" the value under key out of the given data structure.

When key exists in the given structure data, the implementation should return a {value, new_data} tuple where value is the value that was under key and new_data is term without key.

When key is not present in the given structure, a tuple {value, data} should be returned, where value is implementation-defined.

See the implementations for Map.pop/3 or Keyword.pop/3 for more examples.

Callback implementation for Access.pop/2.

Link to this function

qp_to_binary(str)

Link to this function

qp_to_binary(arg1, acc)

Link to this function

string_to_qp(str)

Link to this function

to_string(mail)

Link to this function

unfold_header(value)