Struct sendgrid_api::blocks_api::BlocksApi

pub struct BlocksApi {
    pub client: Client,
}

Fields

client: Client

Implementations

impl BlocksApi

pub async fn get_suppression_blocks(
    &self,
    start_time: i64,
    end_time: i64,
    limit: i64,
    offset: i64
) -> Result<Vec<BlocksResponse>>

Retrieve all blocks.

This function performs a GET to the /suppression/blocks endpoint.

This endpoint allows you to retrieve all email addresses that are currently on your blocks list.

Parameters:

• start_time: i64 – The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.
• end_time: i64 – The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.
• limit: i64 – Limit the number of results to be displayed per page.
• offset: i64 – The point in the list to begin displaying results.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_all_suppression_blocks(
    &self,
    start_time: i64,
    end_time: i64,
    limit: i64,
    offset: i64
) -> Result<Vec<BlocksResponse>>

Retrieve all blocks.

This function performs a GET to the /suppression/blocks endpoint.

As opposed to get_suppression_blocks, this function returns all the pages of the request at once.

This endpoint allows you to retrieve all email addresses that are currently on your blocks list.

pub async fn delete_suppression_blocks(
    &self,
    body: &DeleteSuppressionBlocksRequest
) -> Result<Help>

Delete blocks.

This function performs a DELETE to the /suppression/blocks endpoint.

This endpoint allows you to delete all email addresses on your blocks list.

There are two options for deleting blocked emails:

1. You can delete all blocked emails by setting delete_all to true in the request body.
2. You can delete a selection of blocked emails by specifying the email addresses in the emails array of the request body.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_suppression_blocks_email(
    &self,
    email: &str
) -> Result<Vec<BlocksResponse>>

Retrieve a specific block.

This function performs a GET to the /suppression/blocks/{email} endpoint.

This endpoint allows you to retrieve a specific email address from your blocks list.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_all_suppression_blocks_email(
    &self,
    email: &str
) -> Result<Vec<BlocksResponse>>

Retrieve a specific block.

This function performs a GET to the /suppression/blocks/{email} endpoint.

As opposed to get_suppression_blocks_email, this function returns all the pages of the request at once.

This endpoint allows you to retrieve a specific email address from your blocks list.

pub async fn delete_suppression_blocks_email(&self, email: &str) -> Result<Help>

Delete a specific block.

This function performs a DELETE to the /suppression/blocks/{email} endpoint.

This endpoint allows you to delete a specific email address from your blocks list.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.