Interface IGuestPortalControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IGuestPortalControllerApiSync : IApiAccessor

Methods

View Source

CreateGuestPortal(CreatePortalOptions, int)

Create a portal page for your customers or clients to log into email accounts and view emails.

Declaration

GuestPortalDto CreateGuestPortal(CreatePortalOptions createPortalOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreatePortalOptions	createPortalOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalDto	GuestPortalDto

Remarks

Create a guest login page for customers or clients to access assigned email addresses

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUser(Guid, CreatePortalUserOptions, int)

Create a portal guest user

Declaration

GuestPortalUserCreateDto CreateGuestPortalUser(Guid portalId, CreatePortalUserOptions createPortalUserOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
CreatePortalUserOptions	createPortalUserOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalUserCreateDto	GuestPortalUserCreateDto

Remarks

Add customer to portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUserWithHttpInfo(Guid, CreatePortalUserOptions, int)

Create a portal guest user

Declaration

ApiResponse<GuestPortalUserCreateDto> CreateGuestPortalUserWithHttpInfo(Guid portalId, CreatePortalUserOptions createPortalUserOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
CreatePortalUserOptions	createPortalUserOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalUserCreateDto>	ApiResponse of GuestPortalUserCreateDto

Remarks

Add customer to portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalWithHttpInfo(CreatePortalOptions, int)

Create a portal page for your customers or clients to log into email accounts and view emails.

Declaration

ApiResponse<GuestPortalDto> CreateGuestPortalWithHttpInfo(CreatePortalOptions createPortalOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreatePortalOptions	createPortalOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalDto>	ApiResponse of GuestPortalDto

Remarks

Create a guest login page for customers or clients to access assigned email addresses

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGuestPortalUsers(Guid?, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal

Declaration

PageGuestPortalUsers GetAllGuestPortalUsers(Guid? portalId = null, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	portalId	Optional portal ID (optional)
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageGuestPortalUsers	PageGuestPortalUsers

Remarks

Get all customers for a portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGuestPortalUsersWithHttpInfo(Guid?, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal

Declaration

ApiResponse<PageGuestPortalUsers> GetAllGuestPortalUsersWithHttpInfo(Guid? portalId = null, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	portalId	Optional portal ID (optional)
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageGuestPortalUsers>	ApiResponse of PageGuestPortalUsers

Remarks

Get all customers for a portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortal(Guid, int)

Get a client email portal

Declaration

GuestPortalDto GetGuestPortal(Guid portalId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalDto	GuestPortalDto

Remarks

Fetch a customer guest portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUser(Guid, Guid, int)

Get guest user for portal

Declaration

GuestPortalUserDto GetGuestPortalUser(Guid portalId, Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalUserDto	GuestPortalUserDto

Remarks

Get customer for portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserById(Guid, int)

Get guest user

Declaration

GuestPortalUserDto GetGuestPortalUserById(Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalUserDto	GuestPortalUserDto

Remarks

Get customer by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserByIdWithHttpInfo(Guid, int)

Get guest user

Declaration

ApiResponse<GuestPortalUserDto> GetGuestPortalUserByIdWithHttpInfo(Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalUserDto>	ApiResponse of GuestPortalUserDto

Remarks

Get customer by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserWithHttpInfo(Guid, Guid, int)

Get guest user for portal

Declaration

ApiResponse<GuestPortalUserDto> GetGuestPortalUserWithHttpInfo(Guid portalId, Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalUserDto>	ApiResponse of GuestPortalUserDto

Remarks

Get customer for portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUsers(Guid, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal

Declaration

PageGuestPortalUsers GetGuestPortalUsers(Guid portalId, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageGuestPortalUsers	PageGuestPortalUsers

Remarks

Get customers for a portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUsersWithHttpInfo(Guid, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal

Declaration

ApiResponse<PageGuestPortalUsers> GetGuestPortalUsersWithHttpInfo(Guid portalId, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageGuestPortalUsers>	ApiResponse of PageGuestPortalUsers

Remarks

Get customers for a portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalWithHttpInfo(Guid, int)

Get a client email portal

Declaration

ApiResponse<GuestPortalDto> GetGuestPortalWithHttpInfo(Guid portalId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalDto>	ApiResponse of GuestPortalDto

Remarks

Fetch a customer guest portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortals(int)

Get guest portals

Declaration

List<GuestPortalDto> GetGuestPortals(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<GuestPortalDto>	List<GuestPortalDto>

Remarks

Get portals

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalsWithHttpInfo(int)

Get guest portals

Declaration

ApiResponse<List<GuestPortalDto>> GetGuestPortalsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<GuestPortalDto>>	ApiResponse of List<GuestPortalDto>

Remarks

Get portals

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call