smtp

README

SMTP service

• Usage
• Endly service actions
• Handling errors

Usage

endly -r=send

send.yaml

init:
defaults:
  target:
    URL: smtp://smtp.gmail.com:465
    credentials: smtp
  sender: viantemailtester@gmail.com

pipeline:
  send:
    action: smtp:send
    udf: Markdown
    mail:
      to:
      - awitas@viantinc.com
      from: $sender
      subject: Endly test
      contentType: text/html
      body:  "# test message\n
              * list item 1\n
              * list item 2"

Endly service actions

Run the following command for smtp service operation details:

endly -s=smtp 
endly -s=smtp -a=send

SMTP Service

Service Id	Action	Description	Request	Response
smtp	send	send an email to supplied recipients	SendRequest	SendResponse

RunRequest example

@run.json

{
  "Target": {
    "URL": "ssh://127.0.0.1/",
    "Credentials": "${env.HOME}/.secret/localhost.json"
  },
  "SuperUser":true,
  "Commands":["mkdir /tmp/app1"]
}

init:
defaults:
  target:
    URL: smtp://smtp.gmail.com:465
    credentials: smtp
  sender: viantemailtester@gmail.com

pipeline:
  send:
    action: smtp:send
    udf: Markdown
    mail:
      to:
      - awitas@viantinc.com
      from: $sender
      subject: Endly test
      contentType: text/html
      body:  "# test message\n
              * list item 1\n
              * list item 2"

Handling errors

@run.yaml

init:
  - "body = Error: <strong>$error.Error at:</strong>
    $error.TaskName:
    <br />
    <code>
    $errorJSON
    </code>"
defaults:
  target:
    URL: smtp://smtp.gmail.com:465
    credentials: smtp
  sender: viantemailtester@gmail.com

pipeline:

  task1:
    action: fail
    message: test failure

  catch:
    action: smtp:send
    mail:
      to:
      - awitas@viantinc.com
      from: $sender
      subject: Endly test $error.Error
      contentType: text/html
      body: $body
  defer:
    action: print
    message: all done

Documentation

Index

• Constants
• func New() endly.Service
• func NewClient(target *location.Resource, credConfig *cred.Generic) (*smtp.Client, error)
• type Message
  • func (m *Message) Payload() []byte
  • func (m *Message) Receivers() []string
  • func (m *Message) Validate() error
• type SendRequest
  • func (r *SendRequest) Validate() error
• type SendResponse

Constants

const (
	//ServiceID represents smtp service id.
	ServiceID = "smtp"
)

Functions

func New

func New() endly.Service

New creates a new NoOperation service.

func NewClient

func NewClient(target *location.Resource, credConfig *cred.Generic) (*smtp.Client, error)

NewClient creates a new SMTP client.

Types

type Message

type Message struct {
	From        string `required:"true" description:"sender, has to match email from target.credentials"`
	To          []string
	Cc          []string
	Bcc         []string
	Subject     string
	Body        string
	ContentType string
}

Message represent an email

func (*Message) Payload

func (m *Message) Payload() []byte

Payload returns mail payload.

func (*Message) Receivers

func (m *Message) Receivers() []string

Receivers returns all receivers for this email message

func (*Message) Validate

func (m *Message) Validate() error

Validate checks if mail message is valid

type SendRequest

type SendRequest struct {
	Target *location.Resource `required:"true" description:"SMTP endpoint"`
	Mail   *Message           `required:"true"`
	UDF    string             `description:"body UDF"`
}

SendRequest represents send request.

func (*SendRequest) Validate

func (r *SendRequest) Validate() error

Validate validates send request.

type SendResponse

type SendResponse struct {
	SendPayloadSize int
}

SendResponse represents send response.