- *store*
- all-messages
- as-properties
- close-store
- connected?
- dump
- file->message
- folder-permissions
- folders
- get-default-folder
- get-folder
- get-folder-uid-validity
- get-session
- inbox
- mark-all-read
- message-count
- open-folder
- save-message-to-file
- search-inbox
- server->host-port
- store
- sub-folder?
- unread-messages
- user-flags
- with-store
- xoauth2-store
clojure-mail.core
*store*clj
all-messagesclj
(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
as-propertiesclj
(as-properties m)close-storeclj
(close-store s)Close an open IMAP store connection
Close an open IMAP store connection
connected?clj
(connected? s)Returns true if a connection is established
Returns true if a connection is established
dumpclj
(dump msgs)Handy function that dumps out a batch of emails to disk
Handy function that dumps out a batch of emails to disk
file->messageclj
(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
folder-permissionsclj
foldersclj
(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
get-default-folderclj
(get-default-folder s)get-folderclj
(get-folder s name)Return the Folder object corresponding to the given name.
Return the Folder object corresponding to the given name.
get-folder-uid-validityclj
(get-folder-uid-validity folder)Return the Folder UIDValidity
Return the Folder UIDValidity
get-sessionclj
(get-session protocol)inboxclj
(inbox)(inbox store)Get n messages from your inbox
Get n messages from your inbox
mark-all-readclj
(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
message-countclj
(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
open-folderclj
(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)
save-message-to-fileclj
(save-message-to-file message)search-inboxclj
(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
server->host-portclj
(server->host-port protocol server)Given a protocol ("imap" or "imaps") and a server that can be
- a
Stringwith the hostname - a
vectorof 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.
storeclj
(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`.
unread-messagesclj
(unread-messages folder-name)(unread-messages store folder-name)Find unread messages
Find unread messages
user-flagsclj
(user-flags message)with-storecljmacro
(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))
;=> xoauth2-storeclj
(xoauth2-store server email oauth-token)(xoauth2-store protocol server email oauth-token)cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close