Struct sendgrid_api::subusers_api::SubusersApi

pub struct SubusersApi {
    pub client: Client,
}

Fields

client: Client

Implementations

impl SubusersApi

pub async fn get_subusers(
    &self,
    username: &str,
    limit: i64,
    offset: i64
) -> Result<Vec<Subuser>>

List all Subusers.

This function performs a GET to the /subusers endpoint.

This endpoint allows you to retrieve a list of all of your subusers.

You can choose to retrieve specific subusers as well as limit the results that come back from the API.

Parameters:

• username: &str – The license key provided with your New Relic account.
• limit: i64 – The number of results you would like to get in each request.
• offset: i64 – The number of subusers to skip.

pub async fn get_all_subusers(
    &self,
    username: &str,
    limit: i64,
    offset: i64
) -> Result<Vec<Subuser>>

List all Subusers.

This function performs a GET to the /subusers endpoint.

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

This endpoint allows you to retrieve a list of all of your subusers.

You can choose to retrieve specific subusers as well as limit the results that come back from the API.

pub async fn post_subuser(
    &self,
    body: &PostSubusersRequest
) -> Result<SubuserPost>

Create Subuser.

This function performs a POST to the /subusers endpoint.

This endpoint allows you to create a new subuser.

pub async fn delete_subusers_subuser_name(
    &self,
    subuser_name: &str
) -> Result<Help>

Delete a subuser.

This function performs a DELETE to the /subusers/{subuser_name} endpoint.

This endpoint allows you to delete a subuser.

This is a permanent action. Once deleted, a subuser cannot be retrieved.

pub async fn patch_subusers_subuser_name(
    &self,
    subuser_name: &str,
    body: &PatchSubusersSubuserNameRequest
) -> Result<Help>

Enable/disable a subuser.

This function performs a PATCH to the /subusers/{subuser_name} endpoint.

This endpoint allows you to enable or disable a subuser.

pub async fn get_subusers_reputations(
    &self,
    usernames: &str
) -> Result<Vec<GetSubusersReputationsResponse>>

Retrieve Subuser Reputations.

This function performs a GET to the /subusers/reputations endpoint.

This endpoint allows you to request the reputations for your subusers.

Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating.

Parameters:

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

pub async fn get_all_subusers_reputations(
    &self,
    usernames: &str
) -> Result<Vec<GetSubusersReputationsResponse>>

Retrieve Subuser Reputations.

This function performs a GET to the /subusers/reputations endpoint.

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

This endpoint allows you to request the reputations for your subusers.

Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating.

pub async fn put_subusers_subuser_name_ips(
    &self,
    subuser_name: &str,
    body: &[Ipv4Addr]
) -> Result<PutSubusersSubuserNameIpsResponse>

Update IPs assigned to a subuser.

This function performs a PUT to the /subusers/{subuser_name}/ips endpoint.

This endpoint allows you update your subusers’ assigned IP.

Each subuser should be assigned to an IP address from which all of this subuser’s mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well.

More information:

• How to request more IPs
• Setup Reverse DNS