Struct Message

pub struct Message {

    pub(crate) id: MsgId,
    pub(crate) from_id: ContactId,
    pub(crate) to_id: ContactId,
    pub(crate) chat_id: ChatId,
    pub(crate) viewtype: Viewtype,
    pub(crate) state: MessageState,
    pub(crate) download_state: DownloadState,
    pub(crate) hidden: bool,
    pub(crate) timestamp_sort: i64,
    pub(crate) timestamp_sent: i64,
    pub(crate) timestamp_rcvd: i64,
    pub(crate) ephemeral_timer: Timer,
    pub(crate) ephemeral_timestamp: i64,
    pub(crate) text: String,
    pub(crate) subject: String,
    pub(crate) rfc724_mid: String,
    pub(crate) in_reply_to: Option<String>,
    pub(crate) is_dc_message: MessengerMessage,
    pub(crate) mime_modified: bool,
    pub(crate) chat_blocked: Blocked,
    pub(crate) location_id: u32,
    pub(crate) error: Option<String>,
    pub(crate) param: Params,
}

An object representing a single message in memory. The message object is not updated. If you want an update, you have to recreate the object.

Fields

id: MsgId

Message ID.

from_id: ContactId

From: contact ID.

to_id: ContactId

ID of the first contact in the To: header.

chat_id: ChatId

ID of the chat message belongs to.

viewtype: Viewtype

Type of the message.

state: MessageState

State of the message.

download_state: DownloadState

hidden: bool

Whether the message is hidden.

timestamp_sort: i64

timestamp_sent: i64

timestamp_rcvd: i64

ephemeral_timer: Timer

ephemeral_timestamp: i64

text: String

subject: String

Message subject.

If empty, a default subject will be generated when sending.

rfc724_mid: String

Message-ID header value.

in_reply_to: Option<String>

In-Reply-To header value.

is_dc_message: MessengerMessage

mime_modified: bool

chat_blocked: Blocked

location_id: u32

error: Option<String>

param: Params

Implementations

impl Message

pub fn download_state(&self) -> DownloadState

Returns the download state of the message.

impl Message

pub fn new(viewtype: Viewtype) -> Self

Creates a new message with given view type.

pub fn new_text(text: String) -> Self

Creates a new message with Viewtype::Text.

pub async fn load_from_db(context: &Context, id: MsgId) -> Result<Message>

Loads message with given ID from the database.

Returns an error if the message does not exist.

pub async fn load_from_db_optional( context: &Context, id: MsgId, ) -> Result<Option<Message>>

Loads message with given ID from the database.

Returns None if the message does not exist.

pub fn get_filemime(&self) -> Option<String>

Returns the MIME type of an attached file if it exists.

If the MIME type is not known, the function guesses the MIME type from the extension. application/octet-stream is used as a fallback if MIME type is not known, but None is only returned if no file is attached.

pub fn get_file(&self, context: &Context) -> Option<PathBuf>

Returns the full path to the file associated with a message.

pub async fn vcard_contacts( &self, context: &Context, ) -> Result<Vec<VcardContact>>

Returns vector of vcards if the file has a vCard attachment.

pub async fn save_file(&self, context: &Context, path: &Path) -> Result<()>

Save file copy at the user-provided path.

pub(crate) async fn try_calc_and_set_dimensions( &mut self, context: &Context, ) -> Result<()>

If message is an image or gif, set Param::Width and Param::Height

pub fn has_location(&self) -> bool

Check if a message has a POI location bound to it. These locations are also returned by location::get_range(). The UI may decide to display a special icon beside such messages.

pub fn set_location(&mut self, latitude: f64, longitude: f64)

Set any location that should be bound to the message object. The function is useful to add a marker to the map at a position different from the self-location. You should not call this function if you want to bind the current self-location to a message; this is done by location::set() and send_locations_to_chat().

Typically results in the event LocationChanged with contact_id set to ContactId::SELF.

latitude is the North-south position of the location. longitude is the East-west position of the location.

pub fn get_timestamp(&self) -> i64

Returns the message timestamp for display in the UI as a unix timestamp in seconds.

pub fn get_id(&self) -> MsgId

Returns the message ID.

pub fn rfc724_mid(&self) -> &str

Returns the rfc724 message ID May be empty

pub fn get_from_id(&self) -> ContactId

Returns the ID of the contact who wrote the message.

pub fn get_chat_id(&self) -> ChatId

Returns the chat ID.

pub fn get_viewtype(&self) -> Viewtype

Returns the type of the message.

pub fn force_sticker(&mut self)

Forces the message to keep Viewtype::Sticker e.g the message will not be converted to a Viewtype::Image.

pub fn get_state(&self) -> MessageState

Returns the state of the message.

pub fn get_received_timestamp(&self) -> i64

Returns the message receive time as a unix timestamp in seconds.

pub fn get_sort_timestamp(&self) -> i64

Returns the timestamp of the message for sorting.

pub fn get_text(&self) -> String

Returns the text of the message.

pub fn get_subject(&self) -> &str

Returns message subject.

pub fn get_filename(&self) -> Option<String>

Returns original filename (as shown in chat).

To get the full path, use Self::get_file().

pub async fn get_filebytes(&self, context: &Context) -> Result<Option<u64>>

Returns the size of the file in bytes, if applicable.

pub fn get_width(&self) -> i32

Returns width of associated image or video file.

pub fn get_height(&self) -> i32

Returns height of associated image or video file.

pub fn get_duration(&self) -> i32

Returns duration of associated audio or video file.

pub fn get_showpadlock(&self) -> bool

Returns true if padlock indicating message encryption should be displayed in the UI.

pub fn is_bot(&self) -> bool

Returns true if message is auto-generated.

pub fn get_ephemeral_timer(&self) -> EphemeralTimer

Return the ephemeral timer duration for a message.

pub fn get_ephemeral_timestamp(&self) -> i64

Returns the timestamp of the epehemeral message removal.

pub async fn get_summary( &self, context: &Context, chat: Option<&Chat>, ) -> Result<Summary>

Returns message summary for display in the search results.

pub fn get_override_sender_name(&self) -> Option<String>

Returns the name that should be shown over the message instead of the contact display ame.

pub(crate) fn get_sender_name(&self, contact: &Contact) -> String

pub fn has_deviating_timestamp(&self) -> bool

Returns true if a message has a deviating timestamp.

A message has a deviating timestamp when it is sent on another day as received/sorted by.

pub fn is_sent(&self) -> bool

Returns true if the message was successfully delivered to the outgoing server or even received a read receipt.

pub fn is_forwarded(&self) -> bool

Returns true if the message is a forwarded message.

pub fn is_info(&self) -> bool

Returns true if the message is an informational message.

pub fn get_info_type(&self) -> SystemMessage

Returns the type of an informational message.

pub fn is_system_message(&self) -> bool

Returns true if the message is a system message.

pub fn is_setupmessage(&self) -> bool

Returns true if the message is an Autocrypt Setup Message.

pub async fn get_setupcodebegin(&self, context: &Context) -> Option<String>

Returns the first characters of the setup code.

This is used to pre-fill the first entry field of the setup code.

pub(crate) fn create_webrtc_instance(instance: &str, room: &str) -> String

pub fn parse_webrtc_instance(instance: &str) -> (VideochatType, String)

split a webrtc_instance as defined by the corresponding config-value into a type and a url

pub fn get_videochat_url(&self) -> Option<String>

Returns videochat URL if the message is a videochat invitation.

pub fn get_videochat_type(&self) -> Option<VideochatType>

Returns videochat type if the message is a videochat invitation.

pub fn set_text(&mut self, text: String)

Sets or unsets message text.

pub fn set_subject(&mut self, subject: String)

Sets the email’s subject. If it’s empty, a default subject will be used (e.g. Message from Alice or Re: <last subject>).

pub fn set_file(&mut self, file: impl ToString, filemime: Option<&str>)

Sets the file associated with a message.

This function does not use the file or check if it exists, the file will only be used when the message is prepared for sending.

pub async fn set_file_from_bytes( &mut self, context: &Context, suggested_name: &str, data: &[u8], filemime: Option<&str>, ) -> Result<()>

Creates a new blob and sets it as a file associated with a message.

pub async fn make_vcard( &mut self, context: &Context, contacts: &[ContactId], ) -> Result<()>

Makes message a vCard-containing message using the specified contacts.

pub(crate) async fn try_set_vcard( &mut self, context: &Context, path: &Path, ) -> Result<()>

Updates message state from the vCard attachment.

pub fn set_override_sender_name(&mut self, name: Option<String>)

Set different sender name for a message. This overrides the name set by the set_config()-option displayname.

pub fn set_dimension(&mut self, width: i32, height: i32)

Sets the dimensions of associated image or video file.

pub fn set_duration(&mut self, duration: i32)

Sets the duration of associated audio or video file.

pub(crate) fn set_reaction(&mut self)

Marks the message as reaction.

pub async fn latefiling_mediasize( &mut self, context: &Context, width: i32, height: i32, duration: i32, ) -> Result<()>

Changes the message width, height or duration, and stores it into the database.

pub fn set_quote_text(&mut self, text: Option<(String, bool)>)

Sets message quote text.

If text is Some((text_str, protect)), protect specifies whether text_str should only be sent encrypted. If it should, but the message is unencrypted, text_str is replaced with “…”.

pub async fn set_quote( &mut self, context: &Context, quote: Option<&Message>, ) -> Result<()>

Sets message quote.

Message-Id is used to set Reply-To field, message text is used for quote.

Encryption is required if quoted message was encrypted.

The message itself is not required to exist in the database, it may even be deleted from the database by the time the message is prepared.

pub fn quoted_text(&self) -> Option<String>

Returns quoted message text, if any.

pub async fn quoted_message(&self, context: &Context) -> Result<Option<Message>>

Returns quoted message, if any.

pub async fn parent(&self, context: &Context) -> Result<Option<Message>>

Returns parent message according to the In-Reply-To header if it exists in the database and is not trashed.

References header is not taken into account.

pub fn force_plaintext(&mut self)

Force the message to be sent in plain text.

pub async fn update_param(&self, context: &Context) -> Result<()>

Updates param column of the message in the database without changing other columns.

pub(crate) async fn update_subject(&self, context: &Context) -> Result<()>

pub fn error(&self) -> Option<String>

Gets the error status of the message.

A message can have an associated error status if something went wrong when sending or receiving message itself. The error status is free-form text and should not be further parsed, rather it’s presence is meant to indicate something went wrong with the message and the text of the error is detailed information on what.

Some common reasons error can be associated with messages are:

• Lack of valid signature on an e2ee message, usually for received messages.
• Failure to decrypt an e2ee message, usually for received messages.
• When a message could not be delivered to one or more recipients the non-delivery notification text can be stored in the error status.

impl Message

fn webxdc_integrated_for(&self) -> Option<ChatId>

pub(crate) async fn is_set_as_webxdc_integration( &self, context: &Context, ) -> Result<bool>

impl Message

async fn get_webxdc_archive(&self, context: &Context) -> Result<FsZipFileReader>

Get handle to a webxdc ZIP-archive. To check for file existence use archive.by_name(), to read a file, use get_blob(archive).

pub async fn get_webxdc_blob( &self, context: &Context, name: &str, ) -> Result<Vec<u8>>

Return file from inside an archive. Currently, this works only if the message is an webxdc instance.

name is the filename within the archive, e.g. index.html.

pub async fn get_webxdc_info(&self, context: &Context) -> Result<WebxdcInfo>

Return info from manifest.toml or from fallbacks.

async fn get_webxdc_self_addr(&self, context: &Context) -> Result<String>

pub fn get_webxdc_href(&self) -> Option<String>

Get link attached to an info message.

The info message needs to be of type SystemMessage::WebxdcInfoMessage. Typically, this is used to start the corresponding webxdc app with window.location.href set in JS land.

impl Message

pub fn has_html(&self) -> bool

Check if the message can be retrieved as HTML. Typically, this is the case, when the mime structure of a Message is modified, meaning that some text is cut or the original message is in HTML and simplify() may hide some maybe important information. The corresponding ffi-function is dc_msg_has_html(). To get the HTML-code of the message, use MsgId.get_html().

pub fn set_html(&mut self, html: Option<String>)

Set HTML-part part of a message that is about to be sent. The HTML-part is written to the database before sending and used as the text/html part in the MIME-structure.

Received HTML parts are handled differently, they are saved together with the whole MIME-structure in mime_headers and the HTML-part is extracted using MsgId::get_html(). (To underline this asynchronicity, we are using the wording “SendHtml”)

impl Message

pub(crate) async fn get_summary_text(&self, context: &Context) -> String

Returns a summary text.

async fn get_summary_text_without_prefix(&self, context: &Context) -> String

Returns a summary text without “Forwarded:” prefix.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Message

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Message

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.