Class: CommonActionsControllerApi
Hierarchy
-
↳
CommonActionsControllerApi
Table of contents
Constructors
Properties
Methods
- createNewEmailAddress
- createNewEmailAddressRaw
- createRandomInbox
- createRandomInboxRaw
- deleteEmailAddress
- deleteEmailAddressRaw
- emptyInbox
- emptyInboxRaw
- request
- sendEmailSimple
- sendEmailSimpleRaw
- withMiddleware
- withPostMiddleware
- withPreMiddleware
Constructors
constructor
• new CommonActionsControllerApi(configuration?
)
Parameters
Name | Type |
---|---|
configuration | Configuration |
Inherited from
Properties
configuration
• Protected
configuration: Configuration
Inherited from
Methods
createNewEmailAddress
▸ createNewEmailAddress(requestParameters
, initOverrides?
): Promise
<InboxDto
>
Returns an Inbox with an id
and an emailAddress
Create new random inbox
Parameters
Name | Type |
---|---|
requestParameters | CreateNewEmailAddressRequest |
initOverrides? | RequestInit |
Returns
Promise
<InboxDto
>
createNewEmailAddressRaw
▸ createNewEmailAddressRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<InboxDto
>>
Returns an Inbox with an id
and an emailAddress
Create new random inbox
Parameters
Name | Type |
---|---|
requestParameters | CreateNewEmailAddressRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<InboxDto
>>
createRandomInbox
▸ createRandomInbox(requestParameters
, initOverrides?
): Promise
<InboxDto
>
Returns an Inbox with an id
and an emailAddress
Create new random inbox
Parameters
Name | Type |
---|---|
requestParameters | CreateRandomInboxRequest |
initOverrides? | RequestInit |
Returns
Promise
<InboxDto
>
createRandomInboxRaw
▸ createRandomInboxRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<InboxDto
>>
Returns an Inbox with an id
and an emailAddress
Create new random inbox
Parameters
Name | Type |
---|---|
requestParameters | CreateRandomInboxRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<InboxDto
>>
deleteEmailAddress
▸ deleteEmailAddress(requestParameters
, initOverrides?
): Promise
<void
>
Deletes inbox email address Delete inbox email address by inbox id
Parameters
Name | Type |
---|---|
requestParameters | DeleteEmailAddressRequest |
initOverrides? | RequestInit |
Returns
Promise
<void
>
deleteEmailAddressRaw
▸ deleteEmailAddressRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<void
>>
Deletes inbox email address Delete inbox email address by inbox id
Parameters
Name | Type |
---|---|
requestParameters | DeleteEmailAddressRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<void
>>
emptyInbox
▸ emptyInbox(requestParameters
, initOverrides?
): Promise
<void
>
Deletes all emails Delete all emails in an inbox
Parameters
Name | Type |
---|---|
requestParameters | EmptyInboxRequest |
initOverrides? | RequestInit |
Returns
Promise
<void
>
emptyInboxRaw
▸ emptyInboxRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<void
>>
Deletes all emails Delete all emails in an inbox
Parameters
Name | Type |
---|---|
requestParameters | EmptyInboxRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<void
>>
request
▸ Protected
request(context
, initOverrides?
): Promise
<Response
>
Parameters
Name | Type |
---|---|
context | RequestOpts |
initOverrides? | RequestInit |
Returns
Promise
<Response
>
Inherited from
sendEmailSimple
▸ sendEmailSimple(requestParameters
, initOverrides?
): Promise
<void
>
If no senderId or inboxId provided a random email address will be used to send from. Send an email
Parameters
Name | Type |
---|---|
requestParameters | SendEmailSimpleRequest |
initOverrides? | RequestInit |
Returns
Promise
<void
>
sendEmailSimpleRaw
▸ sendEmailSimpleRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<void
>>
If no senderId or inboxId provided a random email address will be used to send from. Send an email
Parameters
Name | Type |
---|---|
requestParameters | SendEmailSimpleRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<void
>>
withMiddleware
▸ withMiddleware<T
>(this
, ...middlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...middlewares | Middleware [] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T
>(this
, ...postMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...postMiddlewares | (context : ResponseContext ) => Promise <void |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T
>(this
, ...preMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...preMiddlewares | (context : RequestContext ) => Promise <void |
Returns
T