ExImapClient (ExImapClient v0.3.0)

This library offers a feature rich utility to communicate with an IMAP server.

It returns fully parsed, structured responses from the server.

example

example:

{:ok, {identifier, greeting_from_server}} = start_connection("your_imap_server")
login(identifier, "username", "password")

select(identifier, "inbox")
examine(identifier)

fetch(identifier, "1", "1")

Link to this section Summary

Functions

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

starts an unencrypted connection to hostname. returns an identifier for this connection.

starts an encrypted connection to hostname, explicit. returns an identifier for this connection.

starts an unencrypted connection to hostname, explicit. returns an identifier for this connection.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

requires the connection identifier. returns a parsed, structured response from the server.

Link to this section Functions

Link to this function

append(identifier, mailbox, message)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

authenticate_oauth2(identifier, oauth_token)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

authenticate_plain(identifier, username, password)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

capability(identifier)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

check(identifier)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

close(identifier)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

copy(identifier, from, to, destination_mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

create(identifier, mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

delete(identifier, mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

examine(identifier, mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

expunge(identifier)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

fetch(identifier, from, to, macro \\ "ENVELOPE", time_out \\ 50000)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

list(identifier, from \\ "\"\"", to \\ "\"*\"")

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

login(identifier, username, password)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

logout(identifier)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

lsub(identifier, from \\ "\"\"", to \\ "\"*\"")

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

noop(identifier)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

rename(identifier, from, to)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

search(identifier, criteria \\ "ALL")

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

select(identifier, mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

start_connection(hostname, port \\ 143)

starts an unencrypted connection to hostname. returns an identifier for this connection.

Link to this function

start_connection_ssl(hostname, port \\ 993)

starts an encrypted connection to hostname, explicit. returns an identifier for this connection.

Link to this function

start_connection_tcp(hostname, port \\ 143)

starts an unencrypted connection to hostname, explicit. returns an identifier for this connection.

Link to this function

status(identifier, mailbox, query \\ "MESSAGES RECENT UIDNEXT UIDVALIDITY UNSEEN")

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

store(identifier, from, to, flags \\ "FLAGS", flag_list)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

subscribe(identifier, mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

uid_copy(identifier, from_uid, to_uid, destination_mailbox)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

uid_fetch(identifier, from_uid, to_uid, macro \\ "ENVELOPE", timeout \\ 50000)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

uid_search(identifier, criteria \\ "ALL")

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

uid_store(identifier, from_uid, to_uid, flags \\ "FLAGS", flag_list)

requires the connection identifier. returns a parsed, structured response from the server.

Link to this function

unsubscribe(identifier, mailbox)

requires the connection identifier. returns a parsed, structured response from the server.