Python
Brouillons
`drafts.list`, `list_all`, `iterate`, `get`, `create`, `update` et `delete`.
Toutes les méthodes
from openemail import openemail page = openemail.drafts.list(query='invoice', limit=25)draft = openemail.drafts.get('draft_…') created = openemail.drafts.create({ 'to': ['[email protected]'], 'cc': [], 'bcc': [], 'subject': 'Your September invoice', 'html': '<p>Draft body.</p>', 'from': '[email protected]', 'threadId': 'thread_…',}) draft_id = created['id'] if draft_id is not None: openemail.drafts.update(draft_id, {'subject': 'Revised'}) openemail.drafts.delete(draft_id)update conserve l'id du brouillon : la valeur qu'il renvoie est donc toujours celle que vous avez transmise. Un id inconnu donne un 404 plutôt qu'un nouveau brouillon.
list pagine comme threads.list : le pageToken de l'API revient sous le nom nextCursor et se transmet sous le nom cursor, et list_all et iterate le suivent pour vous.
Pour envoyer un brouillon, transmettez son id à emails.send. Le brouillon fournit le contenu, l'envoi fournit l'enveloppe.
from openemail import openemail openemail.emails.send({ 'from': '[email protected]', 'to': '[email protected]', 'draftId': 'draft_…',})Paramètres : drafts.create et drafts.update (DraftInput)
tolist[str]- Les adresses des destinataires sous forme de chaînes simples, et non dans les formes `RecipientInput` qu'accepte `emails.send`, car ce point de terminaison assemble le tableau en la liste séparée par des virgules qu'attend le driver. À la création, un tableau omis est enregistré comme vide ; à la mise à jour, un champ omis laisse les destinataires stockés intacts, car le handler lit d'abord le brouillon puis fusionne.
cclist[str]- Les adresses Cc, dans la même forme de chaîne simple que `to`. Vide à la création si omis, et intact à la mise à jour si omis.
bcclist[str]- Les adresses Bcc, dans la même forme de chaîne simple que `to`. Vide à la création si omis, et intact à la mise à jour si omis.
subjectstr- L'objet du brouillon, 998 caractères au maximum, la limite de ligne RFC 5322. À la création, il vaut par défaut une chaîne vide : un brouillon en a donc toujours un.
htmlstr- Le corps du brouillon sous forme de balisage, 1 000 000 caractères au maximum. C'est le corps qui l'emporte : `html` et `text` alimentent l'unique champ de message du driver, donc envoyer les deux enregistre celui-ci.
textstr- Un corps en texte brut, 1 000 000 caractères au maximum, utilisé uniquement en l'absence de `html`. Le brouillon stocke un seul corps plutôt que deux parties : le texte fourni ici revient donc sur `html` à la lecture du brouillon.
fromstr- L'adresse d'expédition à enregistrer sur le brouillon. À la mise à jour, elle est reprise du brouillon stocké si elle est omise. Le driver reconstruit tout le message à partir de ce qu'on lui transmet : un patch partiel qui l'omettrait changerait donc silencieusement l'expéditeur choisi.
threadIdstr- Rattache le brouillon à un thread existant pour qu'il soit enregistré comme une réponse. Comme `from`, il est repris à la mise à jour s'il est omis, car reconstruire le message sans lui détacherait la réponse de son thread.
Réponse : DraftResource (drafts.get)
objectLiteral['draft']- Toujours `draft`.
idstr- L'id du brouillon. Les écritures répondent avec un `SavedDraftResource` plutôt qu'avec un brouillon complet : lisez donc l'id sur le résultat au lieu de réutiliser celui que vous avez envoyé.
tolist[str]- Les adresses des destinataires telles que le brouillon les a stockées. Une liste vide, jamais `None`, quand le brouillon n'en a aucune.
cclist[str]- Les adresses Cc telles que stockées. Une liste vide, jamais `None`, quand le brouillon n'en a aucune.
bcclist[str]- Les adresses Bcc telles que stockées. Une liste vide, jamais `None`, quand le brouillon n'en a aucune.
subjectstr- L'objet stocké, ou une chaîne vide quand le brouillon n'en a pas. Ce champ n'est jamais `None` : vérifiez sa longueur plutôt que sa présence.
htmlstr- Le corps stocké, ou une chaîne vide quand le brouillon n'en a pas. Il n'existe pas de champ text distinct en sortie : un brouillon enregistré avec `text` seul est renvoyé ici.