# MailSlurp\ContactControllerApi

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

Method HTTP request Description
CreateContact Post /contacts Create a contact
DeleteContact Delete /contacts/{contactId} Delete contact
GetAllContacts Get /contacts/paginated Get all contacts
GetContact Get /contacts/{contactId} Get contact
GetContacts Get /contacts Get all contacts

# CreateContact

ContactDto CreateContact(ctx, createContactOptions)

Create a contact

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createContactOptions CreateContactOptions createContactOptions

# Return type

ContactDto

# Authorization

API_KEY

# HTTP request headers

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

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

# DeleteContact

DeleteContact(ctx, contactId)

Delete contact

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
contactId string contactId

# 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 README]

# GetAllContacts

PageContactProjection GetAllContacts(ctx, optional)

Get all contacts

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllContactsOpts optional parameters nil if no parameters

# Optional Parameters

Optional parameters are passed through a pointer to a GetAllContactsOpts struct

Name Type Description Notes
page optional.Int32 Optional page index in inbox list pagination [default to 0]
size optional.Int32 Optional page size in inbox list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]

# Return type

PageContactProjection

# Authorization

API_KEY

# HTTP request headers

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

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

# GetContact

ContactDto GetContact(ctx, contactId)

Get contact

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
contactId string contactId

# Return type

ContactDto

# Authorization

API_KEY

# HTTP request headers

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

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

# GetContacts

[]ContactProjection GetContacts(ctx, )

Get all contacts

# Required Parameters

This endpoint does not need any parameter.

# Return type

[]ContactProjection

# Authorization

API_KEY

# HTTP request headers

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

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