URL: /Mail/Send

Method: POST

Descrizione

Permette di inserire nuove email che verranno elaborate ed inviate da DocsMarshal.

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
    'sessionId': SID,
    'idMail': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    'idMailAccount' / 'externalIdMailAccount / editAndSendMailId': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    'from': {
        name: null,
        emailAddress: "system@docsmarshal.com"
    }
    'to': [{
        name: null,
        emailAddress: "user@docsmarshal.com"
    }],
    'cc': [{
        name: null,
        emailAddress: "hr@docsmarshal.com"
    }],
    'bcc': [{
        name: null,
        emailAddress: "admin@docsmarshal.com"
    }],
    subject: '2025 Report',
    body: 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod',
    bodyIsHtml: true,
    highPriority: false,
    attachments: [{
        fileName: 'report.pdf',
        base64Content: 'R29vZCBqb2IgdGhlcmUhIDopCkxv...'
    }],
    'domainId': 1,
    'languageId': 3,
    'externalId': null,
    'objectsRelation': ['xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'],
    'tags': ['test'],
}

Note

• idMailAccount' / 'externalIdMailAccount / editAndSendMailId
  Il parametro 'editAndSendMailId' rappresenta l'ID di una mail esistente. Se fornito l'email verrà inviata a partire da una esistente.
  Se non viene fornito, sarà necessario indicare id / externalId del mail account DocsMarshal da utilizzare per l'invio.
• from: Mittente
• to: Uno o più destinatari
• cc: Destinatari in copia carbone
• bcc: Destinatari in copia carbone nascosta
• subject: Oggetto della mail
• body: Contenuto della mail
• bodyIsHtml: Indica se il contenuto della mail è in formato html
• highPriority: Marca la mail come ad alta priorità (aggiungendo l'header X-Priority all'EML)
• attachments: Elenco di file da allegare alla mail. L'allegato può essere inviato in due modi:
  • Come stringa base64 all'interno del corpo JSON
  • Come dati binari tramite HTTP che utilizza la codifica multipart/form-data
• objectsRelation: Elenco di objectIds di profili da collegare alla mail

Formato risposte

{
  "Data": {
    "Bcc": null,
    "AttachmentsName": null,
    "AttachmentsCount": 0,
    "Body": null,
    "BodyIsHtml": false,
    "Cc": null,
    "DomainId": 0,
    "EMailStatus": 0,
    "ErrorMessage": null,
    "ExternalId": null,
    "From": null,
    "HighPriority": false,
    "IdMail": "00000000-0000-0000-0000-000000000000",
    "IdMailAccount": "00000000-0000-0000-0000-000000000000",
    "LanguageId": null,
    "MailDt": "0001-01-01T00:00:00",
    "OwnerSecurityIdentityId": null,
    "RefObjectId": null,
    "RefWorld": null,
    "SendAttempts": 0,
    "StorageId": null,
    "Subject": null,
    "Tags": null,
    "To": null
  },
  "Error": false,
  "LoggedOut": false,
  "ErrorCode": null,
  "ErrorDescription": null,
  "ErrorParameters": null
}