Struct MailRules 

pub struct MailRules {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl MailRules

pub async fn list<'a>( &'a self, page: Option<i64>, page_size: Option<i64>, ) -> Result<PaginatedMailRuleList, Error>

Perform a GET request to /api/mail_rules/.

Parameters:

• page: Option<i64>: A page number within the paginated result set.
• page_size: Option<i64>: Number of results to return per page.

use futures_util::TryStreamExt;
async fn example_mail_rules_list_stream() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let mut mail_rules = client.mail_rules();
    let mut stream = mail_rules.list_stream(Some(4 as i64));
    loop {
        match stream.try_next().await {
            Ok(Some(item)) => {
                println!("{:?}", item);
            }
            Ok(None) => {
                break;
            }
            Err(err) => {
                return Err(err.into());
            }
        }
    }

    Ok(())
}

pub async fn create<'a>( &'a self, body: &MailRuleRequest, ) -> Result<MailRule, Error>

Perform a POST request to /api/mail_rules/.

async fn example_mail_rules_create() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::MailRule = client
        .mail_rules()
        .create(&paperless_api_client::types::MailRuleRequest {
            name: "some-string".to_string(),
            account: 4 as i64,
            enabled: Some(true),
            folder: Some("some-string".to_string()),
            filter_from: Some("some-string".to_string()),
            filter_to: Some("some-string".to_string()),
            filter_subject: Some("some-string".to_string()),
            filter_body: Some("some-string".to_string()),
            filter_attachment_filename_include: Some("some-string".to_string()),
            filter_attachment_filename_exclude: Some("some-string".to_string()),
            maximum_age: Some(4 as i64),
            action: Some(4 as i64),
            action_parameter: Some("some-string".to_string()),
            assign_title_from: Some(4 as i64),
            assign_tags: Some(vec![4 as i64]),
            assign_correspondent_from: Some(4 as i64),
            assign_correspondent: Some(4 as i64),
            assign_document_type: Some(4 as i64),
            assign_owner_from_rule: Some(true),
            order: Some(4 as i64),
            attachment_type: Some(4 as i64),
            consumption_scope: Some(4 as i64),
            pdf_layout: Some(4 as i64),
            owner: Some(4 as i64),
            set_permissions: Some(paperless_api_client::types::SetPermissions {
                view: Some(paperless_api_client::types::View {
                    users: Some(vec![4 as i64]),
                    groups: Some(vec![4 as i64]),
                }),
                change: Some(paperless_api_client::types::Change {
                    users: Some(vec![4 as i64]),
                    groups: Some(vec![4 as i64]),
                }),
            }),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn retrieve<'a>(&'a self, id: i64) -> Result<MailRule, Error>

Perform a GET request to /api/mail_rules/{id}/.

Parameters:

• id: i64: A unique integer value identifying this mail rule. (required)

async fn example_mail_rules_retrieve() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::MailRule = client.mail_rules().retrieve(4 as i64).await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn update<'a>( &'a self, id: i64, body: &MailRuleRequest, ) -> Result<MailRule, Error>

Perform a PUT request to /api/mail_rules/{id}/.

Parameters:

• id: i64: A unique integer value identifying this mail rule. (required)

async fn example_mail_rules_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::MailRule = client
        .mail_rules()
        .update(
            4 as i64,
            &paperless_api_client::types::MailRuleRequest {
                name: "some-string".to_string(),
                account: 4 as i64,
                enabled: Some(true),
                folder: Some("some-string".to_string()),
                filter_from: Some("some-string".to_string()),
                filter_to: Some("some-string".to_string()),
                filter_subject: Some("some-string".to_string()),
                filter_body: Some("some-string".to_string()),
                filter_attachment_filename_include: Some("some-string".to_string()),
                filter_attachment_filename_exclude: Some("some-string".to_string()),
                maximum_age: Some(4 as i64),
                action: Some(4 as i64),
                action_parameter: Some("some-string".to_string()),
                assign_title_from: Some(4 as i64),
                assign_tags: Some(vec![4 as i64]),
                assign_correspondent_from: Some(4 as i64),
                assign_correspondent: Some(4 as i64),
                assign_document_type: Some(4 as i64),
                assign_owner_from_rule: Some(true),
                order: Some(4 as i64),
                attachment_type: Some(4 as i64),
                consumption_scope: Some(4 as i64),
                pdf_layout: Some(4 as i64),
                owner: Some(4 as i64),
                set_permissions: Some(paperless_api_client::types::SetPermissions {
                    view: Some(paperless_api_client::types::View {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                    change: Some(paperless_api_client::types::Change {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                }),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn destroy<'a>(&'a self, id: i64) -> Result<(), Error>

Perform a DELETE request to /api/mail_rules/{id}/.

Parameters:

• id: i64: A unique integer value identifying this mail rule. (required)

async fn example_mail_rules_destroy() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    client.mail_rules().destroy(4 as i64).await?;
    Ok(())
}

pub async fn partial_update<'a>( &'a self, id: i64, body: &PatchedMailRuleRequest, ) -> Result<MailRule, Error>

Perform a PATCH request to /api/mail_rules/{id}/.

Parameters:

• id: i64: A unique integer value identifying this mail rule. (required)

async fn example_mail_rules_partial_update() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::MailRule = client
        .mail_rules()
        .partial_update(
            4 as i64,
            &paperless_api_client::types::PatchedMailRuleRequest {
                name: Some("some-string".to_string()),
                account: Some(4 as i64),
                enabled: Some(true),
                folder: Some("some-string".to_string()),
                filter_from: Some("some-string".to_string()),
                filter_to: Some("some-string".to_string()),
                filter_subject: Some("some-string".to_string()),
                filter_body: Some("some-string".to_string()),
                filter_attachment_filename_include: Some("some-string".to_string()),
                filter_attachment_filename_exclude: Some("some-string".to_string()),
                maximum_age: Some(4 as i64),
                action: Some(4 as i64),
                action_parameter: Some("some-string".to_string()),
                assign_title_from: Some(4 as i64),
                assign_tags: Some(vec![4 as i64]),
                assign_correspondent_from: Some(4 as i64),
                assign_correspondent: Some(4 as i64),
                assign_document_type: Some(4 as i64),
                assign_owner_from_rule: Some(true),
                order: Some(4 as i64),
                attachment_type: Some(4 as i64),
                consumption_scope: Some(4 as i64),
                pdf_layout: Some(4 as i64),
                owner: Some(4 as i64),
                set_permissions: Some(paperless_api_client::types::SetPermissions {
                    view: Some(paperless_api_client::types::View {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                    change: Some(paperless_api_client::types::Change {
                        users: Some(vec![4 as i64]),
                        groups: Some(vec![4 as i64]),
                    }),
                }),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for MailRules

fn clone(&self) -> MailRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MailRules

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

Formats the value using the given formatter.