Struct IpPools

pub struct IpPools {
    pub client: Client,
}

Fields

client: Client

Implementations

impl IpPools

pub async fn get_ips_pools( &self, ) -> Result<Response<Vec<IpPoolsPoolResp>>, ClientError>

Retrieve all IP pools.

This function performs a GET to the /ips/pools endpoint.

This endpoint allows you to get all of your IP pools.

pub async fn get_all_ips_pools( &self, ) -> Result<Response<Vec<IpPoolsPoolResp>>, ClientError>

Retrieve all IP pools.

This function performs a GET to the /ips/pools endpoint.

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

This endpoint allows you to get all of your IP pools.

pub async fn post_ips_pool( &self, body: &IpPool, ) -> Result<Response<IpPoolsPoolResp>, ClientError>

Create an IP pool.

This function performs a POST to the /ips/pools endpoint.

This endpoint allows you to create an IP pool.

Before you can create an IP pool, you need to activate the IP in your SendGrid account:

1. Log into your SendGrid account.
2. Navigate to Settings and then select IP Addresses.
3. Find the IP address you want to activate and then click Edit.
4. Check Allow my account to send mail using this IP address.
5. Click Save.

pub async fn post_ips_pools_pool_name_ip( &self, pool_name: &str, body: &PostIpsWarmupRequest, ) -> Result<Response<GetIpsAssignedResponse>, ClientError>

Add an IP address to a pool.

This function performs a POST to the /ips/pools/{pool_name}/ips endpoint.

This endpoint allows you to add an IP address to an IP pool.

You can add the same IP address to multiple pools. It may take up to 60 seconds for your IP address to be added to a pool after your request is made.

Before you can add an IP to a pool, you need to activate it in your SendGrid account:

1. Log into your SendGrid account.
2. Navigate to Settings and then select IP Addresses.
3. Find the IP address you want to activate and then click Edit.
4. Check Allow my account to send mail using this IP address.
5. Click Save.

You can retrieve all of your available IP addresses from the “Retrieve all IP addresses” endpoint.

pub async fn get_ips_pools_pool_name( &self, pool_name: &str, ) -> Result<Response<GetIpsPoolsPoolNameResponse>, ClientError>

Retrieve all the IPs in a specified pool.

This function performs a GET to the /ips/pools/{pool_name} endpoint.

This endpoint allows you to get all of the IP addresses that are in a specific IP pool.

pub async fn put_ips_pools_pool_name( &self, pool_name: &str, body: &PutIpsPoolsPoolNameRequest, ) -> Result<Response<IpPoolsPoolResp>, ClientError>

Rename an IP pool.

This function performs a PUT to the /ips/pools/{pool_name} endpoint.

This endpoint allows you to update the name of an IP pool.

pub async fn delete_ips_pools_pool_name( &self, pool_name: &str, ) -> Result<Response<Help>, ClientError>

Delete an IP pool.

This function performs a DELETE to the /ips/pools/{pool_name} endpoint.

This endpoint allows you to delete an IP pool.

pub async fn delete_ips_pools_pool_name_ip( &self, pool_name: &str, ip: &str, ) -> Result<Response<Help>, ClientError>

Remove an IP address from a pool.

This function performs a DELETE to the /ips/pools/{pool_name}/ips/{ip} endpoint.

This endpoint allows you to remove an IP address from an IP pool.