zulip/templates/zerver/help/advanced-search-for-message...

4.6 KiB

Advanced search for messages

In Zulip, you can find specific messages by using the search bar (highlighted in red in the image below) at the top of your screen. This feature allows you to narrow your view to show specific messages using search constraints called operators.

Search bar

Operators are short phrases in the format operator:operand where operand represents the criteria that fits the specified operator. Operators allow you to instantly find messages that meet the specified criteria, such as messages that belong to a specific stream or topic.

It is important to note that spaces in operand must be replaced with +. In addition, multiple search operators can be used in a single query by separating each operator with spaces in your search bar. Most importantly, you can search an individual stream for results from before you joined, but search results will only include messages from after you first joined Zulip if you search the entire realm.

Search operators

Listed below are all Zulip search operators.

  • stream:foobar - This operator narrows the view to show only messages in the stream foobar
  • topic:foo+bar - This operator narrows the view to show only messages with the topic foo bar. It is important to note that the complete topic name must be entered, or no results will be shown.
  • pm-with:foo@bar.com - This operator narrows the view to show only private messages sent from the user with the email address foo@bar.com.
  • sender:foo@bar.com - This operator narrows the view to show all messages sent by the user with the email address foo@bar.com.
  • sender:me - This operator narrows the view to show all messages sent by you.
  • near:xxxxx - This operator narrows the view to show the message with the ID xxxxx as well as a few messages sent before and after the message.
  • id:xxxxx - This operator narrows the view to show only the message with the ID xxxxx.
  • is:alerted - This operator narrows the view to show messages with alert words. You can add custom alert words in the Settings tab.
  • is:mentioned - This operator narrows the view to show messages that mention you.
  • is:private - This operator narrows the view to show all private messages that you've received.
  • is:starred - This operator narrows the view to show all messages that you've starred.
  • has:link - This operator narrows the view to show all messages that contain any links.
  • has:image - This operator narrows the view to show all messages that contain any images.
  • has:attachment - This operator narrows the view to show all messages that contain any attachments or uploads.
  • keyword - This operator narrows the view to show all messages containing the keyword.
  • key phrase - This operator narrows the view to show all messages containing all of the words in key phrase.
  • "key phrase" - This operator narrows the view to show all messages containing the exact phrase key phrase. (The difference between keyword, key phrase and "key phrase" is better explained below)
  • -topic:foobar - This operator narrows the view to exclude messages with the topic foobar

Difference between keyword, key phrase and "key phrase"

  • keyword is an operator that consists of one word. It narrows the view to show all the messages that contain that one word.
  • key phrase is an operator that consists of multiple words. It narrows the view to show all the messages that contain all of the words in that phrase, regardless of the order.
  • "key phrase" is an operator that consists of multiple words surrounded by quotation marks ( " ). It narrows the view to show all the messages that contain the key phrase in the exact same order.

Example

If we had 3 messages, "Cheese", "I like cheese" and "Like cheese I", the operator cheese would show all of the messages, the operator I like cheese would only show "I like cheese" and "Like cheese I" and the operator "I like cheese" would only show the message "I like cheese".

Keyboard shortcuts

Listed below are some Zulip keyboard shortcuts that will aid you in conducting a search.

  • Initiate a search / - This shortcut moves the user's cursor to the message search bar at the top of the window to allow them to begin searching for messages belonging to a specific topic, stream, view, etc. in the realm.
  • Clear a search Esc - This shortcut clears the search bar of any search criteria that was previously entered. This action can also be achieved by clicking the x (x) icon in the right side of the search bar.