MailSlurpContactControllerApi

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

MethodHTTP requestDescription
CreateContactPost /contactsCreate a contact
DeleteContactDelete /contacts/{contactId}Delete contact
GetAllContactsGet /contacts/paginatedGet all contacts
GetContactGet /contacts/{contactId}Get contact
GetContactVCardGet /contacts/{contactId}/downloadGet contact vCard vcf file
GetContactsGet /contactsGet all contacts

CreateContact

ContactDto CreateContact(ctx, createContactOptions)

Create a contact

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
createContactOptionsCreateContactOptionscreateContactOptions

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 ]

DeleteContact

DeleteContact(ctx, contactId)

Delete contact

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
contactIdstringcontactId

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 ]

GetAllContacts

PageContactProjection GetAllContacts(ctx, optional)

Get all contacts

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetAllContactsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllContactsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
pageoptional.Int32Optional page in list pagination[default to 0]
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in list pagination[default to 20]
sortoptional.StringOptional 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 ]

GetContact

ContactDto GetContact(ctx, contactId)

Get contact

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
contactIdstringcontactId

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 ]

GetContactVCard

string GetContactVCard(ctx, contactId)

Get contact vCard vcf file

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
contactIdstringcontactId

Return type

string

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

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 ]