IMAP.ClientCommand (imap v0.1.2)

Copy Markdown View Source

Represents an IMAP command struct. This struct captures all client commands supported by RFC3501 - IMAP4rev1.

Summary

Types

t()

@type t() :: %IMAP.ClientCommand{
  command: atom() | String.t() | nil,
  params: list(),
  tag: String.t()
}
  • :tag - A unique identifier for the command, used to correlate server
             responses back to the originating command (e.g. `"A001"`).
  • :command - The IMAP command verb (e.g. LOGIN, SELECT, FETCH, LOGOUT and etc.).
  • :params - An ordered list of arguments to the command (e.g. mailbox name,
             message sequence sets, fetch attributes and etc.).
             No parameters indicated by an empty array `[]`.

Functions

capability()

login(username, password)

logout()

noop()

serialize(client_command)