CFConfig Documentation
  • Introduction
  • The Basics
    • About This Book
    • Authors
    • Overview
    • Getting Started Guide
    • Supported Engines
    • Config Items
  • Using the CLI
    • Installation
    • Usage
    • CommandBox Server Interceptors
      • Server Start
      • Server Stop
    • Command Overview
      • Export Settings
      • Import Settings
      • Transfer Settings
      • Diff Settings
      • Set/View Settings
      • Manage Datasources
      • Manage CF Mappings
      • Manage Caches
      • Manage Mail Servers
      • Manage Event Gateway Configuration
      • Manage Event Gateway Instances
      • Manage Lucee Loggers
      • Manage Scheduled Tasks
    • JSON File Storage
    • Env Var Overrides
  • Using the Services
    • Installation
    • Component Overview
    • API Overview
Powered by GitBook
On this page
  • List existing mail servers
  • Edit an existing or create a new mail server
  • Delete an existing mail server

Was this helpful?

Edit on GitHub
Export as PDF
  1. Using the CLI
  2. Command Overview

Manage Mail Servers

There are three commands to manage Mail Servers.

List existing mail servers

cfconfig mailserver list
cfconfig mailserver list from=serverName
cfconfig mailserver list from==/path/to/server/home

To receive the data back as JSON, use the --JSON flag.

cfconfig mailserver list --JSON

Edit an existing or create a new mail server

Add a new mail server or update an existing mail server. Existing mail servers will be matched based on the host name.

cfconfig mailserver save smtp.server.com
cfconfig mailserver save smtp=smtp.server.com to=serverName
cfconfig mailserver save smtp=smtp.server.com to=/path/to/server/home

Delete an existing mail server

Identify the mail server uniquely by the host name.

cfconfig mailserver delete /foo
cfconfig mailserver delete /foo serverName
cfconfig mailserver delete /foo /path/to/server/home
PreviousManage CachesNextManage Event Gateway Configuration

Last updated 4 years ago

Was this helpful?