Search Results for

    Show / Hide Table of Contents

    Interface IBounceControllerApiSync

    Represents a collection of functions to interact with the API endpoints

    Inherited Members
    IApiAccessor.Configuration
    IApiAccessor.GetBasePath()
    IApiAccessor.ExceptionFactory
    Namespace: mailslurp.Api
    Assembly: mailslurp.dll
    Syntax
    public interface IBounceControllerApiSync : IApiAccessor

    Methods

    View Source

    FilterBouncedRecipient(FilterBouncedRecipientsOptions, int)

    Filter a list of email recipients and remove those who have bounced

    Declaration
    FilterBouncedRecipientsResult FilterBouncedRecipient(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    FilterBouncedRecipientsOptions filterBouncedRecipientsOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    FilterBouncedRecipientsResult

    FilterBouncedRecipientsResult

    Remarks

    Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    FilterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions, int)

    Filter a list of email recipients and remove those who have bounced

    Declaration
    ApiResponse<FilterBouncedRecipientsResult> FilterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    FilterBouncedRecipientsOptions filterBouncedRecipientsOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<FilterBouncedRecipientsResult>

    ApiResponse of FilterBouncedRecipientsResult

    Remarks

    Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAccountBounceBlockStatus(int)

    Can account send email

    Declaration
    AccountBounceBlockDto GetAccountBounceBlockStatus(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    AccountBounceBlockDto

    AccountBounceBlockDto

    Remarks

    Check if account block status prevents sending

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAccountBounceBlockStatusWithHttpInfo(int)

    Can account send email

    Declaration
    ApiResponse<AccountBounceBlockDto> GetAccountBounceBlockStatusWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<AccountBounceBlockDto>

    ApiResponse of AccountBounceBlockDto

    Remarks

    Check if account block status prevents sending

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedEmail(Guid, int)

    Get a bounced email.

    Declaration
    BouncedEmailDto GetBouncedEmail(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of the bounced email to fetch

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    BouncedEmailDto

    BouncedEmailDto

    Remarks

    Bounced emails are email you have sent that were rejected by a recipient

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedEmails(int?, int?, string, DateTime?, DateTime?, int)

    Get paginated list of bounced emails.

    Declaration
    PageBouncedEmail GetBouncedEmails(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageBouncedEmail

    PageBouncedEmail

    Remarks

    Bounced emails are email you have sent that were rejected by a recipient

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedEmailsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

    Get paginated list of bounced emails.

    Declaration
    ApiResponse<PageBouncedEmail> GetBouncedEmailsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageBouncedEmail>

    ApiResponse of PageBouncedEmail

    Remarks

    Bounced emails are email you have sent that were rejected by a recipient

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedEmailWithHttpInfo(Guid, int)

    Get a bounced email.

    Declaration
    ApiResponse<BouncedEmailDto> GetBouncedEmailWithHttpInfo(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of the bounced email to fetch

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<BouncedEmailDto>

    ApiResponse of BouncedEmailDto

    Remarks

    Bounced emails are email you have sent that were rejected by a recipient

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedRecipient(Guid, int)

    Get a bounced email.

    Declaration
    BouncedRecipientDto GetBouncedRecipient(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of the bounced recipient

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    BouncedRecipientDto

    BouncedRecipientDto

    Remarks

    Bounced emails are email you have sent that were rejected by a recipient

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedRecipients(int?, int?, string, DateTime?, DateTime?, int)

    Get paginated list of bounced recipients.

    Declaration
    PageBouncedRecipients GetBouncedRecipients(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageBouncedRecipients

    PageBouncedRecipients

    Remarks

    Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedRecipientsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

    Get paginated list of bounced recipients.

    Declaration
    ApiResponse<PageBouncedRecipients> GetBouncedRecipientsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageBouncedRecipients>

    ApiResponse of PageBouncedRecipients

    Remarks

    Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetBouncedRecipientWithHttpInfo(Guid, int)

    Get a bounced email.

    Declaration
    ApiResponse<BouncedRecipientDto> GetBouncedRecipientWithHttpInfo(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of the bounced recipient

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<BouncedRecipientDto>

    ApiResponse of BouncedRecipientDto

    Remarks

    Bounced emails are email you have sent that were rejected by a recipient

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetComplaint(Guid, int)

    Get complaint

    Declaration
    Complaint GetComplaint(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of the complaint

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    Complaint

    Complaint

    Remarks

    Get complaint

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetComplaints(int?, int?, string, DateTime?, DateTime?, int)

    Get paginated list of complaints.

    Declaration
    PageComplaint GetComplaints(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageComplaint

    PageComplaint

    Remarks

    SMTP complaints made against your account

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetComplaintsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

    Get paginated list of complaints.

    Declaration
    ApiResponse<PageComplaint> GetComplaintsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageComplaint>

    ApiResponse of PageComplaint

    Remarks

    SMTP complaints made against your account

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetComplaintWithHttpInfo(Guid, int)

    Get complaint

    Declaration
    ApiResponse<Complaint> GetComplaintWithHttpInfo(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid id

    ID of the complaint

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<Complaint>

    ApiResponse of Complaint

    Remarks

    Get complaint

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetListUnsubscribeRecipients(int?, int?, string, Guid?, int)

    Get paginated list of unsubscribed recipients.

    Declaration
    PageListUnsubscribeRecipients GetListUnsubscribeRecipients(int? page = null, int? size = null, string sort = null, Guid? domainId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    System.Guid? domainId

    Filter by domainId (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageListUnsubscribeRecipients

    PageListUnsubscribeRecipients

    Remarks

    Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetListUnsubscribeRecipientsWithHttpInfo(int?, int?, string, Guid?, int)

    Get paginated list of unsubscribed recipients.

    Declaration
    ApiResponse<PageListUnsubscribeRecipients> GetListUnsubscribeRecipientsWithHttpInfo(int? page = null, int? size = null, string sort = null, Guid? domainId = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

    Optional page index (optional, default to 0)

    int? size

    Optional page size (optional, default to 20)

    string sort

    Optional createdAt sort direction ASC or DESC (optional, default to ASC)

    System.Guid? domainId

    Filter by domainId (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageListUnsubscribeRecipients>

    ApiResponse of PageListUnsubscribeRecipients

    Remarks

    Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    • View Source
    In This Article
    Back to top See MailSlurp website for more information.