Office.Recipients interface

Referência

Pacote:: outlook

Representa os destinatários de um item. Somente modo de redação.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Métodos

addAsync(recipients, options, callback)	Adiciona uma lista de destinatários aos destinatários existentes para um compromisso ou uma mensagem.
addAsync(recipients, callback)	Adiciona uma lista de destinatários aos destinatários existentes para um compromisso ou uma mensagem.
getAsync(options, callback)	Obtém uma lista de destinatários para um compromisso ou uma mensagem.
getAsync(callback)	Obtém uma lista de destinatários para um compromisso ou uma mensagem.
setAsync(recipients, options, callback)	Define uma lista de destinatários para um compromisso ou uma mensagem. O método `setAsync` substitui a lista de destinatários atual.
setAsync(recipients, callback)	Define uma lista de destinatários para um compromisso ou uma mensagem. O método `setAsync` substitui a lista de destinatários atual.

Detalhes do método

addAsync(recipients, options, callback)

Adiciona uma lista de destinatários aos destinatários existentes para um compromisso ou uma mensagem.

addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

Os destinatários a serem adicionados à lista de destinatários. A matriz de destinatários pode conter cadeias de caracteres de endereços de email SMTP, objetos EmailUser ou objetos EmailAddressDetails .

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a adição de destinatários falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Importante: com o addAsync método, você pode adicionar no máximo 100 destinatários a um item de email no Outlook no Windows, no Mac (interface do usuário clássica), na Web, no Android e no iOS. No entanto, anote o seguinte:

No Outlook no Windows, no Mac (interface do usuário clássica) e na Web, você pode ter no máximo 500 destinatários em um campo de destino. Se você precisar adicionar mais de 100 destinatários a um item de email, pode ligar addAsync repetidamente, mas esteja atento ao limite de destinatário do campo.
No Outlook no Android e no iOS, o addAsync método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Não haverá limite de destinatário se você chamar addAsync no Outlook no Mac (nova interface do usuário).

Erros:

NumberOfRecipientsExceeded: o número de destinatários excedeu 100 entradas.

Exemplos

// The following example creates an array of EmailUser objects
// and adds them to the To recipients of the message.
const newRecipients = [
    {
        "displayName": "Allie Bellew",
        "emailAddress": "allieb@contoso.com"
    },
    {
        "displayName": "Alex Darrow",
        "emailAddress": "alexd@contoso.com"
    }
];

Office.context.mailbox.item.to.addAsync(newRecipients, function(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Recipients added");
    }
});

addAsync(recipients, callback)

Adiciona uma lista de destinatários aos destinatários existentes para um compromisso ou uma mensagem.

addAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

callback: (asyncResult: Office.AsyncResult<void>) => void

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

No Outlook no Windows, no Mac (interface do usuário clássica) e na Web, você pode ter no máximo 500 destinatários em um campo de destino. Se você precisar adicionar mais de 100 destinatários a um item de email, pode ligar addAsync repetidamente, mas esteja atento ao limite de destinatário do campo.
No Outlook no Android e no iOS, o addAsync método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Não haverá limite de destinatário se você chamar addAsync no Outlook no Mac (nova interface do usuário).

Erros:

NumberOfRecipientsExceeded: o número de destinatários excedeu 100 entradas.

getAsync(options, callback)

Obtém uma lista de destinatários para um compromisso ou uma mensagem.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;

Parâmetros

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback: (asyncResult: Office.AsyncResult<Office.EmailAddressDetails[]>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultdo tipo Office.AsyncResult. A asyncResult.value propriedade do resultado é uma matriz de objetos EmailAddressDetails .

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Importante:

O número máximo de destinatários retornados por esse método varia de acordo com o cliente do Outlook.

Windows, navegador da Web, Mac (interface do usuário clássica): 500 destinatários
Android, iOS: 100 destinatários
Mac (nova interface do usuário): sem limite

O getAsync método retorna apenas os destinatários resolvidos pelo cliente do Outlook. Um destinatário resolvido tem as seguintes características.

Se o destinatário tiver uma entrada salva no catálogo de endereços do remetente, o Outlook resolverá o endereço de email para o nome de exibição salvo do destinatário.
Um ícone de status de reunião do Teams é exibido antes do nome ou endereço de email do destinatário.
Um ponto e vírgula é exibido após o nome do destinatário ou endereço de email.
O nome ou endereço de email do destinatário é sublinhado ou fechado em uma caixa.

Para resolve um endereço de email depois de adicionado a um item de email, o remetente deve usar a chave Tab ou selecionar um contato sugerido ou endereço de email na lista de preenchimento automático.

Em Outlook na Web e no Windows, se um usuário criar uma nova mensagem ativando o link de endereço de email de um contato de seu contato ou perfil cartão, a chamada do Recipients.getAsync suplemento retornará o endereço de email do contato na displayName propriedade do objeto EmailAddressDetails associado em vez do nome salvo do contato. Para obter mais detalhes, confira o problema relacionado do GitHub.

getAsync(callback)

Obtém uma lista de destinatários para um compromisso ou uma mensagem.

getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void): void;

Parâmetros

callback: (asyncResult: Office.AsyncResult<Office.EmailAddressDetails[]>) => void

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Importante:

O número máximo de destinatários retornados por esse método varia de acordo com o cliente do Outlook.

Windows, navegador da Web, Mac (interface do usuário clássica): 500 destinatários
Android, iOS: 100 destinatários
Mac (nova interface do usuário): sem limite

O getAsync método retorna apenas os destinatários resolvidos pelo cliente do Outlook. Um destinatário resolvido tem as seguintes características.

Se o destinatário tiver uma entrada salva no catálogo de endereços do remetente, o Outlook resolverá o endereço de email para o nome de exibição salvo do destinatário.
Um ícone de status de reunião do Teams é exibido antes do nome ou endereço de email do destinatário.
Um ponto e vírgula é exibido após o nome do destinatário ou endereço de email.
O nome ou endereço de email do destinatário é sublinhado ou fechado em uma caixa.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

setAsync(recipients, options, callback)

Define uma lista de destinatários para um compromisso ou uma mensagem.

O método setAsync substitui a lista de destinatários atual.

setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback: (asyncResult: Office.AsyncResult<void>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a configuração de destinatários falha, a propriedade asyncResult.error conterá um código que indica quaisquer erros que ocorreram ao adicionar os dados.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Importante: com o setAsync método, você pode definir um máximo de 100 destinatários no Outlook no Windows, no Mac (interface do usuário clássica), na Web, no Android e no iOS. No entanto, anote o seguinte:

No Outlook no Windows, no Mac (interface do usuário clássica) e na Web, você pode ter no máximo 500 destinatários em um campo de destino. Se precisar definir mais de 100 destinatários, você pode chamar setAsync repetidamente, mas esteja atento ao limite de destinatário do campo.
No Outlook no Android e no iOS, o setAsync método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Não haverá limite de destinatário se você chamar setAsync no Outlook no Mac (nova interface do usuário).

Erros:

NumberOfRecipientsExceeded: o número de destinatários excedeu 100 entradas.

setAsync(recipients, callback)

Define uma lista de destinatários para um compromisso ou uma mensagem.

O método setAsync substitui a lista de destinatários atual.

setAsync(recipients: Array<string | EmailUser | EmailAddressDetails>, callback: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

recipients: Array<string | Office.EmailUser | Office.EmailAddressDetails>

callback: (asyncResult: Office.AsyncResult<void>) => void

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

No Outlook no Windows, no Mac (interface do usuário clássica) e na Web, você pode ter no máximo 500 destinatários em um campo de destino. Se precisar definir mais de 100 destinatários, você pode chamar setAsync repetidamente, mas esteja atento ao limite de destinatário do campo.
No Outlook no Android e no iOS, o setAsync método não tem suporte no modo de Composição de Mensagens. Há suporte apenas para o modo Organizador de Compromissos. Para obter mais informações sobre APIs com suporte no Outlook mobile, consulte APIs JavaScript do Outlook com suporte no Outlook em dispositivos móveis.

Não haverá limite de destinatário se você chamar setAsync no Outlook no Mac (nova interface do usuário).

Erros:

NumberOfRecipientsExceeded: o número de destinatários excedeu 100 entradas.

Exemplos

// The following example creates an array of EmailUser objects and
// replaces the CC recipients of the message with the array.
const newRecipients = [
    {
        "displayName": "Allie Bellew",
        "emailAddress": "allieb@contoso.com"
    },
    {
        "displayName": "Alex Darrow",
        "emailAddress": "alexd@contoso.com"
    }
];

Office.context.mailbox.item.cc.setAsync(newRecipients, function(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Recipients overwritten");
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

const email = $("#emailBcc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailCc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailOptional")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailRequired")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailTo")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Office.Recipients interface

Comentários

Métodos

Detalhes do método

addAsync(recipients, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addAsync(recipients, callback)

Parâmetros

Retornos

Comentários

getAsync(options, callback)

Parâmetros

Retornos

Comentários

getAsync(callback)

Parâmetros

Retornos

Comentários

Exemplos

setAsync(recipients, options, callback)

Parâmetros

Retornos

Comentários

setAsync(recipients, callback)

Parâmetros

Retornos

Comentários

Exemplos

Comentários

Recursos adicionais