ExImapClient (ExImapClient v0.1.1)
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
append(identifier, mailbox, message)
requires the connection identifier. returns a parsed, structured response from the server.
authenticate_oauth2(identifier, oauth_token)
requires the connection identifier. returns a parsed, structured response from the server.
authenticate_plain(identifier, username, password)
requires the connection identifier. returns a parsed, structured response from the server.
capability(identifier)
requires the connection identifier. returns a parsed, structured response from the server.
check(identifier)
requires the connection identifier. returns a parsed, structured response from the server.
close(identifier)
requires the connection identifier. returns a parsed, structured response from the server.
copy(identifier, from, to, destination_mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
create(identifier, mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
delete(identifier, mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
examine(identifier, mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
expunge(identifier)
requires the connection identifier. returns a parsed, structured response from the server.
fetch(identifier, from, to, macro \\ "ENVELOPE", time_out \\ 50000)
requires the connection identifier. returns a parsed, structured response from the server.
list(identifier, from \\ "\"\"", to \\ "\"*\"")
requires the connection identifier. returns a parsed, structured response from the server.
login(identifier, username, password)
requires the connection identifier. returns a parsed, structured response from the server.
logout(identifier)
requires the connection identifier. returns a parsed, structured response from the server.
lsub(identifier, from \\ "\"\"", to \\ "\"*\"")
requires the connection identifier. returns a parsed, structured response from the server.
noop(identifier)
requires the connection identifier. returns a parsed, structured response from the server.
rename(identifier, from, to)
requires the connection identifier. returns a parsed, structured response from the server.
search(identifier, criteria \\ "ALL")
requires the connection identifier. returns a parsed, structured response from the server.
select(identifier, mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
start_connection(hostname, port \\ 143)
starts an unencrypted connection to hostname
.
returns an identifier
for this connection.
start_connection_ssl(hostname, port \\ 993)
starts an encrypted connection to hostname
, explicit.
returns an identifier
for this connection.
start_connection_tcp(hostname, port \\ 143)
starts an unencrypted connection to hostname
, explicit.
returns an identifier
for this connection.
status(identifier, mailbox, query \\ "MESSAGES RECENT UIDNEXT UIDVALIDITY UNSEEN")
requires the connection identifier. returns a parsed, structured response from the server.
store(identifier, from, to, flags \\ "FLAGS", flag_list)
requires the connection identifier. returns a parsed, structured response from the server.
subscribe(identifier, mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
uid_copy(identifier, from_uid, to_uid, destination_mailbox)
requires the connection identifier. returns a parsed, structured response from the server.
uid_fetch(identifier, from_uid, to_uid, macro \\ "ENVELOPE", timeout \\ 50000)
requires the connection identifier. returns a parsed, structured response from the server.
uid_search(identifier, criteria \\ "ALL")
requires the connection identifier. returns a parsed, structured response from the server.
uid_store(identifier, from_uid, to_uid, flags \\ "FLAGS", flag_list)
requires the connection identifier. returns a parsed, structured response from the server.
unsubscribe(identifier, mailbox)
requires the connection identifier. returns a parsed, structured response from the server.