clojure-mail.core

Liking cljdoc? Tell your friends :D

Clojure only.

store^clj

all-messages^clj

(all-messages folder-name)

(all-messages store folder-name & {:keys [since-uid]})

Given a store and folder returns all messages reversed so the newest messages come first. If since-uid is provided, return all messages with newer or equal uid

Given a store and folder returns all messages
 reversed so the newest messages come first. 
If since-uid is provided, return all messages with newer or equal uid

source raw docstring

as-properties^clj

(as-properties m)

source

close-store^clj

(close-store s)

Close an open IMAP store connection

Close an open IMAP store connection

source raw docstring

connected?^clj

(connected? s)

Returns true if a connection is established

Returns true if a connection is established

source raw docstring

dump^clj

(dump msgs)

Handy function that dumps out a batch of emails to disk

Handy function that dumps out a batch of emails to disk

source raw docstring

file->message^clj

(file->message path-to-message)

read a downloaded mail message in the same format as you would find on the mail server. This can be used to read saved messages from text files and for parsing fixtures in tests etc

read a downloaded mail message in the same format
as you would find on the mail server. This can
be used to read saved messages from text files
and for parsing fixtures in tests etc

source raw docstring

folder-permissions^clj

source

folders^clj

(folders store)

(folders store f)

Returns a seq of all IMAP folders inlcuding sub folders

Returns a seq of all IMAP folders inlcuding sub folders

source raw docstring

get-default-folder^clj

(get-default-folder s)

source

get-folder^clj

(get-folder s name)

Return the Folder object corresponding to the given name.

Return the Folder object corresponding to the given name.

source raw docstring

get-folder-uid-validity^clj

(get-folder-uid-validity folder)

Return the Folder UIDValidity

Return the Folder UIDValidity

source raw docstring

get-session^clj

(get-session protocol)

source

inbox^clj

(inbox)

(inbox store)

Get n messages from your inbox

Get n messages from your inbox

source raw docstring

mark-all-read^clj

(mark-all-read folder-name)

(mark-all-read store folder-name)

Mark all messages in folder as read

Mark all messages in folder as read

source raw docstring

message-count^clj

(message-count folder-name)

(message-count store folder-name)

Returns the number of messages in a folder

Returns the number of messages in a folder

source raw docstring

open-folder^clj

(open-folder folder-name perm-level)

(open-folder store folder-name perm-level)

Open and return a folder. A folder-name is string (usually a label name)

Open and return a folder.
A folder-name is string (usually a label name)

source raw docstring

save-message-to-file^clj

(save-message-to-file message)

source

search-inbox^clj

(search-inbox store term)

Search your inbox for a specific term Returns a vector of IMAPMessage objects

Search your inbox for a specific term
Returns a vector of IMAPMessage objects

source raw docstring

server->host-port^clj

(server->host-port protocol server)

Given a protocol ("imap" or "imaps") and a server that can be

a String with the hostname
a vector of the form [hostname, port]

It returns a vector [host, port] using the protocol well-known ports if required.

Given a protocol (`"imap"` or `"imaps"`) and a `server` that can be

* a `String` with the hostname
* a `vector` of the form `[hostname, port]`

It returns a vector `[host, port]` using the `protocol` well-known
ports if required.

source raw docstring

store^clj

(store server email pass)

(store protocol server email pass)

(store protocol session server email pass)

A store models a message store and its access protocol, for storing and retrieving messages. The server parameter can be a String with the hostname or a vector like [^String hostname ^int port]. The first form will make the connection use the default ports for the defined protocol.

A store models a message store and its access protocol,
for storing and retrieving messages.
The `server` parameter can be a String with the hostname or
a vector like [^String hostname ^int port]. The first form will
make the connection use the default ports for the defined
`protocol`.

source raw docstring

sub-folder?^clj

Check if a folder is a sub folder

Check if a folder is a sub folder

source raw docstring

unread-messages^clj

(unread-messages folder-name)

(unread-messages store folder-name)

Find unread messages

Find unread messages

source raw docstring

user-flags^clj

(user-flags message)

source

with-store^cljmacro

(with-store s & body)

Takes a store which has been connected, and binds to to store within the scope of the form.

Usage:

user> (with-store (gmail-store "username@gmail.com" "password") (read-messages :inbox 5)) ;=>

Takes a store which has been connected, and binds to to *store* within the
scope of the form.

**Usage:**

 user> (with-store (gmail-store "username@gmail.com" "password")
         (read-messages :inbox 5))
 ;=>

source raw docstring

xoauth2-store^clj

(xoauth2-store server email oauth-token)

(xoauth2-store protocol server email oauth-token)

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close