SDK
Melnraksti
`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` un `delete`.
Visas metodes
const page = await openemail.drafts.list({ query: 'invoice', limit: 25 })const draft = await openemail.drafts.get('draft_…') const created = await openemail.drafts.create({ to: ['[email protected]'], cc: [], bcc: [], subject: 'Your September invoice', html: '<p>Draft body.</p>', from: '[email protected]', threadId: 'thread_…',}) const updated = await openemail.drafts.update(created.id!, { subject: 'Revised' })await openemail.drafts.delete(updated.id!)update saglabā melnraksta id, tāpēc vērtība, ar kuru tas atbild, vienmēr ir tā, ko padevāt. Nezināms id ir 404, nevis jauns melnraksts.
list lappušo tāpat kā threads.list: API pageToken atnāk kā nextCursor un aiziet kā cursor, un listAll un iterate tam seko jūsu vietā.
Lai nosūtītu melnrakstu, padodiet tā id metodei emails.send. Melnraksts dod saturu, bet sūtījums — aploksni.
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})Parametri: drafts.create un drafts.update (DraftInput)
tostring[]- Adresātu adreses kā vienkāršas virknes, nevis `RecipientInput` formas, ko pieņem `emails.send`, jo šis galapunkts savieno masīvu ar komatiem atdalītā sarakstā, kādu grib draiveris. Izveidojot izlaists masīvs tiek saglabāts kā tukšs; atjauninot izlaists lauks atstāj saglabātos adresātus neskartus, jo apstrādātājs vispirms nolasa melnrakstu un sapludina.
ccstring[]- Cc adreses tādā pašā vienkāršu virkņu formā kā `to`. Izveidojot izlaistas ir tukšas, atjauninot izlaistas paliek neskartas.
bccstring[]- Bcc adreses tādā pašā vienkāršu virkņu formā kā `to`. Izveidojot izlaistas ir tukšas, atjauninot izlaistas paliek neskartas.
subjectstring- Melnraksta temats, ne vairāk kā 998 rakstzīmes, kas ir RFC 5322 rindas ierobežojums. Izveidojot tas pēc noklusējuma ir tukša virkne, tāpēc melnrakstam vienmēr ir temats.
htmlstring- Melnraksta pamatteksts kā iezīmējums, ne vairāk kā 1 000 000 rakstzīmju. Uzvar tieši šis pamatteksts: `html` un `text` baro draivera vienīgo ziņojuma lauku, tāpēc, sūtot abus, tiek saglabāts šis.
textstring- Vienkārša teksta pamatteksts, ne vairāk kā 1 000 000 rakstzīmju, izmantots tikai tad, kad `html` nav. Melnraksts glabā vienu pamattekstu, nevis divas daļas, tāpēc šeit padotais teksts, melnrakstu nolasot, atnāk atpakaļ laukā `html`.
fromstring- Sūtītāja adrese, ko saglabāt melnrakstā. Atjauninot tā tiek pārnesta no saglabātā melnraksta, ja izlaista. Draiveris visu ziņojumu pārbūvē no tā, kas tam padots, tāpēc daļējs patch, kas to nomestu, klusi nomainītu izvēlēto sūtītāju.
threadIdstring- Piesaistiet melnrakstu esošam pavedienam, lai tas saglabātos kā atbilde. Tāpat kā `from`, arī tas atjauninot tiek pārnests, ja izlaists, jo ziņojuma pārbūve bez tā atrautu atbildi no tās pavediena.
Atbilde: DraftResource (drafts.get)
object'draft'- Vienmēr `draft`.
idstring- Melnraksta id. Rakstīšanas izsaukumi atbild ar `SavedDraftResource`, nevis ar visu melnrakstu, tāpēc nolasiet id no rezultāta, nevis izmantojiet atkārtoti to, ko nosūtījāt.
tostring[]- Adresātu adreses tā, kā melnraksts tās saglabāja. Tukšs masīvs, nekad null, kad melnrakstam to nav.
ccstring[]- Cc adreses, kā saglabātas. Tukšs masīvs, nekad null, kad melnrakstam to nav.
bccstring[]- Bcc adreses, kā saglabātas. Tukšs masīvs, nekad null, kad melnrakstam to nav.
subjectstring- Saglabātais temats vai tukša virkne, ja melnrakstam tāda nav. Šis lauks nekad nav null, tāpēc pārbaudiet tā garumu, nevis esamību.
htmlstring- Saglabātais pamatteksts vai tukša virkne, ja melnrakstam tāda nav. Izejā nav atsevišķa teksta lauka: melnraksts, kas saglabāts tikai ar `text`, tiek atgriezts šeit.