mailslurp v15.13.17

MailSlurpAPI.Api.ContactController (mailslurp v15.13.17)

API calls for all endpoints tagged ContactController.

Link to this section Summary

Functions

create_contact(connection, create_contact_options, opts \\ [])

Create a contact

delete_contact(connection, contact_id, opts \\ [])

Delete contact

get_all_contacts(connection, opts \\ [])

Get all contacts

get_contact(connection, contact_id, opts \\ [])

Get contact

get_contact_v_card(connection, contact_id, opts \\ [])

Get contact vCard vcf file

get_contacts(connection, opts \\ [])

Get all contacts

Link to this section Functions

Link to this function

create_contact(connection, create_contact_options, opts \\ [])

@spec create_contact(
  Tesla.Env.client(),
  MailSlurpAPI.Model.CreateContactOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.ContactDto.t()} | {:error, Tesla.Env.t()}

Create a contact

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • create_contact_options (CreateContactOptions):
  • opts (KeywordList): [optional] Optional parameters

returns

 Returns

} on success {:error, info} on failure

Link to this function

delete_contact(connection, contact_id, opts \\ [])

@spec delete_contact(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete contact

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • contact_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

 Returns

} on success {:error, info} on failure

Link to this function

get_all_contacts(connection, opts \\ [])

@spec get_all_contacts(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageContactProjection.t()} | {:error, Tesla.Env.t()}

Get all contacts

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in list pagination
    • :size (integer()): Optional page size in list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

returns

 Returns

} on success {:error, info} on failure

Link to this function

get_contact(connection, contact_id, opts \\ [])

@spec get_contact(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.ContactDto.t()} | {:error, Tesla.Env.t()}

Get contact

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • contact_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

 Returns

} on success {:error, info} on failure

Link to this function

get_contact_v_card(connection, contact_id, opts \\ [])

@spec get_contact_v_card(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [String.t()]} | {:error, Tesla.Env.t()}

Get contact vCard vcf file

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • contact_id (String.t):
  • opts (KeywordList): [optional] Optional parameters

returns

 Returns

, ...]} on success {:error, info} on failure

Link to this function

get_contacts(connection, opts \\ [])

@spec get_contacts(Tesla.Env.client(), keyword()) ::
  {:ok, [MailSlurpAPI.Model.ContactProjection.t()]} | {:error, Tesla.Env.t()}

Get all contacts

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

returns

 Returns

, ...]} on success {:error, info} on failure