ByteChef LogoByteChef
Components

Email

The Email connector sends emails using an SMTP email server.

Categories: Communication, Helpers

Type: email/v1


Connections

Version: 1

Basic Auth

Properties

NameLabelTypeDescriptionRequired
usernameUsernameSTRINGtrue
passwordPasswordSTRINGtrue

Actions

Send

Name: send

Send an email to any address.

Properties

NameLabelTypeDescriptionRequired
portPortINTEGERDefines the port to connect to the email server.true
fromFrom EmailSTRINGFrom who to send the email.true
toTo EmailARRAY
Items [STRING]
Who to send the email to.true
ccCC EmailARRAY
Items [STRING]
Who to CC on the email.false
bccBCC EmailARRAY
Items [STRING]
Who to BCC on the email.false
replyToReply ToARRAY
Items [STRING]
When someone replies to this email, where should it go to?false
subjectSubjectSTRINGYour email subject.true
contentContentSTRINGYour email content. Will be sent as a HTML email.false
attachmentsAttachmentsARRAY
Items [FILE_ENTRY]
A list of attachments to send with the email.false

Example JSON Structure

{
  "label" : "Send",
  "name" : "send",
  "parameters" : {
    "port" : 1,
    "from" : "",
    "to" : [ "" ],
    "cc" : [ "" ],
    "bcc" : [ "" ],
    "replyTo" : [ "" ],
    "subject" : "",
    "content" : "",
    "attachments" : [ {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    } ]
  },
  "type" : "email/v1/send"
}

Output

This action does not produce any output.

Get Mail

Name: get

Get emails from inbox.

Properties

NameLabelTypeDescriptionRequired
portPortINTEGERDefines the port to connect to the email server.true
protocolProtocolSTRING
Options imap, pop3
Protocol defines communication procedure. IMAP allows receiving emails. POP3 is older protocol for receiving emails.true
fromFrom EmailSTRINGFrom who the email was sent.true
subjectSubject containsSTRINGFilters email messages where subject contains this keyword. Character matching is case insensitive.true

Example JSON Structure

{
  "label" : "Get Mail",
  "name" : "get",
  "parameters" : {
    "port" : 1,
    "protocol" : "",
    "from" : "",
    "subject" : ""
  },
  "type" : "email/v1/get"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
ccSTRING
contentSTRING
contentTypeSTRING
fromSTRING
hasAttachmentsBOOLEAN
Options true, false
subjectSTRING

Output Example

[ {
  "cc" : "",
  "content" : "",
  "contentType" : "",
  "from" : "",
  "hasAttachments" : false,
  "subject" : ""
} ]