Struct Topics 

pub struct Topics<'a> { /* private fields */ }

Implementations

impl<'a> Topics<'a>

pub fn client(&self) -> &'a Client

The client this service sends through.

pub async fn empty_spam(&self) -> Result<(), Error>

Empty the spam box. Runs synchronously, so it can take a while on a large mailbox.

pub async fn empty_trash(&self) -> Result<(), Error>

Empty the trash. Runs synchronously, so it can take a while on a large mailbox.

pub async fn get(&self, topic_id: i64) -> Result<GetTopicResponseContent, Error>

Get a topic

pub async fn get_entries( &self, topic_id: i64, params: &GetTopicEntriesParams, ) -> Result<Page<GetTopicEntriesResponseContent>, Error>

Get entries for a topic

pub async fn get_everything( &self, params: &GetEverythingTopicsParams, ) -> Result<Page<GetEverythingTopicsResponseContent>, Error>

Get all topics (everything view)

pub async fn get_sent( &self, params: &GetSentTopicsParams, ) -> Result<Page<GetSentTopicsResponseContent>, Error>

Get sent topics

pub async fn get_spam( &self, params: &GetSpamTopicsParams, ) -> Result<Page<GetSpamTopicsResponseContent>, Error>

Get spam topics

pub async fn get_trash( &self, params: &GetTrashTopicsParams, ) -> Result<Page<GetTrashTopicsResponseContent>, Error>

Get trash topics

pub async fn mark_ham(&self, topic_id: i64) -> Result<(), Error>

Mark a spam topic as ham. Every other spam topic from the same sender is hammed too.

pub async fn move_topic( &self, topic_id: i64, body: &MoveTopicRequestContent, ) -> Result<(), Error>

Move a topic to another box.

Answers 204 without moving anything when the acting user has no posting for the topic.

pub async fn restore(&self, topic_id: i64) -> Result<(), Error>

Restore a topic from the trash or the catch-all

pub async fn trash( &self, topic_id: i64, params: &TrashTopicParams, ) -> Result<(), Error>

Trash a topic.

A shared topic redirects to the removal confirmation page unless confirm_destroy is set, so always pass it when trashing something that might be shared.

impl Topics<'_>

pub async fn move_to_box(&self, topic_id: i64, box_id: i64) -> Result<(), Error>

Moves a topic to a box, by the box’s id. The generated Topics::move_topic takes the request body; this takes the one thing it carries.

pub async fn trash_topic( &self, topic_id: i64, confirm_destroy: bool, ) -> Result<(), Error>

Trashes a topic.

HEY will not trash a shared topic without being asked twice: it answers the removal confirmation page instead, which comes back here as a usage error rather than as a trashing that quietly did nothing. Confirming trashes the topic and removes your access to it.

The generated Topics::trash sends the same request from its parts, and follows that redirect rather than reading it.