copy#5

declare %an:sequential function imap:copy(
    $host-info as element(email:hostInfo),
    $mailbox-from as xs:string,
    $mailbox-to as xs:string,
    $messages as xs:long+,
    $uid as xs:boolean?
) as empty-sequence()

Copies messages between mailboxes. Depending on the value of $uid, the messages are either specified through their sequence number or through their unique id. Both mailboxes must exist.

create#2

declare %an:sequential function imap:create(
    $host-info as element(email:hostInfo),
    $mailbox-name as xs:string
) as empty-sequence()

Creates a new mailbox for the given user.

delete#2

declare %an:sequential function imap:delete(
    $host-info as element(email:hostInfo),
    $mailbox-name as xs:string
) as empty-sequence()

Deletes a mailbox for the given user.

expunge#2

declare %an:sequential function imap:expunge(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string
) as empty-sequence()

Permanently deletes all messages of the given mailbox that have the "deleted" flag set.

fetch-envelope#4

declare %an:nondeterministic function imap:fetch-envelope(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long,
    $uid as xs:boolean?
) as element(email:envelope)

Fetches the envelope of a message.

fetch-flags#4

declare %an:nondeterministic function imap:fetch-flags(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long,
    $uid as xs:boolean?
) as element(email:flags)

Fetches the flags of a message.

fetch-from#3

declare %an:nondeterministic function imap:fetch-from(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long
) as xs:string

Fetches the 'from' string of a message. Please note that this function only words with message sequence numbers, not with unique identifiers. Only the first 255 characters of a 'from' string are fetched.

fetch-message-sequence-number#3

declare %an:nondeterministic function imap:fetch-message-sequence-number(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long
) as xs:long

Fetches the message sequence number for a given unique identifier.

fetch-message#4

declare %an:nondeterministic function imap:fetch-message(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long,
    $uid as xs:boolean
) as element(email:message)

Fetches a whole message.

fetch-subject#3

declare %an:nondeterministic function imap:fetch-subject(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long
) as xs:string

Fetches the subject for a message. Please note that this function only works with message sequence numbers, not with unique identifiers. Only the first 255 characters of a subject are fetched.

fetch-uid#3

declare %an:nondeterministic function imap:fetch-uid(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long
) as xs:long

Fetches the unique identifier for a given message sequence number.

list#4

declare %an:nondeterministic function imap:list(
    $host-info as element(email:hostInfo),
    $mailbox-ref as xs:string,
    $pattern as xs:string,
    $only-subscribed as xs:boolean
) as element(email:mailbox)*

Lists IMAP folders for the specified user on the host that match the pattern.

move#5

declare %an:sequential function imap:move(
    $host-info as element(email:hostInfo),
    $mailbox-from as xs:string,
    $mailbox-to as xs:string,
    $messages as xs:long+,
    $uid as xs:boolean?
) as empty-sequence()

Moves messages between mailboxes. Depending on the value of $uid, the messages are either specified through their sequence number or through their unique id. Both mailboxes must exist.

rename#3

declare %an:sequential function imap:rename(
    $host-info as element(email:hostInfo),
    $mailbox-old as xs:string,
    $mailbox-new as xs:string
) as empty-sequence()

Renames a mailbox.

search#4

declare %an:nondeterministic function imap:search(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $criteria as xs:string,
    $uid as xs:boolean?
) as xs:long*

Searches a mailbox for messages that match the given criteria. The criteria should be a string as defined in the RFC3501 (IMAP4rev1). A valid example would be: 'FROM zorba@gmail.com OR NOT SUBJECT Bug'. Depending on the value of $uid, the function will either return matching sequence numbers or unique identifiers.

set-flags#5

declare %an:sequential function imap:set-flags(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string,
    $message-number as xs:long,
    $flags as element(email:flags),
    $uid as xs:boolean?
) as empty-sequence()

Sets the flags for a given message. The flags are set and unset according to the passed $flags.

status#2

declare %an:nondeterministic function imap:status(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string
) as element(email:status)

Returns the status of the given mailbox. The status of a mailbox contains:

• messages: the number of messages in the mailbox
• recent: the number of messages flagged as recent
• unseen: the number of messages flagged as unseen
• uidnext: the next unique identifier that will be assigned to a message
• uidvalidity: a value that, together with the uidnext value forms a 64 bit number that must be unique for the server

subscribe#2

declare %an:sequential function imap:subscribe(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string
) as empty-sequence()

Subscribes the user to the specified mailbox.

unsubscribe#2

declare %an:sequential function imap:unsubscribe(
    $host-info as element(email:hostInfo),
    $mailbox as xs:string
) as empty-sequence()

Unsubscribes the user from the specified mailbox.