Interface IAccountResource

Namespace

Mailtrap.Accounts

Assembly

Mailtrap.Abstractions.dll

Represents account resource.

public interface IAccountResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Access(long)

Gets resource for specific account access, identified by accessId.

IAccountAccessResource Access(long accessId)

Parameters

accessId long

ID of account access to get resource for.

Returns

IAccountAccessResource

Resource for the account access with specified ID.

Exceptions

ArgumentOutOfRangeException

When accessId is less than or equal to zero.

Accesses()

Gets account access collection resource for the account, represented by this resource instance.

IAccountAccessCollectionResource Accesses()

Returns

IAccountAccessCollectionResource

Account access collection resource for the account, represented by this resource instance.

Billing()

Gets billing resource for the account, represented by this resource instance.

IBillingResource Billing()

Returns

IBillingResource

Billing resource for the account, represented by this resource instance.

Contact(string)

Gets resource for specific contact, identified by idOrEmail.

IContactResource Contact(string idOrEmail)

Parameters

idOrEmail string

ID or email of contact to get resource for.

Returns

IContactResource

Resource for the contact with specified ID or email.

Exceptions

ArgumentNullException

When idOrEmail is null or empty.

Contacts()

Gets contact collection resource for the account, represented by this resource instance.

IContactCollectionResource Contacts()

Returns

IContactCollectionResource

Contact collection resource for the account, represented by this resource instance.

EmailTemplate(long)

Gets resource for specific email template, identified by emailTemplateId.

IEmailTemplateResource EmailTemplate(long emailTemplateId)

Parameters

emailTemplateId long

ID of email template to get resource for.

Returns

IEmailTemplateResource

Resource for the email template with specified ID.

Exceptions

ArgumentOutOfRangeException

When emailTemplateId is less than or equal to zero.

EmailTemplates()

Gets email template collection resource for the account, represented by this resource instance.

IEmailTemplateCollectionResource EmailTemplates()

Returns

IEmailTemplateCollectionResource

Email template collection resource for the account, represented by this resource instance.

Inbox(long)

Gets resource for specific inbox, identified by inboxId.

IInboxResource Inbox(long inboxId)

Parameters

inboxId long

ID of inbox to get resource for.

Returns

IInboxResource

Resource for the inbox with specified ID.

Exceptions

ArgumentOutOfRangeException

When inboxId is less than or equal to zero.

Inboxes()

Gets inbox collection resource for the account, represented by this resource instance.

IInboxCollectionResource Inboxes()

Returns

IInboxCollectionResource

Inbox collection resource for the account, represented by this resource instance.

Permissions()

Gets permissions resource for the account, represented by this resource instance.

IPermissionsResource Permissions()

Returns

IPermissionsResource

Permissions resource for the account, represented by this resource instance.

Project(long)

Gets resource for specific project, identified by projectId.

IProjectResource Project(long projectId)

Parameters

projectId long

ID of project to get resource for.

Returns

IProjectResource

Resource for the project with specified ID.

Exceptions

ArgumentOutOfRangeException

When projectId is less than or equal to zero.

Projects()

Gets project collection resource for the account, represented by this resource instance.

IProjectCollectionResource Projects()

Returns

IProjectCollectionResource

Project collection resource for the account, represented by this resource instance.

SendingDomain(long)

Gets resource for specific sending domain, identified by domainId.

ISendingDomainResource SendingDomain(long domainId)

Parameters

domainId long

ID of sending domain to get resource for.

Returns

ISendingDomainResource

Resource for the sending domain with specified ID.

Exceptions

ArgumentOutOfRangeException

When domainId is less than or equal to zero.

SendingDomains()

Gets sending domain collection resource for the account, represented by this resource instance.

ISendingDomainCollectionResource SendingDomains()

Returns

ISendingDomainCollectionResource

Sending domain collection resource for the account, represented by this resource instance.