Skip to content
Keboola User Documentation
Components

IMAP Query Syntax

To combine multiple keywords enclose the query in brackets, e.g. the following matchess all unseen emails received from address sender-email@example.com with subject the subject: (FROM "sender-email@example.com" SUBJECT "the subject" UNSEEN)

Keywords

Section titled “Keywords”

ALL

Section titled “ALL”
All messages in the mailbox; the default initial key for
ANDing.

ANSWERED

Section titled “ANSWERED”
Messages with the \Answered flag set.

BCC

Section titled “BCC”
Messages that contain the specified string in the envelope
structure's BCC field.

BEFORE

Section titled “BEFORE”
Messages whose internal date (disregarding time and timezone)
is earlier than the specified date.

BODY

Section titled “BODY”
Messages that contain the specified string in the body of the
message.

CC

Section titled “CC”
Messages that contain the specified string in the envelope
structure's CC field.

DELETED

Section titled “DELETED”
Messages with the \Deleted flag set.

DRAFT

Section titled “DRAFT”
Messages with the \Draft flag set.

FLAGGED

Section titled “FLAGGED”
Messages with the \Flagged flag set.

FROM

Section titled “FROM”
Messages that contain the specified string in the envelope
structure's FROM field.
Section titled “HEADER”
Messages that have a header with the specified field-name (as
defined in [RFC-2822]) and that contains the specified string
in the text of the header (what comes after the colon).  If the
string to search is zero-length, this matches all messages that
have a header line with the specified field-name regardless of
the contents.

KEYWORD

Section titled “KEYWORD”
Messages with the specified keyword flag set.

LARGER

Section titled “LARGER”
Messages with an [RFC-2822] size larger than the specified
number of octets.

NEW

Section titled “NEW”
Messages that have the \Recent flag set but not the \Seen flag.
This is functionally equivalent to "(RECENT UNSEEN)".

NOT

Section titled “NOT”
Messages that do not match the specified search key.

OLD

Section titled “OLD”
Messages that do not have the \Recent flag set.  This is
functionally equivalent to "NOT RECENT" (as opposed to "NOT
NEW").

ON

Section titled “ON”
Messages whose internal date (disregarding time and timezone)
is within the specified date.

OR

Section titled “OR”
Messages that match either search key.

RECENT

Section titled “RECENT”
Messages that have the \Recent flag set.

SEEN

Section titled “SEEN”
Messages that have the \Seen flag set.

SENTBEFORE

Section titled “SENTBEFORE”
Messages whose [RFC-2822] Date: header (disregarding time and
timezone) is earlier than the specified date.

SENTON

Section titled “SENTON”
Messages whose [RFC-2822] Date: header (disregarding time and
timezone) is within the specified date.

SENTSINCE

Section titled “SENTSINCE”
Messages whose [RFC-2822] Date: header (disregarding time and
timezone) is within or later than the specified date.

SINCE

Section titled “SINCE”
Messages whose internal date (disregarding time and timezone)
is within or later than the specified date.

SMALLER

Section titled “SMALLER”
Messages with an [RFC-2822] size smaller than the specified
number of octets.

SUBJECT

Section titled “SUBJECT”
Messages that contain the specified string in the envelope
structure's SUBJECT field.

TEXT

Section titled “TEXT”
Messages that contain the specified string in the header or
body of the message.

TO

Section titled “TO”
Messages that contain the specified string in the envelope
structure's TO field.

UID

Section titled “UID”
Messages with unique identifiers corresponding to the specified
unique identifier set.  Sequence set ranges are permitted.

UNANSWERED

Section titled “UNANSWERED”
Messages that do not have the \Answered flag set.

UNDELETED

Section titled “UNDELETED”
Messages that do not have the \Deleted flag set.

UNDRAFT

Section titled “UNDRAFT”
Messages that do not have the \Draft flag set.

UNFLAGGED

Section titled “UNFLAGGED”
Messages that do not have the \Flagged flag set.

UNKEYWORD

Section titled “UNKEYWORD”
Messages that do not have the specified keyword flag set.

UNSEEN

Section titled “UNSEEN”
Messages that do not have the \Seen flag set.
Ask Kai

Ask anything about Keboola — I'll search the docs and cite the pages I use.