Mudanças entre as edições de "TPHEmail"
(→Conceito) |
(→Procedimentos) |
||
(13 revisões intermediárias por 2 usuários não estão sendo mostradas) | |||
Linha 1: | Linha 1: | ||
− | |||
O objeto TPHEmail pode ser utilizado para realizar o envio de e-mail por meio de script. | O objeto TPHEmail pode ser utilizado para realizar o envio de e-mail por meio de script. | ||
Linha 27: | Linha 26: | ||
|String | |String | ||
|Descrição do assunto do e-mail. | |Descrição do assunto do e-mail. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
|ExibirTelaEnvio | |ExibirTelaEnvio | ||
Linha 46: | Linha 37: | ||
|MostrarProcesso | |MostrarProcesso | ||
|Boolean | |Boolean | ||
− | |Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando. | + | |Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando '''(Obsoleta)'''. |
+ | |- | ||
+ | |ServidorSMTP | ||
+ | |Integer | ||
+ | |Quando informado o ID do Servidor de SMTP, o e-mail será enviado por este servidor ao invés do servidor SMTP do usuário. | ||
+ | | | ||
+ | |- | ||
+ | |CampoLigacao | ||
+ | |String | ||
+ | |Campo de ligação com outra tabela. Exemplo: DOCUMENTO, quando o e-mail estiver relacionado a um documento. | ||
+ | | | ||
+ | |- | ||
+ | |DocumentoID | ||
+ | |Int64 | ||
+ | |ID correspondente ao registro de ligação quando informada a propriedade CampoLigacao. | ||
|} | |} | ||
===Procedimentos=== | ===Procedimentos=== | ||
− | + | *'''SetCorpo(Corpo:String):''' Determina o texto utilizado no corpo do e-mail. | |
+ | *'''SetCorpoHTML(Corpo:String):''' Determina o texto em formato HTML utilizado no corpo do e-mail. | ||
+ | *'''AddCorpo(Texto:String):''' Adicionar um texto em uma nova linha no corpo do e-mail. | ||
+ | *'''AddCorpoHTML(Texto:String):''' Adicionar um texto em formato HTML em uma nova linha no corpo HTML do e-mail. | ||
+ | *'''AdicionarAnexo(Anexo:String):''' Informar o caminho do arquivo que será anexado no envio do e-mail. | ||
+ | *'''Enviar:''' Realiza o envio do e-mail. | ||
+ | *'''AgendarEnvio:''' Realiza o cadastro do e-mail junto ao cadastro de e-mails do sistema (DB_EMAIL). Nesse caso o envio vai ocorrer conforme determinado no agendamento de envio de e-mails. | ||
+ | *'''AddStream(vStream:TStream; vDescricao:String):''' Adicionar os anexos do e-mail pela stream informada no parâmetro. | ||
===Exemplo=== | ===Exemplo=== | ||
Linha 61: | Linha 73: | ||
try | try | ||
PHEmail.AssuntoStr := 'Assunto Teste'; | PHEmail.AssuntoStr := 'Assunto Teste'; | ||
− | |||
PHEmail.Para := 'email@exemplo.com.br'; | PHEmail.Para := 'email@exemplo.com.br'; | ||
PHEmail.SetCorpo('Corpo do e-mail'); | PHEmail.SetCorpo('Corpo do e-mail'); |
Edição atual tal como às 11h20min de 12 de março de 2024
O objeto TPHEmail pode ser utilizado para realizar o envio de e-mail por meio de script.
Propriedades
Nome | Tipo | Descrição | |
---|---|---|---|
De | String | E-mail do responsável pelo envio. | |
Para | String | E-Mail do destinatário. Pode-se utilizar mais de uma e-mail utilizando a separação por ';'. | |
CC | String | E-Mail de destinatário de cópia. Pode-se utilizar mais de uma e-mail utilizando a separação por ';'. | |
CCO | String | E-Mail de destinatário de cópia oculta. Pode-se utilizar mais de uma e-mail utilizando a separação por ';'. | |
AssuntoStr | String | Descrição do assunto do e-mail. | |
ExibirTelaEnvio | Boolean | Quando enviar, será exibida tela de envio de e-mail. | |
Confirmado | Boolean | Quando a propriedade 'ExibirTelaEnvio' estiver marcada, esta propriedade vai retornar verdadeira se o usuário confirmar o envio. | |
MostrarProcesso | Boolean | Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando (Obsoleta). | |
ServidorSMTP | Integer | Quando informado o ID do Servidor de SMTP, o e-mail será enviado por este servidor ao invés do servidor SMTP do usuário. | |
CampoLigacao | String | Campo de ligação com outra tabela. Exemplo: DOCUMENTO, quando o e-mail estiver relacionado a um documento. | |
DocumentoID | Int64 | ID correspondente ao registro de ligação quando informada a propriedade CampoLigacao. |
Procedimentos
- SetCorpo(Corpo:String): Determina o texto utilizado no corpo do e-mail.
- SetCorpoHTML(Corpo:String): Determina o texto em formato HTML utilizado no corpo do e-mail.
- AddCorpo(Texto:String): Adicionar um texto em uma nova linha no corpo do e-mail.
- AddCorpoHTML(Texto:String): Adicionar um texto em formato HTML em uma nova linha no corpo HTML do e-mail.
- AdicionarAnexo(Anexo:String): Informar o caminho do arquivo que será anexado no envio do e-mail.
- Enviar: Realiza o envio do e-mail.
- AgendarEnvio: Realiza o cadastro do e-mail junto ao cadastro de e-mails do sistema (DB_EMAIL). Nesse caso o envio vai ocorrer conforme determinado no agendamento de envio de e-mails.
- AddStream(vStream:TStream; vDescricao:String): Adicionar os anexos do e-mail pela stream informada no parâmetro.
Exemplo
procedure EnviarEmail; var PHEmail:TPHEmail; begin PHEmail := NewPHEmail; try PHEmail.AssuntoStr := 'Assunto Teste'; PHEmail.Para := 'email@exemplo.com.br'; PHEmail.SetCorpo('Corpo do e-mail'); PHEmail.AdicionarAnexo('C:\TempAnexo.txt'); PHEmail.Enviar; finally PHEmail.Free; end; end;