Mailroom v0.2.4 Mailroom.IMAP View Source
Handles communication with a IMAP server.
Example:
{:ok, client} = Mailroom.IMAP.connect("imap.server", "username", "password")
client
|> Mailroom.IMAP.list
|> Enum.each(fn(mail)) ->
message =
client
|> Mailroom.IMAP.retrieve(mail)
|> Enum.join("\n")
# … process message
Mailroom.IMAP.delete(client, mail)
end)
Mailroom.IMAP.reset(client)
Mailroom.IMAP.close(client)
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Connect to the IMAP server
Fetches the items for the specified message or range of messages
Options
:timeout
- (integer) number of milliseconds before terminating the idle command if no update has been received. Defaults to1_500_00
(25 minutes)
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
Connect to the IMAP server
The following options are available:
ssl
- defaultfalse
, connect via SSL or notport
- default110
(995
if SSL), the port to connect totimeout
- default15_000
, the timeout for connection and communication
Examples:
Mailroom.IMAP.connect("imap.server", "me", "secret", ssl: true)
{:ok, pid}
Fetches the items for the specified message or range of messages
Examples:
> IMAP.fetch(client, 1, [:uid])
#…
> IMAP.fetch(client, 1..3, [:fast, :uid])
#…
Options
:timeout
- (integer) number of milliseconds before terminating the idle command if no update has been received. Defaults to1_500_00
(25 minutes)
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.