ContextQMD
Back to Zulip

Message a channel by email

starlight_help/src/content/docs/message-a-channel-by-email.mdx

12.03.6 KB
Original Source

import FlattenedSteps from "../../components/FlattenedSteps.astro"; import NavigationSteps from "../../components/NavigationSteps.astro"; import ZulipNote from "../../components/ZulipNote.astro"; import ZulipTip from "../../components/ZulipTip.astro"; import ChannelSettingsNavbarTip from "../include/_ChannelSettingsNavbarTip.mdx"; import SelectChannelViewGeneral from "../include/_SelectChannelViewGeneral.mdx";

<ZulipTip> This feature is not available on self-hosted Zulip servers where the [incoming email gateway][email-gateway] has not been configured by a system administrator. </ZulipTip>

You can send emails to Zulip channels. This can be useful:

  • If you have an email that you want to discuss on Zulip
  • For mirroring mailing list traffic
  • For integrating a third-party app that can send emails, but which does not easily lend itself to a more direct integration

If you're planning on doing this in an automated way, and have some programming experience, another option is to use our send message API.

Message a channel by email

<ZulipNote> You will see the button to generate an email address only if you have permission to send messages to this channel. </ZulipNote> <FlattenedSteps> <NavigationSteps target="relative/gear/channel-settings" />
  1. Select a channel.
<SelectChannelViewGeneral />
  1. Under Settings, click Generate email address.
  2. Select Who should be the sender of the Zulip messages for this email address.
  3. Toggle the configuration options as desired.
  4. Click Copy address to add the channel email address to your clipboard.
  5. Send an email to that address. </FlattenedSteps>
<ChannelSettingsNavbarTip />

The email subject will become the Zulip topic, and the email body will become the Zulip message.

Note that it may take up to one minute for the message to show up in Zulip.

Configuration options

You can configure who should be the sender of the Zulip messages for the generated email address, with the following options:

  • Email Gateway bot: This option makes it easy to see that the message was sent via email.
  • You: Messages will look the same as messages you send from the Zulip UI.
  • Any bot you own

The following options control which parts of the email are included in the Zulip message.

  • The sender's email address: Adds From: <Sender email address> to the top of the Zulip message.
  • Email footers: By default, Zulip tries to automatically remove some footer text (like signatures). With this option enabled, Zulip will include all footers.
  • Quoted original email: In many email clients, when you reply to a message (e.g., a message notification email), a copy of the original message is automatically added to the bottom of your reply. By default, Zulip tries to remove that copied message. With this option enabled, Zulip will include it.
  • Use html encoding: The body of an email is typically encoded using one or both of two common formats: plain text (text/plain) and HTML (text/html). Zulip supports constructing the Zulip message content using either (converting HTML to Markdown for the HTML format). By default, Zulip will prefer using the plain text version of an email over the converted HTML version if both are present. Enabling this option overrides that behavior to prefer the HTML version instead.