Module epop_client

Data Types

connection()

abstract datatype: connection()

retrieve_acc()

abstract datatype: retrieve_acc()

Function Index

accept/2 Accept a NOTIFY connection from an Epop server.
accept/3Accept a NOTIFY connection from an Epop server.
bin_retrieve/2 Get specified mail.
capa/1 Get list of capabilities.
connect/2 Set up a connection to a POP3 server using the specified UserId and Passwd.
connect/3Set up a connection to a POP3 server using the specified UserId, Passwd and Options.
delete/2 Mark mail for deletion.
noop/1 Send a NOOP request.
notify/3 Order notification.
quit/1 Quit the session.
reset/1 Remove all delete marks made in this session.
retrieve/2 Get specified mail.
retrieve_after/1 Finish get mail line-by-line.
retrieve_next/1 Get mail next line.
retrieve_resource_functions/2 Return Stream for the specified mail.
retrieve_resource_functions/3 Return Stream for the specified mail.
retrieve_start/2 Start get mail line-by-line.
retrieve_start/3 Start get mail line-by-line.
scan/1 Send a scan list request.
scan/2 Send a scan list request.
stat/1 Send a STAT request.
top/3 Get mail top lines.
uidl/1 Send a UIDL request.
uidl/2 Send a UIDL request.

Function Details

accept/2

accept(Lsock, Passwd) -> any()

Accept a NOTIFY connection from an Epop server

accept/3

accept(Lsock, Passwd, Options) -> any()

Accept a NOTIFY connection from an Epop server

bin_retrieve/2

bin_retrieve(S, MsgNum) -> any()

Get specified mail

capa/1

capa(S) -> any()

Get list of capabilities

connect/2

connect(User, Passwd) -> any()

Set up a connection to a POP3 server using the specified UserId and Passwd.

connect/3

connect(User, Passwd, Options) -> any()

Set up a connection to a POP3 server using the specified UserId, Passwd and Options.

delete/2

delete(S, MsgNum) -> any()

Mark mail for deletion

noop/1

noop(S) -> any()

Send a NOOP request

notify/3

notify(S, Host, PortNo) -> any()

Order notification. NB: This is my little extension of the POP3 protocol

quit/1

quit(S) -> any()

Quit the session

reset/1

reset(S) -> any()

Remove all delete marks made in this session

retrieve/2

retrieve(S, MsgNum) -> any()

Get specified mail

retrieve_after/1

retrieve_after(Acc::retrieve_acc()) -> ok

Finish get mail line-by-line

retrieve_next/1

retrieve_next(Acc::retrieve_acc()) -> {halt, retrieve_acc()} | {string(), retrieve_acc()}

Get mail next line

retrieve_resource_functions/2

retrieve_resource_functions(S, MsgNum) -> any()

Return Stream for the specified mail.

In Elixir: mailstream = apply(Stream, :resource, :epop_client.retrieve_resource_functions(client, 1))

retrieve_resource_functions/3

retrieve_resource_functions(S, MsgNum, EOL) -> any()

Return Stream for the specified mail.

retrieve_start/2

retrieve_start(S, MsgNum) -> any()

Start get mail line-by-line

retrieve_start/3

retrieve_start(S, MsgNum, Eol) -> any()

Start get mail line-by-line

scan/1

scan(S) -> any()

Send a scan list request

scan/2

scan(S, Num) -> any()

Send a scan list request

stat/1

stat(S) -> any()

Send a STAT request

top/3

top(S, MsgNum, Lines) -> any()

Get mail top lines

uidl/1

uidl(S) -> any()

Send a UIDL request

uidl/2

uidl(S, Num) -> any()

Send a UIDL request


Generated by EDoc