MailAttachment
Los objetos adjuntos permiten referenciar archivos en un objeto Email. Los objetos Attachment (adjuntos) son creados utilizando el comando MAIL New attachment.
Objetos adjuntos
Los objetos Attachment ofrecen las siguientes propiedades y funciones de sólo lectura:
| .cid : Text el ID del archivo adjunto |
.disposition : Text el valor del encabezado Content-Disposition |
| .getContent(): Blob devuelve el contenido del objeto adjunto en un BLOB |
| .name : Text el nombre y la extensión del archivo adjunto |
| .path : Text la ruta POSIX del archivo adjunto, si existe |
.platformPath : Text The .platformPath property returns |
.type : Text el content-type del archivo adjunto |
MAIL New attachment
MAIL New attachment( path : Text { ; name : Text {; cid : Text{ ; type : Text { ; disposition :Text } } } } ) : 4D.MailAttachment
MAIL New attachment( blob : Blob { ; name : Text {; cid : Text{ ; type : Text { ; disposition :Text } } } } ) : 4D.MailAttachment
| Parámetros | Tipo | Descripción | |
|---|---|---|---|
| path | Text | -> | Ruta del archivo adjunto |
| blob | Blob | -> | BLOB que contiene el adjunto |
| name | Text | -> | Nombre + extensión utilizados por el cliente de correo para designar el archivo adjunto |
| cid | Text | -> | ID del archivo adjunto (sólo en mensajes HTML), o " " si no se requiere cid |
| type | Text | -> | Valor del encabezado content-type |
| disposition | Text | -> | Valor del encabezado content-disposition: "inline" o "attachment". |
| Result | 4D.MailAttachment | <- | Objeto adjunto |
Descripción
El comando MAIL New attachment le permite crear un objeto adjunto que puede añadir a un objeto correo electrónico.
Puede pasar una ruta o un Blob para definir el archivo adjunto.
-
Si utiliza un ruta, pase un valor texto que contenga la ruta del archivo adjunto, expresada con la sintaxis del sistema. Puede pasar un nombre de ruta completo o un simple nombre de archivo (en cuyo caso 4D buscará el archivo en el mismo directorio que el archivo del proyecto).
-
Si utiliza un blob, pase un valor BLOB que contenga el propio archivo adjunto.
El parámetro opcional name permite pasar el nombre y la extensión que utilizará el cliente de correo para designar el archivo adjunto. Si se omite name y:
- pasó una ruta de archivo, se utiliza el nombre y la extensión del archivo,
- pasó un BLOB, se genera automáticamente un nombre aleatorio sin extensión.
El parámetro opcional cid permite pasar un ID interno para el archivo adjunto. Este ID es el valor del encabezado Content-Id, se utilizará sólo en mensajes HTML. El cid asocia el archivo adjunto a una referencia definida en el cuerpo del mensaje mediante una etiqueta HTML como \N<img src="cid:ID">. Esto significa que el contenido del archivo adjunto (por ejemplo, una imagen) debe mostrarse dentro del mensaje en el cliente de correo. El resultado final puede variar en función del cliente de correo. Puede pasar una cadena vacía en cid si no quiere utilizar este parámetro.
Puede utilizar el parámetro opcional type para definir explícitamente el content-type del archivo adjunto. Por ejemplo, puede pasar una cadena que defina un tipo MIME ("video/mpeg"). Este valor de content-type se definirá para el archivo adjunto, independientemente de su extensión. Para más información sobre los tipos MIME, consulte la página Tipo MIME en Wikipedia.
Por defecto, si el parámetro type se omite o contiene una cadena vacía, el content-type del archivo adjunto se basa en su extensión. Se aplican las siguientes reglas para los principales tipos MIME:
| Extensión | Content Type |
|---|---|
| jpg, jpeg | image/jpeg |
| png | image/png |
| gif | image/gif |
| application/pdf | |
| doc | application/msword |
| xls | application/vnd.ms-excel |
| ppt | application/vnd.ms-powerpoint |
| zip | application/zip |
| gz | application/gzip |
| json | application/json |
| js | application/javascript |
| ps | application/postscript |
| xml | application/xml |
| htm, html | text/html |
| mp3 | audio/mpeg |
| otro | application/octet-stream |
El parámetro opcional disposition permite pasar el encabezado content-disposition del adjunto. Puede pasar una de las siguientes constantes del tema constante "Mail":
| Constante | Valor | Comentario |
|---|---|---|
| mail disposition attachment | "attachment" | Define el valor del encabezado Content-disposition como "attachment", lo que significa que el archivo adjunto debe proporcionarse como un enlace en el mensaje. |
| mail disposition inline | "inline" | Define el valor del encabezado Content-disposition como "inline", lo que significa que el archivo adjunto debe aparecer dentro del contenido del mensaje, en la ubicación "cid". La renderización depende del cliente de correo. |
Por defecto, si se omite el parámetro disposition:
- si el parámetro cid se utiliza, el encabezado
Content-dispositiones definido como "inline", - si el parámetro cid no se pasa o está vacío, el encabezado
Content-dispositiones definido como "attachment".
Ejemplo 1
Desea enviar un correo electrónico con un archivo seleccionado por el usuario como adjunto y una imagen integrada en el cuerpo HTML:
$doc:=Select document("";"*";"Please select a file to attach";0)
If (OK=1) //Si se ha seleccionado un documento
C_OBJECT($email;$server;$transporter)
$server:=New object
$server.host:="smtp.mail.com"
$server.user:="test_user@mail.com"
$server.password:="p@ssw@rd"
$transporter:=SMTP New transporter($server)
$email:=New object
$email.from:="test_user@mail.com"
$email.to:="test_user@mail.com"
$email.subject:="This is a test message with attachments"
//añadir un enlace para descargar el archivo
$email.attachments:=New collection(MAIL New attachment(Document))
//insertar una imagen en línea (utilice un cid)
$email.attachments[1]:=MAIL New attachment("c:\\Pictures\\4D.jpg";"";"4D")
$email.htmlBody:="<html>"+\
"<body>Hello World!"+\
"<img src='cid:4D' >"+\
"</body>"+\
"</head>"+\
"</html>"
$transporter.send($email) //enviar mail
End if
Ejemplo 2
Desea enviar un correo electrónico con un área 4D Write Pro como archivo adjunto:
C_BLOB($blob)
WP EXPORT VARIABLE(WPArea;$blob;wk docx)
C_OBJECT($email;$server;$transporter)
$server:=New object
$server.host:="smtp.mail.com"
$server.user:="user@mail.com"
$server.password:="p@ssw@rd"
$transporter:=SMTP New transporter($server)
$email:=New object
$email.from:="user@mail.com"
$email.to:="customer@mail.com"
$email.subject:="New annual report"
$email.textBody:="Please find enclosed our latest annual report."
$email.attachments:=New collection(MAIL New attachment($blob;"Annual report.docx"))
$transporter.send($email)
4D.MailAttachment.new()
4D.MailAttachment.new( path : Text { ; name : Text {; cid : Text{ ; type : Text { ; disposition :Text } } } } ) : 4D.MailAttachment
4D.MailAttachment.new( blob : Blob { ; name : Text {; cid : Text{ ; type : Text { ; disposition :Text } } } } ) : 4D.MailAttachment
| Parámetros | Tipo | Descripción | |
|---|---|---|---|
| path | Text | -> | Ruta del archivo adjunto |
| blob | Blob | -> | BLOB que contiene el adjunto |
| name | Text | -> | Nombre + extensión utilizados por el cliente de correo para designar el archivo adjunto |
| cid | Text | -> | ID del archivo adjunto (sólo en mensajes HTML), o " " si no se requiere cid |
| type | Text | -> | Valor del encabezado content-type |
| disposition | Text | -> | Valor del encabezado content-disposition: "inline" o "attachment". |
| Result | 4D.MailAttachment | <- | Objeto adjunto |
Descripción
La función 4D.MailAttachment.new() crea y devuelve un nuevo objeto del tipo 4D.MailAttachment. La propiedad .type contiene el content-type del archivo adjunto.
.cid**.cid** : Text#### Descripción
.
Descripción
La propiedad .cid contiene el ID del archivo adjunto. Esta propiedad se utiliza sólo en los mensajes HTML. Si falta esta propiedad, el archivo se maneja como un simple adjunto (enlace).
.disposition**.disposition** : Text#### Descripción
.disposition : Text
Descripción
La propiedad .disposition contiene el valor del encabezado Content-Disposition. Hay dos valores disponibles:
- "inline": el archivo adjunto se muestra dentro del contenido del mensaje, en la ubicación "cid". La renderización depende del cliente de correo.
- "attachment": el archivo adjunto se presenta como un enlace en el mensaje.
.getContent()
.getContent(): Blob
| Parámetros | Tipo | Descripción | |
|---|---|---|---|
| Result | Blob | <- | Contenido del anexo |
Descripción
La función .getContent() devuelve el contenido del objeto adjunto en un BLOB. Puede utilizar esta función con los objetos adjuntos recibidos por el comando MAIL Convert from MIME.
.name
.name : Text
Descripción
La propiedad .name contiene el nombre y la extensión del archivo adjunto. Por defecto, es el nombre del archivo, a menos que se haya indicado otro nombre en el comando MAIL New attachment.
.path
.path : Text
Descripción
La propiedad .path contiene la ruta POSIX del archivo adjunto, si existe.
.platformPath
Histórico
| Lanzamiento | Modificaciones |
|---|---|
| 19 | Añadidos |
.platformPath : Text
Descripción
La propiedad .platformPath devuelve The .platformPath property returns.
.type
.type : Text
Descripción
La propiedad .type contiene el content-type del archivo adjunto. Si este tipo no se pasa explícitamente al comando MAIL New attachment, el content-type se basa en su extensión de archivo.