Eximap

v0.1.2-dev

Eximap v0.1.2-dev Eximap.Imap.Request View Source

Link to this section Summary

Functions

add_tag(req, tag)
append(name, opts)
authenticate(mechanism)

The AUTHENTICATE command indicates a SASL authentication mechanism to the server. If the server supports the requested authentication mechanism, it performs an authentication protocol exchange to authenticate and identify the client

capability()

The CAPABILITY command requests a listing of capabilities that the server supports. The server MUST send a single untagged CAPABILITY response with “IMAP4rev1” as one of the listed capabilities before the (tagged) OK response

check()

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> Eximap.Imap.Client.execute(pid, Eximap.Imap.Request.select(“INBOX”)) iex> req = Eximap.Imap.Request.check() iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

close()
copy(sequence, mailbox)
create(name)
delete(name)
examine(name)

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.examine(“INBOX”) iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

expunge()
fetch(sequence, flags)
list(reference \\ "\"\"", mailbox \\ "\"%\"")

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.list() iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

login(user, pass)

The LOGIN command identifies the client to the server and carries the plaintext password authenticating this user

logout()

The LOGOUT command informs the server that the client is done with the connection. The server MUST send a BYE untagged response before the (tagged) OK response, and then close the network connection

lsub(reference \\ "\"\"", mailbox \\ "\"\"")
noop()

The NOOP command always succeeds. It does nothing

raw(req)
rename(name, new_name)
search(flags)
select(name)

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.select(“INBOX”) iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

starttls()
status(name, opts)
store(sequence, item, value)
subscribe(name)
uid(params)
unsubscribe(name)

Link to this section Functions

Link to this function authenticate(mechanism) View Source

The AUTHENTICATE command indicates a SASL authentication mechanism to the server. If the server supports the requested authentication mechanism, it performs an authentication protocol exchange to authenticate and identify the client.

Link to this function capability() View Source

The CAPABILITY command requests a listing of capabilities that the server supports. The server MUST send a single untagged CAPABILITY response with “IMAP4rev1” as one of the listed capabilities before the (tagged) OK response.

Client and server implementations MUST implement the STARTTLS, LOGINDISABLED, and AUTH=PLAIN capabilities.

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.capability() iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

%Eximap.Imap.Response{body: [%{},

       %{message: "IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE IDLE SORT SORT=DISPLAY THREAD=REFERENCES THREAD=REFS THREAD=ORDEREDSUBJECT MULTIAPPEND URL-PARTIAL CATENATE UNSELECT CHILDREN NAMESPACE UIDPLUS LIST-EXTENDED I18NLEVEL=1 CONDSTORE QRESYNC ESEARCH ESORT SEARCHRES WITHIN CONTEXT=SEARCH LIST-STATUS BINARY MOVE SPECIAL-USE QUOTA",
         type: "CAPABILITY"}], error: nil,
      message: "Capability completed (0.000 + 0.000 secs).",
      partial: false,
      request: %Eximap.Imap.Request{command: "CAPABILITY", params: [],
       tag: "EX1"}, status: "OK"}
Link to this function check() View Source

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> Eximap.Imap.Client.execute(pid, Eximap.Imap.Request.select(“INBOX”)) iex> req = Eximap.Imap.Request.check() iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

%Eximap.Imap.Response{body: [%{}], error: nil,

      message: "Check completed (0.001 + 0.000 secs).", partial: false,
      request: %Eximap.Imap.Request{command: "CHECK", params: [],
       tag: "EX2"}, status: "OK"}

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> Eximap.Imap.Client.execute(pid, Eximap.Imap.Request.select(“INBOX”)) iex> resp = Eximap.Imap.Client.execute(pid, Eximap.Imap.Request.search([“ALL”])) iex> resp.error == nil true

Link to this function examine(name) View Source

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.examine(“INBOX”) iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

%Eximap.Imap.Response{body: [%{},

       %{message: "[HIGHESTMODSEQ 1] Highest", type: "OK"},
       %{message: "[UIDNEXT 1] Predicted next UID", type: "OK"},
       %{message: "[UIDVALIDITY 1512767411] UIDs valid", type: "OK"},
       %{message: "RECENT", type: "0"}, %{message: "EXISTS", type: "0"},
       %{message: "[PERMANENTFLAGS ()] Read-only mailbox.", type: "OK"},
       %{message: "(\\Answered \\Flagged \\Deleted \\Seen \\Draft)",
         type: "FLAGS"}], error: nil,
      message: "[READ-ONLY] Examine completed (0.000 + 0.000 secs).",
      partial: false,
      request: %Eximap.Imap.Request{command: "EXAMINE", params: ["INBOX"],
       tag: "EX1"}, status: "OK"}
Link to this function list(reference \\ "\"\"", mailbox \\ "\"%\"") View Source

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.list() iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

Link to this function login(user, pass) View Source

The LOGIN command identifies the client to the server and carries the plaintext password authenticating this user.

Link to this function logout() View Source

The LOGOUT command informs the server that the client is done with the connection. The server MUST send a BYE untagged response before the (tagged) OK response, and then close the network connection.

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.logout() iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

Link to this function lsub(reference \\ "\"\"", mailbox \\ "\"\"") View Source
Link to this function noop() View Source

The NOOP command always succeeds. It does nothing.

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.noop() iex> Eximap.Imap.Client.execute(pid, req) |> Map.from_struct() %{body: [%{}], error: nil,

       message: "NOOP completed (0.001 + 0.000 secs).", partial: false,
       request: %Eximap.Imap.Request{command: "NOOP", params: [],
        tag: "EX1"}, status: "OK"}
Link to this function select(name) View Source

iex> {:ok, pid} = Eximap.Imap.Client.start_link() iex> req = Eximap.Imap.Request.select(“INBOX”) iex> resp = Eximap.Imap.Client.execute(pid, req) iex> resp.error == nil true

%Eximap.Imap.Response{body: [%{},

       %{message: "[HIGHESTMODSEQ 1] Highest", type: "OK"},
       %{message: "[UIDNEXT 1] Predicted next UID", type: "OK"},
       %{message: "[UIDVALIDITY 1512767411] UIDs valid", type: "OK"},
       %{message: "RECENT", type: "0"}, %{message: "EXISTS", type: "0"},
       %{message: "[PERMANENTFLAGS (\\Answered \\Flagged \\Deleted \\Seen \\Draft \\*)] Flags permitted.",
         type: "OK"},
       %{message: "(\\Answered \\Flagged \\Deleted \\Seen \\Draft)",
         type: "FLAGS"}], error: nil,
      message: "[READ-WRITE] Select completed (0.000 + 0.000 secs).",
      partial: false,
      request: %Eximap.Imap.Request{command: "SELECT", params: ["INBOX"],
       tag: "EX1"}, status: "OK"}
Link to this function store(sequence, item, value) View Source