routes

Documentation

Index

• func AliasesDeleteHandler(c *gin.Context)
• func AliasesGetHandler(c *gin.Context)
• func AliasesPostHandler(c *gin.Context)
• func EmailsGetHandler(c *gin.Context)
• func StatusGetHandler(c *gin.Context)
• type DockerClient

Functions

func AliasesDeleteHandler

func AliasesDeleteHandler(c *gin.Context)

AliasesDeleteHandler godoc

@Summary	Delete an email alias
@Schemes
@Description	Deletes an email alias from the Docker Mailserver container
@Tags			Aliases
@Accept			json
@Produce		json
@Success		204
@Failure		500		{object}	models.ErrorResponse
@Failure		400		{object}	models.ErrorResponse
@Failure		404		{object}	models.ErrorResponse
@Param			alias	path		string	true	"Alias to delete"
@Router			/v1/aliases/{alias} [delete]

func AliasesGetHandler

func AliasesGetHandler(c *gin.Context)

AliasesGetHandler godoc

@Summary	List of all available email aliases
@Schemes
@Description	Gets a list of all available email aliases from the Docker Mailserver container
@Tags			Aliases
@Accept			json
@Produce		json
@Success		200	{object}	models.AliasListResponse
@Failure		500	{object}	models.ErrorResponse
@Router			/v1/aliases [get]

func AliasesPostHandler

func AliasesPostHandler(c *gin.Context)

AliasesPostHandler godoc

@Summary	Add a new email alias
@Schemes
@Description	Adds a new email alias to the Docker Mailserver container
@Tags			Aliases
@Accept			json
@Produce		json
@Param			alias	body		models.AliasResponse	true	"Alias to add"
@Success		201		{object}	models.AliasResponse
@Failure		500		{object}	models.ErrorResponse
@Failure		400		{object}	models.ErrorResponse
@Router			/v1/aliases [post]

func EmailsGetHandler

func EmailsGetHandler(c *gin.Context)

EmailsGetHandler godoc

@Summary	List of all available email addresses
@Schemes
@Description	Gets a list of all available email addresses from the Docker Mailserver container
@Tags			E-Mails
@Accept			json
@Produce		json
@Success		200	{object}	models.EmailListResponse
@Failure		500	{object}	models.ErrorResponse
@Router			/v1/emails [get]

func StatusGetHandler

func StatusGetHandler(c *gin.Context)

StatusGetHandler godoc

@Summary	Checks Mailserver Docker container
@Schemes
@Description	Checks if the Docker Mailserver Docker container is running
@Tags			Utility
@Accept			json
@Produce		json
@Success		200	{object}	models.StatusResponse
@Failure		500	{object}	models.ErrorResponse
@Router			/v1/status [get]

Types

type DockerClient

type DockerClient interface {
	ContainerList(ctx context.Context, options container.ListOptions) ([]types.Container, error)
	ContainerExecCreate(ctx context.Context, container string, config container.ExecOptions) (types.IDResponse, error)
	ContainerExecAttach(ctx context.Context, execID string, config container.ExecAttachOptions) (types.HijackedResponse, error)
	Close() error
}