Class SecrecyMailClient

Constructors

constructor

new SecrecyMailClient(client: SecrecyClient): SecrecyMailClient
Parameters
- client: SecrecyClient
Returns SecrecyMailClient
- Defined in client/SecrecyMailClient.ts:19

Methods

create

create(data: NewMail, customMessage?: string | null): Promise<SentMail>
Parameters
- data: NewMail
- OptionalcustomMessage: string | null
Returns Promise<SentMail>
- Defined in client/SecrecyMailClient.ts:59

createDraft

createDraft(__namedParameters: NewMail): Promise<DraftMail>
Parameters
- __namedParameters: NewMail
Returns Promise<DraftMail>
- Defined in client/SecrecyMailClient.ts:302

delete

delete(__namedParameters: { mailId: string }): Promise<boolean>
Parameters
- __namedParameters: { mailId: string }
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:195

deletedMails

deletedMails(
__namedParameters: { mailType: "received" | "sent" },
): Promise<Mail[]>
Parameters
- __namedParameters: { mailType: "received" | "sent" }
Returns Promise<Mail[]>
- Defined in client/SecrecyMailClient.ts:39

deleteDraft

deleteDraft(draftId: string): Promise<boolean>
Parameters
- draftId: string
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:171

deleteTrash

deleteTrash(__namedParameters: { ids: string[] }): Promise<boolean>
Parameters
- __namedParameters: { ids: string[] }
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:179

draftMails

draftMails(input: {}): Promise<DraftMail[]>
Parameters
- input: {}
Returns Promise<DraftMail[]>
- Defined in client/SecrecyMailClient.ts:420

emptyTrash

emptyTrash(): Promise<boolean>
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:188

get

get(__namedParameters: { id: string }): Promise<Mail>
Parameters
- __namedParameters: { id: string }
Returns Promise<Mail>
- Defined in client/SecrecyMailClient.ts:23

read

read(__namedParameters: { mailId: string }): Promise<boolean>
Parameters
- __namedParameters: { mailId: string }
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:371

receivedMails

receivedMails(
input: Omit<RouterInputs["mail"]["received"], "fromIdentityPubKey">,
): Promise<ReceivedMail[]>
Parameters
- input: Omit<RouterInputs["mail"]["received"], "fromIdentityPubKey">
Returns Promise<ReceivedMail[]>
- Defined in client/SecrecyMailClient.ts:389

recover

recover(__namedParameters: { mailId: string }): Promise<boolean>
Parameters
- __namedParameters: { mailId: string }
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:31

sendDraft

sendDraft(draftId: string, customMessage?: string | null): Promise<boolean>
Parameters
- draftId: string
- OptionalcustomMessage: string | null
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:203

sendWaitingEmails

sendWaitingEmails(): Promise<void>
Returns Promise<void>
- Defined in client/SecrecyMailClient.ts:261

sentMails

sentMails(input: {}): Promise<SentMail[]>
Parameters
- input: {}
Returns Promise<SentMail[]>
- Defined in client/SecrecyMailClient.ts:407

unread

unread(__namedParameters: { mailId: string }): Promise<boolean>
Parameters
- __namedParameters: { mailId: string }
Returns Promise<boolean>
- Defined in client/SecrecyMailClient.ts:380

unreadReceivedMailsCount

unreadReceivedMailsCount(): Promise<number>
Returns Promise<number>
- Defined in client/SecrecyMailClient.ts:433

updateDraft

updateDraft(
draftId: string,
__namedParameters: Partial<NewMail>,
): Promise<DraftMail>
Parameters
- draftId: string
- __namedParameters: Partial<NewMail>
Returns Promise<DraftMail>
- Defined in client/SecrecyMailClient.ts:90

waitingReceivedMails

waitingReceivedMails(): Promise<WaitingReceivedMail[]>
Returns Promise<WaitingReceivedMail[]>
- Defined in client/SecrecyMailClient.ts:71