Skip to content

\ContactControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
create_contact post /contacts Create a contact
delete_contact delete /contacts/{contactId} Delete contact
get_all_contacts get /contacts/paginated Get all contacts
get_contact get /contacts/{contactId} Get contact
get_contact_v_card get /contacts/{contactId}/download Get contact vCard vcf file
get_contacts get /contacts Get all contacts

create_contact

crate::models::ContactDto create_contact(create_contact_options) Create a contact

Parameters

Name Type Description Required Notes
create_contact_options CreateContactOptions [required]

Return type

crate::models::ContactDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_contact

delete_contact(contact_id) Delete contact

Parameters

Name Type Description Required Notes
contact_id String [required]

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_all_contacts

crate::models::PageContactProjection get_all_contacts(page, size, sort, since, before) Get all contacts

Parameters

Name Type Description Required Notes
page Option<i32> Optional page in list pagination [default to 0]
size Option<i32> Optional page size in list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageContactProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_contact

crate::models::ContactDto get_contact(contact_id) Get contact

Parameters

Name Type Description Required Notes
contact_id String [required]

Return type

crate::models::ContactDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_contact_v_card

Vec get_contact_v_card(contact_id) Get contact vCard vcf file

Parameters

Name Type Description Required Notes
contact_id String [required]

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_contacts

Vec get_contacts() Get all contacts

Parameters

This endpoint does not need any parameter.

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]