The sendgrid Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The sendgrid Reference Manual

This is the sendgrid Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 12:44:50 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Send emails with the SendGrid API

https://sendgrid.com/

On Ultralisp.

Create an account an set these variables:

(setf *email-config*
  '(:|api-key| "your private api key"
    :|from| "the default 'from' address."))

Send an email with send-email:

(sendgrid:send-email &key to
                          (from (getf *email-config* :|from|))
                          subject
                          content
                          (verbose *verbose*))

;; #()
;; 202
;; #<HASH-TABLE :TEST EQUAL :COUNT 10 {10079655A3}>
;; #<QURI.URI.HTTP:URI-HTTPS https://api.sendgrid.com/v3/mail/send>
;; #<CL+SSL::SSL-STREAM for #<FD-STREAM for "socket 192.168.1.11:36670, peer: 159.122.xxx.yyy:443" {1007880183}>>

It takes the time of a POST request.

TODO:

See also

Licence

MIT.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 sendgrid

Author

vindarel

License

MIT

Description

Wrapper to SendGrid’s API.

Version

0.1

Dependencies
Source

sendgrid.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 sendgrid/src

Parent

sendgrid (system)

Location

src/

Component

sendgrid.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 sendgrid.asd

Location

sendgrid.asd

Systems

sendgrid (system)


Previous: , Up: Lisp files   [Contents][Index]

4.1.2 sendgrid/src/sendgrid.lisp

Parent

src (module)

Location

src/sendgrid.lisp

Packages

sendgrid

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 sendgrid

Source

sendgrid.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *email-config*
Package

sendgrid

Source

sendgrid.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: send-email &key TO FROM SUBJECT CONTENT VERBOSE

Send an email with SendGrid’s API.
‘from’: from the ‘*email-config*’ by default. todo: make ‘to’ accept multiple addresses.

Package

sendgrid

Source

sendgrid.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *sendgrid-api*
Package

sendgrid

Source

sendgrid.lisp (file)

Special Variable: *verbose*
Package

sendgrid

Source

sendgrid.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: sendgrid-json &key TO FROM SUBJECT CONTENT
Package

sendgrid

Source

sendgrid.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

F
File, Lisp, sendgrid.asd: The sendgrid․asd file
File, Lisp, sendgrid/src/sendgrid.lisp: The sendgrid/src/sendgrid․lisp file

L
Lisp File, sendgrid.asd: The sendgrid․asd file
Lisp File, sendgrid/src/sendgrid.lisp: The sendgrid/src/sendgrid․lisp file

M
Module, sendgrid/src: The sendgrid/src module

S
sendgrid.asd: The sendgrid․asd file
sendgrid/src: The sendgrid/src module
sendgrid/src/sendgrid.lisp: The sendgrid/src/sendgrid․lisp file

Jump to:   F   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   S  
Index Entry  Section

F
Function, send-email: Exported functions
Function, sendgrid-json: Internal functions

S
send-email: Exported functions
sendgrid-json: Internal functions

Jump to:   F   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*email-config*: Exported special variables
*sendgrid-api*: Internal special variables
*verbose*: Internal special variables

S
Special Variable, *email-config*: Exported special variables
Special Variable, *sendgrid-api*: Internal special variables
Special Variable, *verbose*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, sendgrid: The sendgrid package

S
sendgrid: The sendgrid system
sendgrid: The sendgrid package
System, sendgrid: The sendgrid system

Jump to:   P   S