Liking cljdoc? Tell your friends :D

clojure-mail.folder


build-search-termsclj

(build-search-terms query)
(build-search-terms query terms-so-far and-join)

This creates a search condition. Input is a sequence of message part conditions or flags or header conditions. Possible message part condititon is: (:from|:cc|:bcc|:to|:subject|:body) value or date condition. Date condition is: (:received-before|:received-after|:received-on|:sent-before|:sent-after|:sent-on) date. Header condition is: :header (header-name-string header-value, ...) Supported flags are: :answered?, :deleted?, :draft?, :recent?, :flagged? :seen?. Minus sign at the beginning of flag tests for negated flag value (ex. :-answered? not answered messages).

Terms on the same level is connected with and-ed, if value is a sequence, then those values are or-ed.

Examples: (:body "foo" :body "bar") - body should match both values. (:body ["foo" "bar"]) - body should match one of the values. (:body "foo" :from "john@exmaple.com") - body should match foo and email is sent by john.

This creates a search condition. Input is a sequence of message part conditions or flags or header conditions.
Possible message part condititon is: (:from|:cc|:bcc|:to|:subject|:body) value or date condition.
Date condition is: (:received-before|:received-after|:received-on|:sent-before|:sent-after|:sent-on) date. 
Header condition is: :header (header-name-string header-value, ...)
Supported flags are: :answered?, :deleted?, :draft?, :recent?, :flagged? :seen?. Minus sign at the beginning of flag tests for negated flag value (ex. :-answered? not answered messages).

Terms on the same level is connected with and-ed, if value is a sequence, then those values are or-ed. 
 
Examples: 
 (:body "foo" :body "bar") - body should match both values.
 (:body ["foo" "bar"]) - body should match one of the values.
 (:body "foo" :from "john@exmaple.com") - body should match foo and email is sent by john.
sourceraw docstring

current-folderclj

source

date-formatsclj

source

fetch-messagesclj

(fetch-messages f ms & {:keys [fetch-profile] :or {fetch-profile :message}})

Pre-fetch message attributes for a given fetch profile. Messages are retrieved as light weight objects and individual fields such as headers or body are populated lazily. When bulk fetching messages you can pre-fetch these items based on a com.sun.mail.imap.FetchProfileItem f - the folder from which to fetch the messages ms - the messages to fetch :fetch-profile - optional fetch profile, defaults to entire message. fetch profiles are:

:message
:headers
:flags
:envelope
:content-info
:size
Pre-fetch message attributes for a given fetch profile.
Messages are retrieved as light weight objects and individual fields such as headers or body are populated lazily.
When bulk fetching messages you can pre-fetch these items based on a com.sun.mail.imap.FetchProfileItem
f - the folder from which to fetch the messages
ms - the messages to fetch
:fetch-profile - optional fetch profile, defaults to entire message. fetch profiles are:

    :message
    :headers
    :flags
    :envelope
    :content-info
    :size
    
sourceraw docstring

full-nameclj

(full-name f)
source

get-folderclj

(get-folder store folder-name)

Returns an IMAPFolder instance

Returns an IMAPFolder instance
sourceraw docstring

get-messageclj

(get-message f id)
source

get-message-by-uidclj

(get-message-by-uid f id)
source

get-messagesclj

(get-messages folder)
(get-messages folder start end)

Gets all messages from folder f or get the Message objects for message numbers ranging from start through end, both start and end inclusive. Note that message numbers start at 1, not 0.

Gets all messages from folder f or get the Message objects for message numbers ranging from start through end,
both start and end inclusive. Note that message numbers start at 1, not 0.
sourceraw docstring

listclj

(list f)

List all folders under folder f

List all folders under folder f
sourceraw docstring

message-countclj

(message-count f)

Get total number of messages in folder f

Get total number of messages in folder f
sourceraw docstring

new-message-countclj

(new-message-count f)

Get number of new messages in folder f

Get number of new messages in folder f
sourceraw docstring

(search f & query)
source

to-dateclj

(to-date ds)

Parses a date string to date

Parses a date string to date
sourceraw docstring

to-date-comparisonclj

(to-date-comparison dt)

Returns the correct comparison term for search

Returns the correct comparison term for search
sourceraw docstring

to-flagclj

(to-flag fl)

Converts a string to message flag

Converts a string to message flag
sourceraw docstring

to-recipient-typeclj

(to-recipient-type rt)

Converts keyword to recipient type

Converts keyword to recipient type
sourceraw docstring

unread-message-countclj

(unread-message-count f)

Get number of unread messages in folder f

Get number of unread messages in folder f
sourceraw docstring

with-foldercljmacro

(with-folder folder store & body)
source

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

× close