Skip to content

MailSlurp::ApiUserControllerApi

Load the API package

use MailSlurp::Object::ApiUserControllerApi;

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

Method HTTP request Description
get_json_property_as_string POST /user/json/pluck
get_user_info GET /user/info

string get_json_property_as_string(property => $property, body => $body)

Utility function to extract properties from JSON objects in language where this is cumbersome.

Example

use Data::Dumper;
use MailSlurp::ApiUserControllerApi;
my $api_instance = MailSlurp::ApiUserControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $property = "property_example"; # string | JSON property name or dot separated path selector such as `a.b.c`
my $body = MailSlurp::Object::object->new(); # object | 

eval { 
    my $result = $api_instance->get_json_property_as_string(property => $property, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->get_json_property_as_string: $@n";
}

Parameters

Name Type Description Notes
property string JSON property name or dot separated path selector such as a.b.c
body object

Return type

string

Authorization

API_KEY

HTTP request headers

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

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

UserInfoDto get_user_info()

Example

use Data::Dumper;
use MailSlurp::ApiUserControllerApi;
my $api_instance = MailSlurp::ApiUserControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);


eval { 
    my $result = $api_instance->get_user_info();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->get_user_info: $@n";
}

Parameters

This endpoint does not need any parameter.

Return type

UserInfoDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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